Serraniel/SweetLib
1
0
Fork 0
Code Issues Pull requests 2 Packages Projects Releases 2 Wiki Activity

Finalizations and build

Browse source
This commit is contained in:
Serraniel 2018-04-06 21:57:55 +02:00
parent 70001154b3
commit 6eb5db83f7
10 changed files with 2376 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

405
Docs/SweetLib.IO.md Normal file
View file

@ -0,0 +1,405 @@
<a name='contents'></a>
# Contents [#](#contents 'Go To Here')
- [IStreamable](#T-SweetLib-IO-Classes-Streaming-IStreamable 'SweetLib.IO.Classes.Streaming.IStreamable')
- [LoadFromStream(stream)](#M-SweetLib-IO-Classes-Streaming-IStreamable-LoadFromStream-System-IO-Stream- 'SweetLib.IO.Classes.Streaming.IStreamable.LoadFromStream(System.IO.Stream)')
- [SaveToStream(stream)](#M-SweetLib-IO-Classes-Streaming-IStreamable-SaveToStream-System-IO-Stream- 'SweetLib.IO.Classes.Streaming.IStreamable.SaveToStream(System.IO.Stream)')
- [StreamException](#T-SweetLib-IO-Classes-Streaming-StreamException 'SweetLib.IO.Classes.Streaming.StreamException')
- [#ctor()](#M-SweetLib-IO-Classes-Streaming-StreamException-#ctor 'SweetLib.IO.Classes.Streaming.StreamException.#ctor')
- [#ctor(message)](#M-SweetLib-IO-Classes-Streaming-StreamException-#ctor-System-String- 'SweetLib.IO.Classes.Streaming.StreamException.#ctor(System.String)')
- [StreamManager](#T-SweetLib-IO-Classes-Streaming-StreamManager 'SweetLib.IO.Classes.Streaming.StreamManager')
- [LoadFromStream(stream,value)](#M-SweetLib-IO-Classes-Streaming-StreamManager-LoadFromStream-System-IO-Stream,System-String@- 'SweetLib.IO.Classes.Streaming.StreamManager.LoadFromStream(System.IO.Stream,System.String@)')
- [LoadFromStream(stream,value)](#M-SweetLib-IO-Classes-Streaming-StreamManager-LoadFromStream-System-IO-Stream,System-Boolean@- 'SweetLib.IO.Classes.Streaming.StreamManager.LoadFromStream(System.IO.Stream,System.Boolean@)')
- [LoadFromStream(stream,value)](#M-SweetLib-IO-Classes-Streaming-StreamManager-LoadFromStream-System-IO-Stream,System-Char@- 'SweetLib.IO.Classes.Streaming.StreamManager.LoadFromStream(System.IO.Stream,System.Char@)')
- [LoadFromStream(stream,value)](#M-SweetLib-IO-Classes-Streaming-StreamManager-LoadFromStream-System-IO-Stream,System-Int32@- 'SweetLib.IO.Classes.Streaming.StreamManager.LoadFromStream(System.IO.Stream,System.Int32@)')
- [LoadFromStream(stream,value)](#M-SweetLib-IO-Classes-Streaming-StreamManager-LoadFromStream-System-IO-Stream,System-Int64@- 'SweetLib.IO.Classes.Streaming.StreamManager.LoadFromStream(System.IO.Stream,System.Int64@)')
- [LoadFromStream(stream,value)](#M-SweetLib-IO-Classes-Streaming-StreamManager-LoadFromStream-System-IO-Stream,System-Single@- 'SweetLib.IO.Classes.Streaming.StreamManager.LoadFromStream(System.IO.Stream,System.Single@)')
- [LoadFromStream(stream,value)](#M-SweetLib-IO-Classes-Streaming-StreamManager-LoadFromStream-System-IO-Stream,System-Double@- 'SweetLib.IO.Classes.Streaming.StreamManager.LoadFromStream(System.IO.Stream,System.Double@)')
- [LoadFromStream(stream,value)](#M-SweetLib-IO-Classes-Streaming-StreamManager-LoadFromStream-System-IO-Stream,System-DateTime@- 'SweetLib.IO.Classes.Streaming.StreamManager.LoadFromStream(System.IO.Stream,System.DateTime@)')
- [LoadFromStream(stream,value)](#M-SweetLib-IO-Classes-Streaming-StreamManager-LoadFromStream-System-IO-Stream,System-IO-Stream@- 'SweetLib.IO.Classes.Streaming.StreamManager.LoadFromStream(System.IO.Stream,System.IO.Stream@)')
- [SaveToStream(stream,value)](#M-SweetLib-IO-Classes-Streaming-StreamManager-SaveToStream-System-IO-Stream,System-String- 'SweetLib.IO.Classes.Streaming.StreamManager.SaveToStream(System.IO.Stream,System.String)')
- [SaveToStream(stream,value)](#M-SweetLib-IO-Classes-Streaming-StreamManager-SaveToStream-System-IO-Stream,System-Boolean- 'SweetLib.IO.Classes.Streaming.StreamManager.SaveToStream(System.IO.Stream,System.Boolean)')
- [SaveToStream(stream,value)](#M-SweetLib-IO-Classes-Streaming-StreamManager-SaveToStream-System-IO-Stream,System-Char- 'SweetLib.IO.Classes.Streaming.StreamManager.SaveToStream(System.IO.Stream,System.Char)')
- [SaveToStream(stream,value)](#M-SweetLib-IO-Classes-Streaming-StreamManager-SaveToStream-System-IO-Stream,System-Int32- 'SweetLib.IO.Classes.Streaming.StreamManager.SaveToStream(System.IO.Stream,System.Int32)')
- [SaveToStream(stream,value)](#M-SweetLib-IO-Classes-Streaming-StreamManager-SaveToStream-System-IO-Stream,System-Int64- 'SweetLib.IO.Classes.Streaming.StreamManager.SaveToStream(System.IO.Stream,System.Int64)')
- [SaveToStream(stream,value)](#M-SweetLib-IO-Classes-Streaming-StreamManager-SaveToStream-System-IO-Stream,System-Single- 'SweetLib.IO.Classes.Streaming.StreamManager.SaveToStream(System.IO.Stream,System.Single)')
- [SaveToStream(stream,value)](#M-SweetLib-IO-Classes-Streaming-StreamManager-SaveToStream-System-IO-Stream,System-Double- 'SweetLib.IO.Classes.Streaming.StreamManager.SaveToStream(System.IO.Stream,System.Double)')
- [SaveToStream(stream,value)](#M-SweetLib-IO-Classes-Streaming-StreamManager-SaveToStream-System-IO-Stream,System-DateTime- 'SweetLib.IO.Classes.Streaming.StreamManager.SaveToStream(System.IO.Stream,System.DateTime)')
- [SaveToStream(stream,value,resetSourceStream)](#M-SweetLib-IO-Classes-Streaming-StreamManager-SaveToStream-System-IO-Stream,System-IO-Stream,System-Boolean- 'SweetLib.IO.Classes.Streaming.StreamManager.SaveToStream(System.IO.Stream,System.IO.Stream,System.Boolean)')
- [StreamTypeException](#T-SweetLib-IO-Classes-Streaming-StreamTypeException 'SweetLib.IO.Classes.Streaming.StreamTypeException')
- [#ctor()](#M-SweetLib-IO-Classes-Streaming-StreamTypeException-#ctor 'SweetLib.IO.Classes.Streaming.StreamTypeException.#ctor')
- [#ctor(message)](#M-SweetLib-IO-Classes-Streaming-StreamTypeException-#ctor-System-String- 'SweetLib.IO.Classes.Streaming.StreamTypeException.#ctor(System.String)')
<a name='assembly'></a>
# SweetLib.IO [#](#assembly 'Go To Here') [=](#contents 'Back To Contents')
<a name='T-SweetLib-IO-Classes-Streaming-IStreamable'></a>
## IStreamable [#](#T-SweetLib-IO-Classes-Streaming-IStreamable 'Go To Here') [=](#contents 'Back To Contents')
##### Namespace
SweetLib.IO.Classes.Streaming
##### Summary
Streamable objects
<a name='M-SweetLib-IO-Classes-Streaming-IStreamable-LoadFromStream-System-IO-Stream-'></a>
### LoadFromStream(stream) `method` [#](#M-SweetLib-IO-Classes-Streaming-IStreamable-LoadFromStream-System-IO-Stream- 'Go To Here') [=](#contents 'Back To Contents')
##### Summary
Loads the object from a given stream.
##### Parameters
| Name | Type | Description |
| ---- | ---- | ----------- |
| stream | [System.IO.Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream') | Stream from which the object is loaded. |
<a name='M-SweetLib-IO-Classes-Streaming-IStreamable-SaveToStream-System-IO-Stream-'></a>
### SaveToStream(stream) `method` [#](#M-SweetLib-IO-Classes-Streaming-IStreamable-SaveToStream-System-IO-Stream- 'Go To Here') [=](#contents 'Back To Contents')
##### Summary
Saves the current object into a stream.
##### Parameters
| Name | Type | Description |
| ---- | ---- | ----------- |
| stream | [System.IO.Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream') | Stream in which the current object should be saved. |
<a name='T-SweetLib-IO-Classes-Streaming-StreamException'></a>
## StreamException [#](#T-SweetLib-IO-Classes-Streaming-StreamException 'Go To Here') [=](#contents 'Back To Contents')
##### Namespace
SweetLib.IO.Classes.Streaming
##### Summary
Exception thrown by streaming related operations.
<a name='M-SweetLib-IO-Classes-Streaming-StreamException-#ctor'></a>
### #ctor() `constructor` [#](#M-SweetLib-IO-Classes-Streaming-StreamException-#ctor 'Go To Here') [=](#contents 'Back To Contents')
##### Summary
Creates a new [StreamException](#T-SweetLib-IO-Classes-Streaming-StreamException 'SweetLib.IO.Classes.Streaming.StreamException').
##### Parameters
This constructor has no parameters.
<a name='M-SweetLib-IO-Classes-Streaming-StreamException-#ctor-System-String-'></a>
### #ctor(message) `constructor` [#](#M-SweetLib-IO-Classes-Streaming-StreamException-#ctor-System-String- 'Go To Here') [=](#contents 'Back To Contents')
##### Summary
Creates a new [StreamException](#T-SweetLib-IO-Classes-Streaming-StreamException 'SweetLib.IO.Classes.Streaming.StreamException').
##### Parameters
| Name | Type | Description |
| ---- | ---- | ----------- |
| message | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | Exception message. |
<a name='T-SweetLib-IO-Classes-Streaming-StreamManager'></a>
## StreamManager [#](#T-SweetLib-IO-Classes-Streaming-StreamManager 'Go To Here') [=](#contents 'Back To Contents')
##### Namespace
SweetLib.IO.Classes.Streaming
##### Summary
[StreamManager](#T-SweetLib-IO-Classes-Streaming-StreamManager 'SweetLib.IO.Classes.Streaming.StreamManager') wraps some useful methods for custom implementations of object streaming.
<a name='M-SweetLib-IO-Classes-Streaming-StreamManager-LoadFromStream-System-IO-Stream,System-String@-'></a>
### LoadFromStream(stream,value) `method` [#](#M-SweetLib-IO-Classes-Streaming-StreamManager-LoadFromStream-System-IO-Stream,System-String@- 'Go To Here') [=](#contents 'Back To Contents')
##### Summary
Loads a [String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') from a given [Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream').
##### Parameters
| Name | Type | Description |
| ---- | ---- | ----------- |
| stream | [System.IO.Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream') | [Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream') from which the [String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') will be loaded. |
| value | [System.String@](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String@ 'System.String@') | Contains the loaded [String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') value. |
<a name='M-SweetLib-IO-Classes-Streaming-StreamManager-LoadFromStream-System-IO-Stream,System-Boolean@-'></a>
### LoadFromStream(stream,value) `method` [#](#M-SweetLib-IO-Classes-Streaming-StreamManager-LoadFromStream-System-IO-Stream,System-Boolean@- 'Go To Here') [=](#contents 'Back To Contents')
##### Summary
Loads a [Boolean](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Boolean 'System.Boolean') from a given [Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream').
##### Parameters
| Name | Type | Description |
| ---- | ---- | ----------- |
| stream | [System.IO.Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream') | [Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream') from which the [Boolean](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Boolean 'System.Boolean') will be loaded. |
| value | [System.Boolean@](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Boolean@ 'System.Boolean@') | Contains the loaded [Boolean](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Boolean 'System.Boolean') value. |
<a name='M-SweetLib-IO-Classes-Streaming-StreamManager-LoadFromStream-System-IO-Stream,System-Char@-'></a>
### LoadFromStream(stream,value) `method` [#](#M-SweetLib-IO-Classes-Streaming-StreamManager-LoadFromStream-System-IO-Stream,System-Char@- 'Go To Here') [=](#contents 'Back To Contents')
##### Summary
Loads a [Char](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Char 'System.Char') from a given [Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream').
##### Parameters
| Name | Type | Description |
| ---- | ---- | ----------- |
| stream | [System.IO.Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream') | [Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream') from which the [Char](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Char 'System.Char') will be loaded. |
| value | [System.Char@](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Char@ 'System.Char@') | Contains the loaded [Char](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Char 'System.Char') value. |
<a name='M-SweetLib-IO-Classes-Streaming-StreamManager-LoadFromStream-System-IO-Stream,System-Int32@-'></a>
### LoadFromStream(stream,value) `method` [#](#M-SweetLib-IO-Classes-Streaming-StreamManager-LoadFromStream-System-IO-Stream,System-Int32@- 'Go To Here') [=](#contents 'Back To Contents')
##### Summary
Loads a [Int32](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') from a given [Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream').
##### Parameters
| Name | Type | Description |
| ---- | ---- | ----------- |
| stream | [System.IO.Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream') | [Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream') from which the [Int32](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') will be loaded. |
| value | [System.Int32@](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32@ 'System.Int32@') | Contains the loaded [Int32](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') value. |
<a name='M-SweetLib-IO-Classes-Streaming-StreamManager-LoadFromStream-System-IO-Stream,System-Int64@-'></a>
### LoadFromStream(stream,value) `method` [#](#M-SweetLib-IO-Classes-Streaming-StreamManager-LoadFromStream-System-IO-Stream,System-Int64@- 'Go To Here') [=](#contents 'Back To Contents')
##### Summary
Loads a [Int64](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int64 'System.Int64') from a given [Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream').
##### Parameters
| Name | Type | Description |
| ---- | ---- | ----------- |
| stream | [System.IO.Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream') | [Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream') from which the [Int64](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int64 'System.Int64') will be loaded. |
| value | [System.Int64@](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int64@ 'System.Int64@') | Contains the loaded [Int64](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int64 'System.Int64') value. |
<a name='M-SweetLib-IO-Classes-Streaming-StreamManager-LoadFromStream-System-IO-Stream,System-Single@-'></a>
### LoadFromStream(stream,value) `method` [#](#M-SweetLib-IO-Classes-Streaming-StreamManager-LoadFromStream-System-IO-Stream,System-Single@- 'Go To Here') [=](#contents 'Back To Contents')
##### Summary
Loads a [String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') from a given [Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream').
##### Parameters
| Name | Type | Description |
| ---- | ---- | ----------- |
| stream | [System.IO.Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream') | [Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream') from which the [String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') will be loaded. |
| value | [System.Single@](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Single@ 'System.Single@') | Contains the loaded [String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') value. |
<a name='M-SweetLib-IO-Classes-Streaming-StreamManager-LoadFromStream-System-IO-Stream,System-Double@-'></a>
### LoadFromStream(stream,value) `method` [#](#M-SweetLib-IO-Classes-Streaming-StreamManager-LoadFromStream-System-IO-Stream,System-Double@- 'Go To Here') [=](#contents 'Back To Contents')
##### Summary
Loads a [Double](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Double 'System.Double') from a given [Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream').
##### Parameters
| Name | Type | Description |
| ---- | ---- | ----------- |
| stream | [System.IO.Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream') | [Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream') from which the [Double](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Double 'System.Double') will be loaded. |
| value | [System.Double@](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Double@ 'System.Double@') | Contains the loaded [Double](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Double 'System.Double') value. |
<a name='M-SweetLib-IO-Classes-Streaming-StreamManager-LoadFromStream-System-IO-Stream,System-DateTime@-'></a>
### LoadFromStream(stream,value) `method` [#](#M-SweetLib-IO-Classes-Streaming-StreamManager-LoadFromStream-System-IO-Stream,System-DateTime@- 'Go To Here') [=](#contents 'Back To Contents')
##### Summary
Loads a [DateTime](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.DateTime 'System.DateTime') from a given [Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream').
##### Parameters
| Name | Type | Description |
| ---- | ---- | ----------- |
| stream | [System.IO.Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream') | [Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream') from which the [DateTime](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.DateTime 'System.DateTime') will be loaded. |
| value | [System.DateTime@](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.DateTime@ 'System.DateTime@') | Contains the loaded [DateTime](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.DateTime 'System.DateTime') value. |
<a name='M-SweetLib-IO-Classes-Streaming-StreamManager-LoadFromStream-System-IO-Stream,System-IO-Stream@-'></a>
### LoadFromStream(stream,value) `method` [#](#M-SweetLib-IO-Classes-Streaming-StreamManager-LoadFromStream-System-IO-Stream,System-IO-Stream@- 'Go To Here') [=](#contents 'Back To Contents')
##### Summary
Loads a [Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream') from a given [Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream').
##### Parameters
| Name | Type | Description |
| ---- | ---- | ----------- |
| stream | [System.IO.Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream') | [Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream') from which the [Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream') will be loaded. |
| value | [System.IO.Stream@](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream@ 'System.IO.Stream@') | Contains the loaded [Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream') value. |
<a name='M-SweetLib-IO-Classes-Streaming-StreamManager-SaveToStream-System-IO-Stream,System-String-'></a>
### SaveToStream(stream,value) `method` [#](#M-SweetLib-IO-Classes-Streaming-StreamManager-SaveToStream-System-IO-Stream,System-String- 'Go To Here') [=](#contents 'Back To Contents')
##### Summary
Adds a [String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') to a given [Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream').
##### Parameters
| Name | Type | Description |
| ---- | ---- | ----------- |
| stream | [System.IO.Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream') | [Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream') to which the [String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') will be added. |
| value | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | [String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') value to add. |
<a name='M-SweetLib-IO-Classes-Streaming-StreamManager-SaveToStream-System-IO-Stream,System-Boolean-'></a>
### SaveToStream(stream,value) `method` [#](#M-SweetLib-IO-Classes-Streaming-StreamManager-SaveToStream-System-IO-Stream,System-Boolean- 'Go To Here') [=](#contents 'Back To Contents')
##### Summary
Adds a [Boolean](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Boolean 'System.Boolean') to a given [Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream').
##### Parameters
| Name | Type | Description |
| ---- | ---- | ----------- |
| stream | [System.IO.Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream') | [Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream') to which the [Boolean](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Boolean 'System.Boolean') will be added. |
| value | [System.Boolean](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Boolean 'System.Boolean') | [Boolean](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Boolean 'System.Boolean') value to add. |
<a name='M-SweetLib-IO-Classes-Streaming-StreamManager-SaveToStream-System-IO-Stream,System-Char-'></a>
### SaveToStream(stream,value) `method` [#](#M-SweetLib-IO-Classes-Streaming-StreamManager-SaveToStream-System-IO-Stream,System-Char- 'Go To Here') [=](#contents 'Back To Contents')
##### Summary
Adds a [Char](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Char 'System.Char') to a given [Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream').
##### Parameters
| Name | Type | Description |
| ---- | ---- | ----------- |
| stream | [System.IO.Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream') | [Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream') to which the [Char](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Char 'System.Char') will be added. |
| value | [System.Char](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Char 'System.Char') | [Char](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Char 'System.Char') value to add. |
<a name='M-SweetLib-IO-Classes-Streaming-StreamManager-SaveToStream-System-IO-Stream,System-Int32-'></a>
### SaveToStream(stream,value) `method` [#](#M-SweetLib-IO-Classes-Streaming-StreamManager-SaveToStream-System-IO-Stream,System-Int32- 'Go To Here') [=](#contents 'Back To Contents')
##### Summary
Adds a [Int32](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') to a given [Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream').
##### Parameters
| Name | Type | Description |
| ---- | ---- | ----------- |
| stream | [System.IO.Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream') | [Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream') to which the [Int32](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') will be added. |
| value | [System.Int32](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') | [Int32](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int32 'System.Int32') value to add. |
<a name='M-SweetLib-IO-Classes-Streaming-StreamManager-SaveToStream-System-IO-Stream,System-Int64-'></a>
### SaveToStream(stream,value) `method` [#](#M-SweetLib-IO-Classes-Streaming-StreamManager-SaveToStream-System-IO-Stream,System-Int64- 'Go To Here') [=](#contents 'Back To Contents')
##### Summary
Adds a [Int64](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int64 'System.Int64') to a given [Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream').
##### Parameters
| Name | Type | Description |
| ---- | ---- | ----------- |
| stream | [System.IO.Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream') | [Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream') to which the [Int64](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int64 'System.Int64') will be added. |
| value | [System.Int64](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int64 'System.Int64') | [Int64](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Int64 'System.Int64') value to add. |
<a name='M-SweetLib-IO-Classes-Streaming-StreamManager-SaveToStream-System-IO-Stream,System-Single-'></a>
### SaveToStream(stream,value) `method` [#](#M-SweetLib-IO-Classes-Streaming-StreamManager-SaveToStream-System-IO-Stream,System-Single- 'Go To Here') [=](#contents 'Back To Contents')
##### Summary
Adds a [Single](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Single 'System.Single') to a given [Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream').
##### Parameters
| Name | Type | Description |
| ---- | ---- | ----------- |
| stream | [System.IO.Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream') | [Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream') to which the [Single](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Single 'System.Single') will be added. |
| value | [System.Single](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Single 'System.Single') | [Single](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Single 'System.Single') value to add. |
<a name='M-SweetLib-IO-Classes-Streaming-StreamManager-SaveToStream-System-IO-Stream,System-Double-'></a>
### SaveToStream(stream,value) `method` [#](#M-SweetLib-IO-Classes-Streaming-StreamManager-SaveToStream-System-IO-Stream,System-Double- 'Go To Here') [=](#contents 'Back To Contents')
##### Summary
Adds a [Double](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Double 'System.Double') to a given [Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream').
##### Parameters
| Name | Type | Description |
| ---- | ---- | ----------- |
| stream | [System.IO.Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream') | [Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream') to which the [Double](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Double 'System.Double') will be added. |
| value | [System.Double](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Double 'System.Double') | [Double](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Double 'System.Double') value to add. |
<a name='M-SweetLib-IO-Classes-Streaming-StreamManager-SaveToStream-System-IO-Stream,System-DateTime-'></a>
### SaveToStream(stream,value) `method` [#](#M-SweetLib-IO-Classes-Streaming-StreamManager-SaveToStream-System-IO-Stream,System-DateTime- 'Go To Here') [=](#contents 'Back To Contents')
##### Summary
Adds a [DateTime](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.DateTime 'System.DateTime') to a given [Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream').
##### Parameters
| Name | Type | Description |
| ---- | ---- | ----------- |
| stream | [System.IO.Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream') | [Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream') to which the [DateTime](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.DateTime 'System.DateTime') will be added. |
| value | [System.DateTime](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.DateTime 'System.DateTime') | [DateTime](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.DateTime 'System.DateTime') value to add. |
<a name='M-SweetLib-IO-Classes-Streaming-StreamManager-SaveToStream-System-IO-Stream,System-IO-Stream,System-Boolean-'></a>
### SaveToStream(stream,value,resetSourceStream) `method` [#](#M-SweetLib-IO-Classes-Streaming-StreamManager-SaveToStream-System-IO-Stream,System-IO-Stream,System-Boolean- 'Go To Here') [=](#contents 'Back To Contents')
##### Summary
Adds a [Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream') to a given [Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream').
##### Parameters
| Name | Type | Description |
| ---- | ---- | ----------- |
| stream | [System.IO.Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream') | [Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream') to which the [Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream') will be added. |
| value | [System.IO.Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream') | [Stream](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.IO.Stream 'System.IO.Stream') value to add. |
| resetSourceStream | [System.Boolean](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.Boolean 'System.Boolean') | If true, the full given [](#!-value 'value') will be copied, otherwhise the stream will be copied from current position until its end. |
<a name='T-SweetLib-IO-Classes-Streaming-StreamTypeException'></a>
## StreamTypeException [#](#T-SweetLib-IO-Classes-Streaming-StreamTypeException 'Go To Here') [=](#contents 'Back To Contents')
##### Namespace
SweetLib.IO.Classes.Streaming
##### Summary
Exception thrown by streaming related operations. May be thrown if the stream types do not match.
<a name='M-SweetLib-IO-Classes-Streaming-StreamTypeException-#ctor'></a>
### #ctor() `constructor` [#](#M-SweetLib-IO-Classes-Streaming-StreamTypeException-#ctor 'Go To Here') [=](#contents 'Back To Contents')
##### Summary
Creates a new [StreamTypeException](#T-SweetLib-IO-Classes-Streaming-StreamTypeException 'SweetLib.IO.Classes.Streaming.StreamTypeException').
##### Parameters
This constructor has no parameters.
<a name='M-SweetLib-IO-Classes-Streaming-StreamTypeException-#ctor-System-String-'></a>
### #ctor(message) `constructor` [#](#M-SweetLib-IO-Classes-Streaming-StreamTypeException-#ctor-System-String- 'Go To Here') [=](#contents 'Back To Contents')
##### Summary
Creates a new [StreamTypeException](#T-SweetLib-IO-Classes-Streaming-StreamTypeException 'SweetLib.IO.Classes.Streaming.StreamTypeException').
##### Parameters
| Name | Type | Description |
| ---- | ---- | ----------- |
| message | [System.String](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.String 'System.String') | Exception message. |

189
Docs/SweetLib.IO.xml Normal file
View file

@ -0,0 +1,189 @@
<?xml version="1.0"?>
<doc>
<assembly>
<name>SweetLib.IO</name>
</assembly>
<members>
<member name="T:SweetLib.IO.Classes.Streaming.IStreamable">
<summary>
Streamable objects
</summary>
</member>
<member name="M:SweetLib.IO.Classes.Streaming.IStreamable.SaveToStream(System.IO.Stream)">
<summary>
Saves the current object into a stream.
</summary>
<param name="stream">Stream in which the current object should be saved.</param>
</member>
<member name="M:SweetLib.IO.Classes.Streaming.IStreamable.LoadFromStream(System.IO.Stream)">
<summary>
Loads the object from a given stream.
</summary>
<param name="stream">Stream from which the object is loaded.</param>
</member>
<member name="T:SweetLib.IO.Classes.Streaming.StreamException">
<summary>
Exception thrown by streaming related operations.
</summary>
</member>
<member name="M:SweetLib.IO.Classes.Streaming.StreamException.#ctor">
<summary>
Creates a new <see cref="T:SweetLib.IO.Classes.Streaming.StreamException"/>.
</summary>
</member>
<member name="M:SweetLib.IO.Classes.Streaming.StreamException.#ctor(System.String)">
<summary>
Creates a new <see cref="T:SweetLib.IO.Classes.Streaming.StreamException"/>.
</summary>
<param name="message">Exception message.</param>
</member>
<member name="T:SweetLib.IO.Classes.Streaming.StreamTypeException">
<summary>
Exception thrown by streaming related operations. May be thrown if the stream types do not match.
</summary>
</member>
<member name="M:SweetLib.IO.Classes.Streaming.StreamTypeException.#ctor">
<summary>
Creates a new <see cref="T:SweetLib.IO.Classes.Streaming.StreamTypeException"/>.
</summary>
</member>
<member name="M:SweetLib.IO.Classes.Streaming.StreamTypeException.#ctor(System.String)">
<summary>
Creates a new <see cref="T:SweetLib.IO.Classes.Streaming.StreamTypeException"/>.
</summary>
<param name="message">Exception message.</param>
</member>
<member name="T:SweetLib.IO.Classes.Streaming.StreamManager">
<summary>
<see cref="T:SweetLib.IO.Classes.Streaming.StreamManager"/> wraps some useful methods for custom implementations of object streaming.
</summary>
</member>
<member name="M:SweetLib.IO.Classes.Streaming.StreamManager.SaveToStream(System.IO.Stream,System.String)">
<summary>
Adds a <see cref="T:System.String"/> to a given <see cref="T:System.IO.Stream"/>.
</summary>
<param name="stream"><see cref="T:System.IO.Stream"/> to which the <see cref="T:System.String"/> will be added.</param>
<param name="value"><see cref="T:System.String"/> value to add.</param>
</member>
<member name="M:SweetLib.IO.Classes.Streaming.StreamManager.SaveToStream(System.IO.Stream,System.Boolean)">
<summary>
Adds a <see cref="T:System.Boolean"/> to a given <see cref="T:System.IO.Stream"/>.
</summary>
<param name="stream"><see cref="T:System.IO.Stream"/> to which the <see cref="T:System.Boolean"/> will be added.</param>
<param name="value"><see cref="T:System.Boolean"/> value to add.</param>
</member>
<member name="M:SweetLib.IO.Classes.Streaming.StreamManager.SaveToStream(System.IO.Stream,System.Char)">
<summary>
Adds a <see cref="T:System.Char"/> to a given <see cref="T:System.IO.Stream"/>.
</summary>
<param name="stream"><see cref="T:System.IO.Stream"/> to which the <see cref="T:System.Char"/> will be added.</param>
<param name="value"><see cref="T:System.Char"/> value to add.</param>
</member>
<member name="M:SweetLib.IO.Classes.Streaming.StreamManager.SaveToStream(System.IO.Stream,System.Int32)">
<summary>
Adds a <see cref="T:System.Int32"/> to a given <see cref="T:System.IO.Stream"/>.
</summary>
<param name="stream"><see cref="T:System.IO.Stream"/> to which the <see cref="T:System.Int32"/> will be added.</param>
<param name="value"><see cref="T:System.Int32"/> value to add.</param>
</member>
<member name="M:SweetLib.IO.Classes.Streaming.StreamManager.SaveToStream(System.IO.Stream,System.Int64)">
<summary>
Adds a <see cref="T:System.Int64"/> to a given <see cref="T:System.IO.Stream"/>.
</summary>
<param name="stream"><see cref="T:System.IO.Stream"/> to which the <see cref="T:System.Int64"/> will be added.</param>
<param name="value"><see cref="T:System.Int64"/> value to add.</param>
</member>
<member name="M:SweetLib.IO.Classes.Streaming.StreamManager.SaveToStream(System.IO.Stream,System.Single)">
<summary>
Adds a <see cref="T:System.Single"/> to a given <see cref="T:System.IO.Stream"/>.
</summary>
<param name="stream"><see cref="T:System.IO.Stream"/> to which the <see cref="T:System.Single"/> will be added.</param>
<param name="value"><see cref="T:System.Single"/> value to add.</param>
</member>
<member name="M:SweetLib.IO.Classes.Streaming.StreamManager.SaveToStream(System.IO.Stream,System.Double)">
<summary>
Adds a <see cref="T:System.Double"/> to a given <see cref="T:System.IO.Stream"/>.
</summary>
<param name="stream"><see cref="T:System.IO.Stream"/> to which the <see cref="T:System.Double"/> will be added.</param>
<param name="value"><see cref="T:System.Double"/> value to add.</param>
</member>
<member name="M:SweetLib.IO.Classes.Streaming.StreamManager.SaveToStream(System.IO.Stream,System.DateTime)">
<summary>
Adds a <see cref="T:System.DateTime"/> to a given <see cref="T:System.IO.Stream"/>.
</summary>
<param name="stream"><see cref="T:System.IO.Stream"/> to which the <see cref="T:System.DateTime"/> will be added.</param>
<param name="value"><see cref="T:System.DateTime"/> value to add.</param>
</member>
<member name="M:SweetLib.IO.Classes.Streaming.StreamManager.SaveToStream(System.IO.Stream,System.IO.Stream,System.Boolean)">
<summary>
Adds a <see cref="T:System.IO.Stream"/> to a given <see cref="T:System.IO.Stream"/>.
</summary>
<param name="stream"><see cref="T:System.IO.Stream"/> to which the <see cref="T:System.IO.Stream"/> will be added.</param>
<param name="value"><see cref="T:System.IO.Stream"/> value to add.</param>
<param name="resetSourceStream">If true, the full given <see cref="!:value"/> will be copied, otherwhise the stream will be copied from current position until its end.</param>
</member>
<member name="M:SweetLib.IO.Classes.Streaming.StreamManager.LoadFromStream(System.IO.Stream,System.String@)">
<summary>
Loads a <see cref="T:System.String"/> from a given <see cref="T:System.IO.Stream"/>.
</summary>
<param name="stream"><see cref="T:System.IO.Stream"/> from which the <see cref="T:System.String"/> will be loaded.</param>
<param name="value">Contains the loaded <see cref="T:System.String"/> value.</param>
</member>
<member name="M:SweetLib.IO.Classes.Streaming.StreamManager.LoadFromStream(System.IO.Stream,System.Boolean@)">
<summary>
Loads a <see cref="T:System.Boolean"/> from a given <see cref="T:System.IO.Stream"/>.
</summary>
<param name="stream"><see cref="T:System.IO.Stream"/> from which the <see cref="T:System.Boolean"/> will be loaded.</param>
<param name="value">Contains the loaded <see cref="T:System.Boolean"/> value.</param>
</member>
<member name="M:SweetLib.IO.Classes.Streaming.StreamManager.LoadFromStream(System.IO.Stream,System.Char@)">
<summary>
Loads a <see cref="T:System.Char"/> from a given <see cref="T:System.IO.Stream"/>.
</summary>
<param name="stream"><see cref="T:System.IO.Stream"/> from which the <see cref="T:System.Char"/> will be loaded.</param>
<param name="value">Contains the loaded <see cref="T:System.Char"/> value.</param>
</member>
<member name="M:SweetLib.IO.Classes.Streaming.StreamManager.LoadFromStream(System.IO.Stream,System.Int32@)">
<summary>
Loads a <see cref="T:System.Int32"/> from a given <see cref="T:System.IO.Stream"/>.
</summary>
<param name="stream"><see cref="T:System.IO.Stream"/> from which the <see cref="T:System.Int32"/> will be loaded.</param>
<param name="value">Contains the loaded <see cref="T:System.Int32"/> value.</param>
</member>
<member name="M:SweetLib.IO.Classes.Streaming.StreamManager.LoadFromStream(System.IO.Stream,System.Int64@)">
<summary>
Loads a <see cref="T:System.Int64"/> from a given <see cref="T:System.IO.Stream"/>.
</summary>
<param name="stream"><see cref="T:System.IO.Stream"/> from which the <see cref="T:System.Int64"/> will be loaded.</param>
<param name="value">Contains the loaded <see cref="T:System.Int64"/> value.</param>
</member>
<member name="M:SweetLib.IO.Classes.Streaming.StreamManager.LoadFromStream(System.IO.Stream,System.Single@)">
<summary>
Loads a <see cref="T:System.String"/> from a given <see cref="T:System.IO.Stream"/>.
</summary>
<param name="stream"><see cref="T:System.IO.Stream"/> from which the <see cref="T:System.String"/> will be loaded.</param>
<param name="value">Contains the loaded <see cref="T:System.String"/> value.</param>
</member>
<member name="M:SweetLib.IO.Classes.Streaming.StreamManager.LoadFromStream(System.IO.Stream,System.Double@)">
<summary>
Loads a <see cref="T:System.Double"/> from a given <see cref="T:System.IO.Stream"/>.
</summary>
<param name="stream"><see cref="T:System.IO.Stream"/> from which the <see cref="T:System.Double"/> will be loaded.</param>
<param name="value">Contains the loaded <see cref="T:System.Double"/> value.</param>
</member>
<member name="M:SweetLib.IO.Classes.Streaming.StreamManager.LoadFromStream(System.IO.Stream,System.DateTime@)">
<summary>
Loads a <see cref="T:System.DateTime"/> from a given <see cref="T:System.IO.Stream"/>.
</summary>
<param name="stream"><see cref="T:System.IO.Stream"/> from which the <see cref="T:System.DateTime"/> will be loaded.</param>
<param name="value">Contains the loaded <see cref="T:System.DateTime"/> value.</param>
</member>
<member name="M:SweetLib.IO.Classes.Streaming.StreamManager.LoadFromStream(System.IO.Stream,System.IO.Stream@)">
<summary>
Loads a <see cref="T:System.IO.Stream"/> from a given <see cref="T:System.IO.Stream"/>.
</summary>
<param name="stream"><see cref="T:System.IO.Stream"/> from which the <see cref="T:System.IO.Stream"/> will be loaded.</param>
<param name="value">Contains the loaded <see cref="T:System.IO.Stream"/> value.</param>
</member>
</members>
</doc>

1232
Docs/SweetLib.md Normal file
View file

File diff suppressed because it is too large Load diff

538
Docs/SweetLib.xml Normal file
View file

@ -0,0 +1,538 @@
<?xml version="1.0"?>
<doc>
<assembly>
<name>SweetLib</name>
</assembly>
<members>
<member name="T:SweetLib.Classes.Exceptions.RegistryStorerException">
<summary>
Exception thrown by <see cref="T:SweetLib.Classes.Storer.RegistryStorer"/>.
</summary>
</member>
<member name="M:SweetLib.Classes.Exceptions.RegistryStorerException.#ctor">
<summary>
Creates a new <see cref="T:SweetLib.Classes.Exceptions.RegistryStorerException"/>.
</summary>
</member>
<member name="M:SweetLib.Classes.Exceptions.RegistryStorerException.#ctor(System.String)">
<summary>
Creates a new <see cref="T:SweetLib.Classes.Exceptions.RegistryStorerException"/>.
</summary>
<param name="message">Exception message.</param>
</member>
<member name="T:SweetLib.Classes.Storer.IniFileStorer">
<summary>
Implementation of an <see cref="T:SweetLib.Classes.Storer.IStorer"/> interface which stores the data inside an ini file.
</summary>
</member>
<member name="P:SweetLib.Classes.Storer.IniFileStorer.FileName">
<summary>
Ini file path.
</summary>
</member>
<member name="M:SweetLib.Classes.Storer.IniFileStorer.#ctor(System.String)">
<summary>
Creates a new instance of <see cref="T:SweetLib.Classes.Storer.IniFileStorer"/> with a specified file name.
</summary>
<param name="fileName">The file name of the ini file.</param>
</member>
<member name="T:SweetLib.Classes.Storer.IStorer">
<summary>
Interface, which provides several methods to store simple data.
</summary>
</member>
<member name="M:SweetLib.Classes.Storer.IStorer.ReadString(System.String,System.String,System.String)">
<summary>
Reads a string value.
</summary>
<param name="section">Represents the section in which the data is stored.</param>
<param name="key">Represents the key of the stored data.</param>
<param name="defaultValue">Default value, if this value does not exist.</param>
<returns>Value of the <see cref="!:key"/> in <see cref="!:section"/>.</returns>
</member>
<member name="M:SweetLib.Classes.Storer.IStorer.ReadInteger(System.String,System.String,System.Int32)">
<summary>
Reads an integer value.
</summary>
<param name="section">Represents the section in which the data is stored.</param>
<param name="key">Represents the key of the stored data.</param>
<param name="defaultValue">Default value, if this value does not exist.</param>
<returns>Value of the <see cref="!:key"/> in <see cref="!:section"/>.</returns>
</member>
<member name="M:SweetLib.Classes.Storer.IStorer.ReadBool(System.String,System.String,System.Boolean)">
<summary>
Reads a bool value.
</summary>
<param name="section">Represents the section in which the data is stored.</param>
<param name="key">Represents the key of the stored data.</param>
<param name="defaultValue">Default value, if this value does not exist.</param>
<returns>Value of the <see cref="!:key"/> in <see cref="!:section"/>.</returns>
</member>
<member name="M:SweetLib.Classes.Storer.IStorer.HasKey(System.String,System.String)">
<summary>
Checks, if a key exists inside a section.
</summary>
<param name="section">Represents the section in which the data is stored.</param>
<param name="key">Represents the key of the stored data.</param>
<returns>True, if <see cref="!:key"/> is found inside <see cref="!:section"/>.</returns>
</member>
<member name="M:SweetLib.Classes.Storer.IStorer.WriteString(System.String,System.String,System.String)">
<summary>
Writes a string value.
</summary>
<param name="section">Represents the section in which the data is stored.</param>
<param name="key">Represents the key of the stored data.</param>
<param name="value">Value to be stored.</param>
</member>
<member name="M:SweetLib.Classes.Storer.IStorer.WriteInteger(System.String,System.String,System.Int32)">
<summary>
Writes an integer value.
</summary>
<param name="section">Represents the section in which the data is stored.</param>
<param name="key">Represents the key of the stored data.</param>
<param name="value">Value to be stored.</param>
</member>
<member name="M:SweetLib.Classes.Storer.IStorer.WriteBool(System.String,System.String,System.Boolean)">
<summary>
Writes a bool value.
</summary>
<param name="section">Represents the section in which the data is stored.</param>
<param name="key">Represents the key of the stored data.</param>
<param name="value">Value to be stored.</param>
</member>
<member name="M:SweetLib.Classes.Storer.IStorer.DeleteKey(System.String,System.String)">
<summary>
Deletes a key inside a <see cref="!:section"/>.
</summary>
<param name="section">Represents the section in which the data is stored.</param>
<param name="key">Represents the key to be deleted.</param>
</member>
<member name="M:SweetLib.Classes.Storer.IStorer.DeleteSection(System.String)">
<summary>
Deletes a section with all its keys.
</summary>
<param name="section">Represents the section to be deleted.</param>
</member>
<member name="T:SweetLib.Classes.Storer.RegistryStorer">
<summary>
Implementation of an <see cref="T:SweetLib.Classes.Storer.IStorer"/> interface which stores the data inside the registry.
</summary>
<remarks>
Sections will be interpreted as subkeys on registry level.
</remarks>
</member>
<member name="P:SweetLib.Classes.Storer.RegistryStorer.OperatingRegistryKey">
<summary>
The base registry key in which will be operated.
</summary>
</member>
<member name="M:SweetLib.Classes.Storer.RegistryStorer.#ctor(System.String)">
<summary>
Creates a new instance of <see cref="T:SweetLib.Classes.Storer.RegistryStorer"/> with a specified application name.
</summary>
<param name="appName">The applications base name. This will be used as name for a sub key inside the software key below the base key.</param>
<remarks>
This will use current user as the base key.
</remarks>
</member>
<member name="M:SweetLib.Classes.Storer.RegistryStorer.#ctor(Microsoft.Win32.RegistryKey,System.String)">
<summary>
Creates a new instance of <see cref="T:SweetLib.Classes.Storer.RegistryStorer"/> with a specified application name.
</summary>
<param name="baseRegistryKey">Provide a key of <see cref="T:Microsoft.Win32.Registry"/>, e.G. <i>Registry.CurrentUser</i>.</param>
<param name="appName">The applications base name. This will be used as name for a sub key inside the software key below the base key.</param>
</member>
<member name="T:SweetLib.Utils.Extensions.BaseTypeExtensions">
<summary>
Defines extensions to some general classes.
</summary>
</member>
<member name="M:SweetLib.Utils.Extensions.BaseTypeExtensions.AsBytes(System.Int16)">
<summary>
Converts a <see cref="T:System.Int16"/> value into a byte array.
</summary>
<param name="value">Value to convert.</param>
<returns>Byte array representation of the value.</returns>
</member>
<member name="M:SweetLib.Utils.Extensions.BaseTypeExtensions.AsBytes(System.UInt16)">
<summary>
Converts a <see cref="T:System.UInt16"/> value into a byte array.
</summary>
<param name="value">Value to convert.</param>
<returns>Byte array representation of the value.</returns>
</member>
<member name="M:SweetLib.Utils.Extensions.BaseTypeExtensions.AsBytes(System.Int32)">
<summary>
Converts a <see cref="T:System.Int32"/> value into a byte array.
</summary>
<param name="value">Value to convert.</param>
<returns>Byte array representation of the value.</returns>
</member>
<member name="M:SweetLib.Utils.Extensions.BaseTypeExtensions.AsBytes(System.UInt32)">
<summary>
Converts a <see cref="T:System.UInt32"/> value into a byte array.
</summary>
<param name="value">Value to convert.</param>
<returns>Byte array representation of the value.</returns>
</member>
<member name="M:SweetLib.Utils.Extensions.BaseTypeExtensions.AsBytes(System.Int64)">
<summary>
Converts a <see cref="T:System.Int64"/> value into a byte array.
</summary>
<param name="value">Value to convert.</param>
<returns>Byte array representation of the value.</returns>
</member>
<member name="M:SweetLib.Utils.Extensions.BaseTypeExtensions.AsBytes(System.UInt64)">
<summary>
Converts a <see cref="T:System.UInt64"/> value into a byte array.
</summary>
<param name="value">Value to convert.</param>
<returns>Byte array representation of the value.</returns>
</member>
<member name="M:SweetLib.Utils.Extensions.BaseTypeExtensions.AsBytes(System.Single)">
<summary>
Converts a <see cref="T:System.Single"/> value into a byte array.
</summary>
<param name="value">Value to convert.</param>
<returns>Byte array representation of the value.</returns>
</member>
<member name="M:SweetLib.Utils.Extensions.BaseTypeExtensions.AsBytes(System.Double)">
<summary>
Converts a <see cref="T:System.Double"/> value into a byte array.
</summary>
<param name="value">Value to convert.</param>
<returns>Byte array representation of the value.</returns>
</member>
<member name="M:SweetLib.Utils.Extensions.BaseTypeExtensions.AsBytes(System.Boolean)">
<summary>
Converts a <see cref="T:System.Boolean"/> value into a byte array.
</summary>
<param name="value">Value to convert.</param>
<returns>Byte array representation of the value.</returns>
</member>
<member name="M:SweetLib.Utils.Extensions.BaseTypeExtensions.AsBytes(System.DateTime)">
<summary>
Converts a <see cref="T:System.DateTime"/> value into a byte array.
</summary>
<param name="value">Value to convert.</param>
<returns>Byte array representation of the value.</returns>
</member>
<member name="M:SweetLib.Utils.Extensions.BaseTypeExtensions.AsBytes(System.String)">
<summary>
Converts a <see cref="T:System.String"/> value into a byte array.
</summary>
<param name="value">Value to convert.</param>
<returns>Byte array representation of the value.</returns>
<remarks>Using <see cref="T:System.Text.UTF32Encoding"/> for converting.</remarks>
</member>
<member name="M:SweetLib.Utils.Extensions.BaseTypeExtensions.AsBytes(System.Char)">
<summary>
Converts a <see cref="T:System.Char"/> value into a byte array.
</summary>
<param name="value">Value to convert.</param>
<returns>Byte array representation of the value.</returns>
</member>
<member name="M:SweetLib.Utils.Extensions.BaseTypeExtensions.AsInt16(System.Byte[])">
<summary>
Converts a byte array into a <see cref="T:System.Int16"/> type.
</summary>
<param name="bytes">Byte array representation to convert.</param>
<returns>Converted value.</returns>
</member>
<member name="M:SweetLib.Utils.Extensions.BaseTypeExtensions.AsUInt16(System.Byte[])">
<summary>
Converts a byte array into a <see cref="T:System.UInt16"/> type.
</summary>
<param name="bytes">Byte array representation to convert.</param>
<returns>Converted value.</returns>
</member>
<member name="M:SweetLib.Utils.Extensions.BaseTypeExtensions.AsInt32(System.Byte[])">
<summary>
Converts a byte array into a <see cref="T:System.Int32"/> type.
</summary>
<param name="bytes">Byte array representation to convert.</param>
<returns>Converted value.</returns>
</member>
<member name="M:SweetLib.Utils.Extensions.BaseTypeExtensions.AsUInt32(System.Byte[])">
<summary>
Converts a byte array into a <see cref="T:System.UInt32"/> type.
</summary>
<param name="bytes">Byte array representation to convert.</param>
<returns>Converted value.</returns>
</member>
<member name="M:SweetLib.Utils.Extensions.BaseTypeExtensions.AsInt64(System.Byte[])">
<summary>
Converts a byte array into a <see cref="T:System.Int64"/> type.
</summary>
<param name="bytes">Byte array representation to convert.</param>
<returns>Converted value.</returns>
</member>
<member name="M:SweetLib.Utils.Extensions.BaseTypeExtensions.AsUInt64(System.Byte[])">
<summary>
Converts a byte array into a <see cref="T:System.UInt64"/> type.
</summary>
<param name="bytes">Byte array representation to convert.</param>
<returns>Converted value.</returns>
</member>
<member name="M:SweetLib.Utils.Extensions.BaseTypeExtensions.AsSingle(System.Byte[])">
<summary>
Converts a byte array into a <see cref="T:System.Single"/> type.
</summary>
<param name="bytes">Byte array representation to convert.</param>
<returns>Converted value.</returns>
</member>
<member name="M:SweetLib.Utils.Extensions.BaseTypeExtensions.AsDouble(System.Byte[])">
<summary>
Converts a byte array into a <see cref="T:System.Double"/> type.
</summary>
<param name="bytes">Byte array representation to convert.</param>
<returns>Converted value.</returns>
</member>
<member name="M:SweetLib.Utils.Extensions.BaseTypeExtensions.AsBool(System.Byte[])">
<summary>
Converts a byte array into a <see cref="T:System.Boolean"/> type.
</summary>
<param name="bytes">Byte array representation to convert.</param>
<returns>Converted value.</returns>
</member>
<member name="M:SweetLib.Utils.Extensions.BaseTypeExtensions.AsDateTime(System.Byte[])">
<summary>
Converts a byte array into a <see cref="T:System.DateTime"/> type.
</summary>
<param name="bytes">Byte array representation to convert.</param>
<returns>Converted value.</returns>
</member>
<member name="M:SweetLib.Utils.Extensions.BaseTypeExtensions.AsString(System.Byte[])">
<summary>
Converts a byte array into a <see cref="T:System.String"/> type.
</summary>
<param name="bytes">Byte array representation to convert.</param>
<returns>Converted value.</returns>
<remarks>Using <see cref="T:System.Text.UTF32Encoding"/> for converting.</remarks>
</member>
<member name="M:SweetLib.Utils.Extensions.BaseTypeExtensions.AsChar(System.Byte[])">
<summary>
Converts a byte array into a <see cref="T:System.Char"/> type.
</summary>
<param name="bytes">Byte array representation to convert.</param>
<returns>Converted value.</returns>
</member>
<member name="T:SweetLib.Utils.Extensions.DateTimeExtensions">
<summary>
Defines extensions to classes which are related to <see cref="T:System.DateTime"/>.
</summary>
</member>
<member name="M:SweetLib.Utils.Extensions.DateTimeExtensions.ToUnixTimeStamp(System.DateTime)">
<summary>
Converts a <see cref="T:System.DateTime"/> into an Unix timestamp.
</summary>
<param name="date"><see cref="T:System.DateTime"/> to convert into Unix timestamp.</param>
<returns>Converted Unix timestamp.</returns>
</member>
<member name="M:SweetLib.Utils.Extensions.DateTimeExtensions.ToDateTime(System.Double)">
<summary>
Converts an Unix timestamp into a <see cref="T:System.DateTime"/>.
</summary>
<param name="timestamp">Unix timestamp to convert.</param>
<returns>Converted <see cref="T:System.DateTime"/>.</returns>
</member>
<member name="T:SweetLib.Utils.Logger.LogLevel">
<summary>
Enum which contains the several log levels.
</summary>
</member>
<member name="T:SweetLib.Utils.Logger.Logger">
<summary>
Global logger class providing several methods to log events by the application.
</summary>
<remarks>
As <see cref="P:SweetLib.Utils.Logger.Logger.DefaultLogMemory"/> a <see cref="T:SweetLib.Utils.Logger.Memory.ArchivableConsoleLogMemory"/> will be used. You can change this to any other implementation at any time while runtime.
Default log levels are set as bitflags in <see cref="P:SweetLib.Utils.Logger.Logger.GlobalLogLevel"/>.
</remarks>
</member>
<member name="P:SweetLib.Utils.Logger.Logger.GlobalLogLevel">
<summary>
The global log level. Only messages with the set <see cref="T:SweetLib.Utils.Logger.LogLevel"/> will be procedered.
</summary>
</member>
<member name="P:SweetLib.Utils.Logger.Logger.DefaultLogMemory">
<summary>
The default <see cref="T:SweetLib.Utils.Logger.Memory.ILogMemory"/> which will be used for any logging action, if no custom <see cref="T:SweetLib.Utils.Logger.Memory.ILogMemory"/> is set as parameter.
</summary>
</member>
<member name="M:SweetLib.Utils.Logger.Logger.Log(SweetLib.Utils.Logger.LogLevel,System.String)">
<summary>
Will log a message into the global <see cref="P:SweetLib.Utils.Logger.Logger.DefaultLogMemory"/>.
</summary>
<param name="logLevel">The log level of this message.</param>
<param name="message">The message to log.</param>
</member>
<member name="M:SweetLib.Utils.Logger.Logger.Log(SweetLib.Utils.Logger.LogLevel,System.String,SweetLib.Utils.Logger.Memory.ILogMemory)">
<summary>
Will log a message into the provided <see cref="!:logMemory"/>.
</summary>
<param name="logLevel">The log level of this message.</param>
/// <param name="message">The message to log.</param>
<param name="logMemory">The <see cref="T:SweetLib.Utils.Logger.Memory.ILogMemory"/> to store the <see cref="!:message"/> into.</param>
</member>
<member name="M:SweetLib.Utils.Logger.Logger.Log(SweetLib.Utils.Logger.Message.LogMessage,SweetLib.Utils.Logger.Memory.ILogMemory)">
<summary>
Will log a message into the provided <see cref="!:logMemory"/>.
</summary>
<param name="message">A <see cref="T:SweetLib.Utils.Logger.Message.LogMessage"/> object to store.</param>
<param name="logMemory">The <see cref="T:SweetLib.Utils.Logger.Memory.ILogMemory"/> to store the <see cref="!:message"/> into.</param>
<remarks>In general use cases you should either use one of the <see cref="M:SweetLib.Utils.Logger.Logger.Log(SweetLib.Utils.Logger.LogLevel,System.String)"/> or <see cref="M:SweetLib.Utils.Logger.Logger.Log(SweetLib.Utils.Logger.LogLevel,System.String)"/> methods which will generate a call to this method.</remarks>
</member>
<member name="M:SweetLib.Utils.Logger.Logger.Trace(System.String)">
<summary>
Will log a message with the <see cref="F:SweetLib.Utils.Logger.LogLevel.Trace"/> log level.
</summary>
<param name="message">Message to log.</param>
</member>
<member name="M:SweetLib.Utils.Logger.Logger.Debug(System.String)">
<summary>
Will log a message with the <see cref="F:SweetLib.Utils.Logger.LogLevel.Debug"/> log level.
</summary>
<param name="message">Message to log.</param>
</member>
<member name="M:SweetLib.Utils.Logger.Logger.Info(System.String)">
<summary>
Will log a message with the <see cref="F:SweetLib.Utils.Logger.LogLevel.Info"/> log level.
</summary>
<param name="message">Message to log.</param>
</member>
<member name="M:SweetLib.Utils.Logger.Logger.Warn(System.String)">
<summary>
Will log a message with the <see cref="F:SweetLib.Utils.Logger.LogLevel.Warn"/> log level.
</summary>
<param name="message">Message to log.</param>
</member>
<member name="M:SweetLib.Utils.Logger.Logger.Error(System.String)">
<summary>
Will log a message with the <see cref="F:SweetLib.Utils.Logger.LogLevel.Error"/> log level.
</summary>
<param name="message">Message to log.</param>
</member>
<member name="T:SweetLib.Utils.Logger.Memory.ILogMemory">
<summary>
Interface for a class to store and proceed <see cref="T:SweetLib.Utils.Logger.Message.LogMessage"/> objects.
</summary>
</member>
<member name="M:SweetLib.Utils.Logger.Memory.ILogMemory.Remember(SweetLib.Utils.Logger.Message.LogMessage)">
<summary>
Adds a <see cref="!:message"/> into the <see cref="T:SweetLib.Utils.Logger.Memory.ILogMemory"/>.
</summary>
<param name="message"><see cref="T:SweetLib.Utils.Logger.Message.LogMessage"/> to be stored.</param>
</member>
<member name="M:SweetLib.Utils.Logger.Memory.ILogMemory.Forget(SweetLib.Utils.Logger.Message.LogMessage)">
<summary>
Removes a <see cref="!:message"/> from the <see cref="T:SweetLib.Utils.Logger.Memory.ILogMemory"/>.
</summary>
<param name="message"><see cref="T:SweetLib.Utils.Logger.Message.LogMessage"/> to be removed.</param>
<remarks>This might not have any effect depending on the <see cref="T:SweetLib.Utils.Logger.Memory.ILogMemory"/> implementation.</remarks>
</member>
<member name="M:SweetLib.Utils.Logger.Memory.ILogMemory.Archive(System.String)">
<summary>
Saves all remembered <see cref="T:SweetLib.Utils.Logger.Message.LogMessage"/> objects into a persistent file.
</summary>
<param name="fullFileName">File name to store the <see cref="T:SweetLib.Utils.Logger.Message.LogMessage"/> objects.</param>
</member>
<member name="T:SweetLib.Utils.Logger.Message.LogMessage">
<summary>
<see cref="T:SweetLib.Utils.Logger.Message.LogMessage"/> contains all event log data which should be logged in as a single log message.
</summary>
</member>
<member name="P:SweetLib.Utils.Logger.Message.LogMessage.LogLevel">
<summary>
The <see cref="P:SweetLib.Utils.Logger.Message.LogMessage.LogLevel"/> of this event log.
</summary>
</member>
<member name="P:SweetLib.Utils.Logger.Message.LogMessage.Message">
<summary>
The message of this event log.
</summary>
</member>
<member name="P:SweetLib.Utils.Logger.Message.LogMessage.LogDateTime">
<summary>
The date and time of this event log.
</summary>
</member>
<member name="M:SweetLib.Utils.Logger.Message.LogMessage.#ctor(SweetLib.Utils.Logger.LogLevel,System.String)">
<summary>
Creates a new <see cref="T:SweetLib.Utils.Logger.Message.LogMessage"/> instance. <see cref="P:System.DateTime.Now"/> will be the <see cref="P:SweetLib.Utils.Logger.Message.LogMessage.LogDateTime"/>.
</summary>
<param name="logLevel">The log level of this event log.</param>
<param name="message">The message of this event log.</param>
</member>
<member name="M:SweetLib.Utils.Logger.Message.LogMessage.#ctor(SweetLib.Utils.Logger.LogLevel,System.String,System.DateTime)">
<summary>
Creates a new <see cref="T:SweetLib.Utils.Logger.Message.LogMessage"/> instance.
</summary>
<param name="logLevel">The log level of this event log.</param>
<param name="message">The message of this event log.</param>
<param name="logDateTime">The <see cref="T:System.DateTime"/> of this event log.</param>
</member>
<member name="M:SweetLib.Utils.Logger.Message.LogMessage.ToString">
<summary>
Generates a formatted <see cref="T:System.String"/> of this event log. <see cref="P:SweetLib.Utils.Logger.Message.LogMessageFormatter.DefaultFormatString"/> will be used to format this event log.
</summary>
<returns>A formated <see cref="T:System.String"/> of this event log.</returns>
</member>
<member name="M:SweetLib.Utils.Logger.Message.LogMessage.ToString(System.String,System.IFormatProvider)">
<summary>
Generates a formatted <see cref="T:System.String"/> of this event log with a given format.
</summary>
<param name="format">The format to be used. See <see cref="T:SweetLib.Utils.Logger.Message.LogMessageFormatter"/> for more format information.</param>
<param name="formatProvider">Optional, an <see cref="T:System.IFormatProvider"/> interface to be used while formatting if needed.</param>
<returns>A formated <see cref="T:System.String"/> of this event log.</returns>
</member>
<member name="T:SweetLib.Utils.Logger.Message.LogMessageFormatter">
<summary>
A <see cref="T:System.ICustomFormatter"/> which is used to format <see cref="T:SweetLib.Utils.Logger.Message.LogMessage"/> objects.
</summary>
<remarks>This class implements a singleton pattern.</remarks>
</member>
<member name="P:SweetLib.Utils.Logger.Message.LogMessageFormatter.FormatterInstance">
<summary>
Accesses the global instance of the <see cref="T:SweetLib.Utils.Logger.Message.LogMessageFormatter"/>.
</summary>
</member>
<member name="P:SweetLib.Utils.Logger.Message.LogMessageFormatter.Instance">
<summary>
The default format string which is used to format <see cref="T:SweetLib.Utils.Logger.Message.LogMessage"/> objects, if no custom format string is provided.
</summary>
</member>
<member name="M:SweetLib.Utils.Logger.Message.LogMessageFormatter.Format(System.String,System.Object,System.IFormatProvider)">
<summary>
Formats a <see cref="T:SweetLib.Utils.Logger.Message.LogMessage"/> object.
</summary>
<param name="format">The format string. If <see cref="!:null"/>, <see cref="P:SweetLib.Utils.Logger.Message.LogMessageFormatter.DefaultFormatString"/> will be used.</param>
<param name="arg">The <see cref="T:SweetLib.Utils.Logger.Message.LogMessage"/> object to be formatted.</param>
<param name="formatProvider">Optional, an <see cref="T:System.IFormatProvider"/> interface to be used while formatting if needed.</param>
<returns>A formatted <see cref="T:System.String"/> of the <see cref="T:SweetLib.Utils.Logger.Message.LogMessage"/>.</returns>
<remarks>
If <see cref="!:arg"/> is not a <see cref="T:SweetLib.Utils.Logger.Message.LogMessage"/> object, it will either be returned the formatted string implemented by the type of <see cref="!:arg"/>, if <see cref="T:System.IFormattable"/> is implemented by it, or the <see cref="!:arg.ToString()"/> result."
</remarks>
</member>
<member name="T:SweetLib.Utils.SweetUtils">
<summary>
A generic class containing useful methods.
</summary>
</member>
<member name="M:SweetLib.Utils.SweetUtils.LegalizeFilename(System.String)">
<summary>
Legalizes a file name with the <see cref="P:SweetLib.Utils.SweetUtils.DefaultFileNameReplaceChar"/> character.
</summary>
<param name="fileName">File name to legalize.</param>
<returns>Legalized file name.</returns>
</member>
<member name="M:SweetLib.Utils.SweetUtils.LegalizeFilename(System.String,System.Char)">
<summary>
Legalizes a file name by a given replace character.
</summary>
<param name="fileName">File name to legalize.</param>
<param name="replaceChar">Character to be used as replace character.</param>
<returns>Legalized file name.</returns>
</member>
</members>
</doc>

5
SweetLib.IO/Classes/Streaming/StreamManager.cs
View file

@ -58,9 +58,7 @@ namespace SweetLib.IO.Classes.Streaming
private static byte[] LoadFromStream(Stream stream, StreamedObjectType type)
{
long length;
LoadMetaDataFromStream(stream, out StreamedObjectType foundType, out length);
LoadMetaDataFromStream(stream, out StreamedObjectType foundType, out long length);
if (foundType != type)
throw new StreamTypeException($"Expected {type} but found {foundType} instead.");
@ -156,6 +154,7 @@ namespace SweetLib.IO.Classes.Streaming
/// </summary>
/// <param name="stream"><see cref="Stream"/> to which the <see cref="Stream"/> will be added.</param>
/// <param name="value"><see cref="Stream"/> value to add.</param>
/// <param name="resetSourceStream">If true, the full given <see cref="value"/> will be copied, otherwhise the stream will be copied from current position until its end.</param>
public static void SaveToStream(Stream stream, Stream value, bool resetSourceStream = false)
{
if (resetSourceStream)

3
SweetLib.IO/SweetLib.IO.csproj
View file

@ -20,7 +20,8 @@
</PropertyGroup>
<ItemGroup>
<ProjectReference Include="..\SweetLib\SweetLib.csproj" />
<PackageReference Include="SweetLib" Version="0.2.1-alpha" />
<PackageReference Include="Vsxmd" Version="1.2.0" />
</ItemGroup>
</Project>

3
SweetLib/Classes/Storer/IniFileStorer.cs
View file

@ -37,8 +37,7 @@ namespace SweetLib.Classes.Storer
public int ReadInteger(string section, string key, int defaultValue = 0)
{
int result;
if (!int.TryParse(ReadString(section, key, defaultValue.ToString()), out result))
if (!int.TryParse(ReadString(section, key, defaultValue.ToString()), out int result))
result = defaultValue;
return result;

3
SweetLib/Classes/Storer/RegistryStorer.cs
View file

@ -47,8 +47,7 @@ namespace SweetLib.Classes.Storer
public int ReadInteger(string section, string key, int defaultValue = 0)
{
int result;
if (!int.TryParse(ReadString(section, key, defaultValue.ToString()), out result))
if (!int.TryParse(ReadString(section, key, defaultValue.ToString()), out int result))
result = defaultValue;
return result;

5
SweetLib/SweetLib.csproj
View file

@ -2,11 +2,11 @@
<PropertyGroup>
<TargetFramework>netstandard1.3</TargetFramework>
<Version>0.2.0-alpha</Version>
<Version>0.2.1-alpha</Version>
<Description>Sweet collection of helpful utils in .Net</Description>
<Authors>Serraniel</Authors>
<Company />
<Copyright>Copyright © 2017 by Serraniel</Copyright>
<Copyright>Copyright © 2017-2018 by Serraniel</Copyright>
<PackageLicenseUrl>https://joinup.ec.europa.eu/page/eupl-text-11-12</PackageLicenseUrl>
<PackageProjectUrl>https://github.com/Serraniel/SweetLib</PackageProjectUrl>
<RepositoryUrl>https://github.com/Serraniel/SweetLib</RepositoryUrl>
@ -21,6 +21,7 @@
<ItemGroup>
<PackageReference Include="Microsoft.Win32.Registry" Version="4.3.0" />
<PackageReference Include="Vsxmd" Version="1.2.0" />
</ItemGroup>
</Project>

6
SweetLib/Utils/Logger/Memory/ArchivableConsoleLogMemory.cs
View file

@ -60,8 +60,7 @@ namespace SweetLib.Utils.Logger.Memory
{
while (!LogQueue.IsEmpty)
{
LogMessage message;
if (LogQueue.TryDequeue(out message))
if (LogQueue.TryDequeue(out LogMessage message))
File.AppendAllText(TempFile, message.ToString() + Environment.NewLine);
}
}
@ -70,8 +69,7 @@ namespace SweetLib.Utils.Logger.Memory
{
while (!LogQueue.IsEmpty)
{
LogMessage message;
if (LogQueue.TryDequeue(out message))
if (LogQueue.TryDequeue(out LogMessage message))
File.AppendAllText(TempFile, message.ToString() + Environment.NewLine);
}
}