Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Removed static things. #3

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions .editorconfig

This file was deleted.

1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*.cs diff=csharp
2 changes: 1 addition & 1 deletion .github/workflows/dotnet.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
- name: Setup .NET
uses: actions/setup-dotnet@v1
with:
dotnet-version: 6.x
dotnet-version: 8.x
- name: Restore dependencies
run: dotnet restore
- name: Build
Expand Down
7 changes: 0 additions & 7 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
{
"dotnet.defaultSolution": "Promptuarium.sln",
"omnisharp.enableEditorConfigSupport": true,
"cSpell.words": [
"datetime",
"LINQ",
"Promptuarium",
"roslynator"
]
}
6 changes: 4 additions & 2 deletions docs/Promptuarium/Data/AsElementAsync/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Data\.AsElementAsync\(Stream\) Method
# Data\.AsElementAsync\(Stream, Element\) Method

[Home](../../../README.md)

Expand All @@ -10,7 +10,7 @@
Converts a stream to a tree\.

```csharp
public static System.Threading.Tasks.Task<Promptuarium.Element> AsElementAsync(this System.IO.Stream stream)
public static System.Threading.Tasks.Task<Promptuarium.Element> AsElementAsync(this System.IO.Stream stream, Promptuarium.Element loaderElement = null)
```

### Parameters
Expand All @@ -19,6 +19,8 @@ public static System.Threading.Tasks.Task<Promptuarium.Element> AsElementAsync(t

The source stream

**loaderElement** &ensp; [Element](../../Element/README.md)

### Returns

[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task-1)\<[Element](../../Element/README.md)\>
Expand Down
2 changes: 1 addition & 1 deletion docs/Promptuarium/Data/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ public static class Data
| [AsDateTimeOffset(Stream)](AsDateTimeOffset/README.md) | Converts a stream to a DateTimeOffset value\. |
| [AsDecimal(Stream)](AsDecimal/README.md) | Converts a stream to a decimal value\. |
| [AsDouble(Stream)](AsDouble/README.md) | Converts a stream to a double value\. |
| [AsElementAsync(Stream)](AsElementAsync/README.md) | Converts a stream to a tree\. |
| [AsElementAsync(Stream, Element)](AsElementAsync/README.md) | Converts a stream to a tree\. |
| [AsFloat(Stream)](AsFloat/README.md) | Converts a stream to a float value\. |
| [AsGuid(Stream)](AsGuid/README.md) | Converts a stream to a GUID value\. |
| [AsInt(Stream)](AsInt/README.md) | Converts a stream to an int value\. |
Expand Down
48 changes: 5 additions & 43 deletions docs/Promptuarium/Element/FromBase64StringAsync/README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,16 @@
# Element\.FromBase64StringAsync Method
# Element\.FromBase64StringAsync\(String, Element, CancellationToken\) Method

[Home](../../../README.md)

**Containing Type**: [Element](../README.md)

**Assembly**: Promptuarium\.dll

## Overloads

| Method | Summary |
| ------ | ------- |
| [FromBase64StringAsync(String, CancellationToken)](#142880008) | Creates a tree from a Base64 string\. |
| [FromBase64StringAsync(String)](#3836437132) | Creates a tree from a Base64 string\. |

<a id="142880008"></a>

## FromBase64StringAsync\(String, CancellationToken\)


Creates a tree from a Base64 string\.

```csharp
public static System.Threading.Tasks.Task<Promptuarium.Element> FromBase64StringAsync(string base64String, System.Threading.CancellationToken cancellationToken)
public static System.Threading.Tasks.Task<Promptuarium.Element> FromBase64StringAsync(string base64String, Promptuarium.Element loaderElement = null, System.Threading.CancellationToken cancellationToken = default)
```

### Parameters
Expand All @@ -30,6 +19,8 @@ public static System.Threading.Tasks.Task<Promptuarium.Element> FromBase64String

The tree in Base64\.

**loaderElement** &ensp; [Element](../README.md)

**cancellationToken** &ensp; [CancellationToken](https://docs.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken)

The cancellation token\.
Expand All @@ -40,36 +31,7 @@ The cancellation token\.

The tree\.

### Examples

```
var tree = await Element.FromBase64StringAsync(base64String);
```

<a id="3836437132"></a>

## FromBase64StringAsync\(String\)


Creates a tree from a Base64 string\.

```csharp
public static System.Threading.Tasks.Task<Promptuarium.Element> FromBase64StringAsync(string base64String)
```

### Parameters

**base64String** &ensp; [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)

The tree in Base64\.

### Returns

[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task-1)\<[Element](../README.md)\>

The tree\.

### Examples
## Examples

```
var tree = await Element.FromBase64StringAsync(base64String);
Expand Down
8 changes: 4 additions & 4 deletions docs/Promptuarium/Element/LoadAsync/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
Loads a tree from a stream\.

```csharp
public static System.Threading.Tasks.Task<Promptuarium.Element> LoadAsync(System.IO.Stream stream, System.Threading.CancellationToken cancellationToken)
public System.Threading.Tasks.Task<Promptuarium.Element> LoadAsync(System.IO.Stream stream, System.Threading.CancellationToken cancellationToken)
```

### Parameters
Expand Down Expand Up @@ -63,7 +63,7 @@ var tree = await Element.LoadAsync(stream, cancellationToken);
Loads a tree from a stream\.

```csharp
public static System.Threading.Tasks.Task<Promptuarium.Element> LoadAsync(System.IO.Stream stream)
public System.Threading.Tasks.Task<Promptuarium.Element> LoadAsync(System.IO.Stream stream)
```

### Parameters
Expand Down Expand Up @@ -99,7 +99,7 @@ var tree = await Element.LoadAsync(stream);
Loads a tree from a file\.

```csharp
public static System.Threading.Tasks.Task<Promptuarium.Element> LoadAsync(string fileName, System.Threading.CancellationToken cancellationToken)
public System.Threading.Tasks.Task<Promptuarium.Element> LoadAsync(string fileName, System.Threading.CancellationToken cancellationToken)
```

### Parameters
Expand Down Expand Up @@ -138,7 +138,7 @@ var tree = await Element.LoadAsync("test.prm", cancellationToken);
Loads a tree from a file\.

```csharp
public static System.Threading.Tasks.Task<Promptuarium.Element> LoadAsync(string fileName)
public System.Threading.Tasks.Task<Promptuarium.Element> LoadAsync(string fileName)
```

### Parameters
Expand Down
2 changes: 1 addition & 1 deletion docs/Promptuarium/Element/OnDataLoaded/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@
Event handler for all Promptuarium data loaded events

```csharp
public static event EventHandler<Promptuarium.PromptuariumLoadedEventArgs>? OnDataLoaded
public event EventHandler<Promptuarium.PromptuariumLoadedEventArgs>? OnDataLoaded
```

2 changes: 1 addition & 1 deletion docs/Promptuarium/Element/OnDataLoading/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@
Event handler for all Promptuarium data loading events

```csharp
public static event EventHandler<Promptuarium.PromptuariumLoadingEventArgs>? OnDataLoading
public event EventHandler<Promptuarium.PromptuariumLoadingEventArgs>? OnDataLoading
```

2 changes: 1 addition & 1 deletion docs/Promptuarium/Element/OnMetaDataLoaded/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@
Event handler for all Promptuarium metadata loaded events

```csharp
public static event EventHandler<Promptuarium.PromptuariumLoadedEventArgs>? OnMetaDataLoaded
public event EventHandler<Promptuarium.PromptuariumLoadedEventArgs>? OnMetaDataLoaded
```

2 changes: 1 addition & 1 deletion docs/Promptuarium/Element/OnMetaDataLoading/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@
Event handler for all Promptuarium metadata loading events

```csharp
public static event EventHandler<Promptuarium.PromptuariumLoadingEventArgs>? OnMetaDataLoading
public event EventHandler<Promptuarium.PromptuariumLoadingEventArgs>? OnMetaDataLoading
```

3 changes: 1 addition & 2 deletions docs/Promptuarium/Element/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,7 @@ public class Element : System.Collections.Generic.IEnumerable<Promptuarium.Eleme
| [Detach()](Detach/README.md#2614073258) | Detaches a subtree or node\. |
| [Detach(Element)](Detach/README.md#119873975) | Detaches a subtree or node\. |
| [Equals(Object)](https://docs.microsoft.com/en-us/dotnet/api/system.object.equals) | \(Inherited from [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object)\) |
| [FromBase64StringAsync(String, CancellationToken)](FromBase64StringAsync/README.md#142880008) | Creates a tree from a Base64 string\. |
| [FromBase64StringAsync(String)](FromBase64StringAsync/README.md#3836437132) | Creates a tree from a Base64 string\. |
| [FromBase64StringAsync(String, Element, CancellationToken)](FromBase64StringAsync/README.md) | Creates a tree from a Base64 string\. |
| [GetEnumerator()](GetEnumerator/README.md) | Returns an enumerator that iterates through the Children \(Implements [IEnumerable\<Element\>.GetEnumerator](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1.getenumerator)\) |
| [GetHashCode()](https://docs.microsoft.com/en-us/dotnet/api/system.object.gethashcode) | \(Inherited from [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object)\) |
| [GetStatistics()](GetStatistics/README.md) | Gets the statistics about the tree |
Expand Down
2 changes: 1 addition & 1 deletion docs/System/IO/Stream/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
| [AsDateTimeOffset(Stream)](../../../Promptuarium/Data/AsDateTimeOffset/README.md) | Converts a stream to a DateTimeOffset value\. |
| [AsDecimal(Stream)](../../../Promptuarium/Data/AsDecimal/README.md) | Converts a stream to a decimal value\. |
| [AsDouble(Stream)](../../../Promptuarium/Data/AsDouble/README.md) | Converts a stream to a double value\. |
| [AsElementAsync(Stream)](../../../Promptuarium/Data/AsElementAsync/README.md) | Converts a stream to a tree\. |
| [AsElementAsync(Stream, Element)](../../../Promptuarium/Data/AsElementAsync/README.md) | Converts a stream to a tree\. |
| [AsFloat(Stream)](../../../Promptuarium/Data/AsFloat/README.md) | Converts a stream to a float value\. |
| [AsGuid(Stream)](../../../Promptuarium/Data/AsGuid/README.md) | Converts a stream to a GUID value\. |
| [AsInt(Stream)](../../../Promptuarium/Data/AsInt/README.md) | Converts a stream to an int value\. |
Expand Down
9 changes: 5 additions & 4 deletions src/Data.cs
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
/// </example>
public static bool AsBool(this Stream stream)
{
return BitConverter.ToBoolean(GetBuffer(stream, sizeof(bool)), 0);

Check warning on line 41 in src/Data.cs

View workflow job for this annotation

GitHub Actions / build

In externally visible method 'bool Data.AsBool(Stream stream)', validate parameter 'stream' is non-null before using it. If appropriate, throw an 'ArgumentNullException' when the argument is 'null'. (https://learn.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1062)
}

#endregion
Expand Down Expand Up @@ -116,7 +116,7 @@
/// </example>
public static byte[] AsByteArray(this Stream stream)
{
return GetBuffer(stream, (int)stream.Length);

Check warning on line 119 in src/Data.cs

View workflow job for this annotation

GitHub Actions / build

In externally visible method 'byte[] Data.AsByteArray(Stream stream)', validate parameter 'stream' is non-null before using it. If appropriate, throw an 'ArgumentNullException' when the argument is 'null'. (https://learn.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1062)
}

#endregion
Expand Down Expand Up @@ -508,7 +508,7 @@
public static Stream FromVarInt(long value)
{
var result = new MemoryStream();
ulong buffer = (value >= 0) ? (ulong)(value << 1) : (((ulong)(-value) << 1) + 1);
ulong buffer = (value >= 0) ? (ulong)(value << 1) : (((ulong)-value << 1) + 1);
CompactBytes(result, buffer);
return result;
}
Expand Down Expand Up @@ -876,7 +876,7 @@
}

var stream = new MemoryStream();
await value.SaveAsync(stream).ConfigureAwait(false);
await value.SaveAsync(stream);
return stream;
}

Expand All @@ -890,11 +890,12 @@
/// var tree = await Data.AsTreeAsync(stream);
/// </code>
/// </example>
public static async Task<Element> AsElementAsync(this Stream stream)
public static async Task<Element> AsElementAsync(this Stream stream, Element? loaderElement = default)
{
loaderElement ??= new Element();
Element result;
stream.Position = 0;
result = await Element.LoadAsync(stream).ConfigureAwait(false);
result = await loaderElement.LoadAsync(stream);
stream.Position = 0;
return result;
}
Expand Down
10 changes: 5 additions & 5 deletions src/ElementEvents.cs
Original file line number Diff line number Diff line change
Expand Up @@ -69,12 +69,12 @@ public partial class Element
/// <summary>
/// Event handler for all Promptuarium data loading events
/// </summary>
public static event EventHandler<PromptuariumLoadingEventArgs>? OnDataLoading;
public event EventHandler<PromptuariumLoadingEventArgs>? OnDataLoading;

/// <summary>
/// Event handler for all Promptuarium data loaded events
/// </summary>
public static event EventHandler<PromptuariumLoadedEventArgs>? OnDataLoaded;
public event EventHandler<PromptuariumLoadedEventArgs>? OnDataLoaded;

/// <summary>
/// Event handler for all Promptuarium data saving events
Expand All @@ -89,12 +89,12 @@ public partial class Element
/// <summary>
/// Event handler for all Promptuarium metadata loading events
/// </summary>
public static event EventHandler<PromptuariumLoadingEventArgs>? OnMetaDataLoading;
public event EventHandler<PromptuariumLoadingEventArgs>? OnMetaDataLoading;

/// <summary>
/// Event handler for all Promptuarium metadata loaded events
/// </summary>
public static event EventHandler<PromptuariumLoadedEventArgs>? OnMetaDataLoaded;
public event EventHandler<PromptuariumLoadedEventArgs>? OnMetaDataLoaded;

/// <summary>
/// Event handler for all Promptuarium metadata saving events
Expand All @@ -105,7 +105,7 @@ public partial class Element
/// Event handler for all Promptuarium metadata saved events
/// </summary>
public event EventHandler<PromptuariumSavedEventArgs>? OnMetaDataSaved;

#endregion
}
#endregion
14 changes: 7 additions & 7 deletions src/ElementIo.cs
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ public partial class Element
/// var tree = await Element.LoadAsync(stream, cancellationToken);
/// </code>
/// </example>
public static Task<Element> LoadAsync(Stream stream, CancellationToken cancellationToken)
public Task<Element> LoadAsync(Stream stream, CancellationToken cancellationToken)
{
return DeserializeAsync(stream, cancellationToken);
}
Expand All @@ -38,7 +38,7 @@ public static Task<Element> LoadAsync(Stream stream, CancellationToken cancellat
/// var tree = await Element.LoadAsync(stream);
/// </code>
/// </example>
public static Task<Element> LoadAsync(Stream stream)
public Task<Element> LoadAsync(Stream stream)
{
return LoadAsync(stream, CancellationToken.None);
}
Expand All @@ -55,10 +55,10 @@ public static Task<Element> LoadAsync(Stream stream)
/// var tree = await Element.LoadAsync("test.prm", cancellationToken);
/// </code>
/// </example>
public static async Task<Element> LoadAsync(string fileName, CancellationToken cancellationToken)
public async Task<Element> LoadAsync(string fileName, CancellationToken cancellationToken)
{
using var fileStream = new FileStream(fileName, FileMode.Open);
return await LoadAsync(fileStream, cancellationToken).ConfigureAwait(false);
return await LoadAsync(fileStream, cancellationToken);
}

/// <summary>
Expand All @@ -72,7 +72,7 @@ public static async Task<Element> LoadAsync(string fileName, CancellationToken c
/// var tree = await Element.LoadAsync("test.prm");
/// </code>
/// </example>
public static Task<Element> LoadAsync(string fileName)
public Task<Element> LoadAsync(string fileName)
{
return LoadAsync(fileName, CancellationToken.None);
}
Expand All @@ -94,7 +94,7 @@ public static Task<Element> LoadAsync(string fileName)
/// </example>
public async Task SaveAsync(Stream stream, CancellationToken cancellationToken)
{
await SerializeAsync(stream, new SerializationArguments(), cancellationToken).ConfigureAwait(false);
await SerializeAsync(stream, new SerializationArguments(), cancellationToken);
stream.WriteByte(ControlByte(Directions.Append, DataType.Data, SizeType.Linear, 0));
}

Expand Down Expand Up @@ -127,7 +127,7 @@ public Task SaveAsync(Stream stream)
public async Task SaveAsync(string fileName, CancellationToken cancellationToken)
{
using Stream stream = new FileStream(fileName, FileMode.Create);
await SaveAsync(stream, cancellationToken).ConfigureAwait(false);
await SaveAsync(stream, cancellationToken);
}

/// <summary>
Expand Down
Loading
Loading