Update nuget + fix riferimento SloCheetah x ADB
This commit is contained in:
Samuele Locatelli
@@ -55,8 +55,17 @@
|
||||
<Reference Include="Google.Protobuf, Version=3.11.4.0, Culture=neutral, PublicKeyToken=a7d26565bac4d604, processorArchitecture=MSIL">
|
||||
<HintPath>..\packages\Google.Protobuf.3.11.4\lib\net45\Google.Protobuf.dll</HintPath>
|
||||
</Reference>
|
||||
<Reference Include="MySql.Data, Version=8.0.19.0, Culture=neutral, PublicKeyToken=c5687fc88969c44d, processorArchitecture=MSIL">
|
||||
<HintPath>..\packages\MySql.Data.8.0.19\lib\net452\MySql.Data.dll</HintPath>
|
||||
<Reference Include="K4os.Compression.LZ4, Version=1.1.11.0, Culture=neutral, PublicKeyToken=2186fa9121ef231d, processorArchitecture=MSIL">
|
||||
<HintPath>..\packages\K4os.Compression.LZ4.1.1.11\lib\net46\K4os.Compression.LZ4.dll</HintPath>
|
||||
</Reference>
|
||||
<Reference Include="K4os.Compression.LZ4.Streams, Version=1.1.11.0, Culture=neutral, PublicKeyToken=2186fa9121ef231d, processorArchitecture=MSIL">
|
||||
<HintPath>..\packages\K4os.Compression.LZ4.Streams.1.1.11\lib\net46\K4os.Compression.LZ4.Streams.dll</HintPath>
|
||||
</Reference>
|
||||
<Reference Include="K4os.Hash.xxHash, Version=1.0.6.0, Culture=neutral, PublicKeyToken=32cd54395057cec3, processorArchitecture=MSIL">
|
||||
<HintPath>..\packages\K4os.Hash.xxHash.1.0.6\lib\net46\K4os.Hash.xxHash.dll</HintPath>
|
||||
</Reference>
|
||||
<Reference Include="MySql.Data, Version=8.0.20.0, Culture=neutral, PublicKeyToken=c5687fc88969c44d, processorArchitecture=MSIL">
|
||||
<HintPath>..\packages\MySql.Data.8.0.20\lib\net452\MySql.Data.dll</HintPath>
|
||||
</Reference>
|
||||
<Reference Include="Newtonsoft.Json, Version=12.0.0.0, Culture=neutral, PublicKeyToken=30ad4fe6b2a6aeed, processorArchitecture=MSIL">
|
||||
<HintPath>..\packages\Newtonsoft.Json.12.0.3\lib\net45\Newtonsoft.Json.dll</HintPath>
|
||||
@@ -102,7 +111,10 @@
|
||||
<Reference Include="System.Windows.Forms" />
|
||||
<Reference Include="System.Xml" />
|
||||
<Reference Include="Ubiety.Dns.Core, Version=2.2.1.0, Culture=neutral, PublicKeyToken=c5687fc88969c44d, processorArchitecture=MSIL">
|
||||
<HintPath>..\packages\MySql.Data.8.0.19\lib\net452\Ubiety.Dns.Core.dll</HintPath>
|
||||
<HintPath>..\packages\MySql.Data.8.0.20\lib\net452\Ubiety.Dns.Core.dll</HintPath>
|
||||
</Reference>
|
||||
<Reference Include="Zstandard.Net, Version=1.1.7.0, Culture=neutral, PublicKeyToken=c5687fc88969c44d, processorArchitecture=MSIL">
|
||||
<HintPath>..\packages\MySql.Data.8.0.20\lib\net452\Zstandard.Net.dll</HintPath>
|
||||
</Reference>
|
||||
</ItemGroup>
|
||||
<ItemGroup>
|
||||
@@ -200,11 +212,11 @@
|
||||
</ItemGroup>
|
||||
<Move SourceFiles="@(MoveToLibFolder)" DestinationFolder="$(OutputPath)lib" OverwriteReadOnlyFiles="true" />
|
||||
</Target>
|
||||
<Import Project="..\packages\SlowCheetah.2.5.48\build\SlowCheetah.targets" Condition="Exists('..\packages\SlowCheetah.2.5.48\build\SlowCheetah.targets')" />
|
||||
<Import Project="..\packages\Microsoft.VisualStudio.SlowCheetah.3.2.26\build\SlowCheetah.targets" Condition="Exists('..\packages\Microsoft.VisualStudio.SlowCheetah.3.2.26\build\SlowCheetah.targets')" />
|
||||
<Target Name="EnsureNuGetPackageBuildImports" BeforeTargets="PrepareForBuild">
|
||||
<PropertyGroup>
|
||||
<ErrorText>Questo progetto fa riferimento a uno o più pacchetti NuGet che non sono presenti in questo computer. Usare lo strumento di ripristino dei pacchetti NuGet per scaricarli. Per altre informazioni, vedere http://go.microsoft.com/fwlink/?LinkID=322105. Il file mancante è {0}.</ErrorText>
|
||||
</PropertyGroup>
|
||||
<Error Condition="!Exists('..\packages\SlowCheetah.2.5.48\build\SlowCheetah.targets')" Text="$([System.String]::Format('$(ErrorText)', '..\packages\SlowCheetah.2.5.48\build\SlowCheetah.targets'))" />
|
||||
<Error Condition="!Exists('..\packages\Microsoft.VisualStudio.SlowCheetah.3.2.26\build\SlowCheetah.targets')" Text="$([System.String]::Format('$(ErrorText)', '..\packages\Microsoft.VisualStudio.SlowCheetah.3.2.26\build\SlowCheetah.targets'))" />
|
||||
</Target>
|
||||
</Project>
|
||||
@@ -2,7 +2,10 @@
|
||||
<packages>
|
||||
<package id="BouncyCastle" version="1.8.6.1" targetFramework="net462" />
|
||||
<package id="Google.Protobuf" version="3.11.4" targetFramework="net462" />
|
||||
<package id="MySql.Data" version="8.0.19" targetFramework="net462" />
|
||||
<package id="K4os.Compression.LZ4" version="1.1.11" targetFramework="net462" />
|
||||
<package id="K4os.Compression.LZ4.Streams" version="1.1.11" targetFramework="net462" />
|
||||
<package id="K4os.Hash.xxHash" version="1.0.6" targetFramework="net462" />
|
||||
<package id="MySql.Data" version="8.0.20" targetFramework="net462" />
|
||||
<package id="Newtonsoft.Json" version="12.0.3" targetFramework="net452" />
|
||||
<package id="NLog" version="4.7.0" targetFramework="net452" />
|
||||
<package id="NLog.Schema" version="4.7.0" targetFramework="net452" />
|
||||
|
||||
@@ -33,7 +33,7 @@
|
||||
</PropertyGroup>
|
||||
<ItemGroup>
|
||||
<Reference Include="Microsoft.Bcl.AsyncInterfaces, Version=1.0.0.0, Culture=neutral, PublicKeyToken=cc7b13ffcd2ddd51, processorArchitecture=MSIL">
|
||||
<HintPath>..\packages\Microsoft.Bcl.AsyncInterfaces.1.1.0\lib\net461\Microsoft.Bcl.AsyncInterfaces.dll</HintPath>
|
||||
<HintPath>..\packages\Microsoft.Bcl.AsyncInterfaces.1.1.1\lib\net461\Microsoft.Bcl.AsyncInterfaces.dll</HintPath>
|
||||
</Reference>
|
||||
<Reference Include="Newtonsoft.Json, Version=12.0.0.0, Culture=neutral, PublicKeyToken=30ad4fe6b2a6aeed, processorArchitecture=MSIL">
|
||||
<HintPath>..\packages\Newtonsoft.Json.12.0.3\lib\net45\Newtonsoft.Json.dll</HintPath>
|
||||
@@ -42,7 +42,7 @@
|
||||
<HintPath>..\packages\NLog.4.7.0\lib\net45\NLog.dll</HintPath>
|
||||
</Reference>
|
||||
<Reference Include="Pipelines.Sockets.Unofficial, Version=1.0.0.0, Culture=neutral, PublicKeyToken=42ea0a778e13fbe2, processorArchitecture=MSIL">
|
||||
<HintPath>..\packages\Pipelines.Sockets.Unofficial.2.1.8\lib\net461\Pipelines.Sockets.Unofficial.dll</HintPath>
|
||||
<HintPath>..\packages\Pipelines.Sockets.Unofficial.2.1.11\lib\net461\Pipelines.Sockets.Unofficial.dll</HintPath>
|
||||
</Reference>
|
||||
<Reference Include="StackExchange.Redis, Version=2.0.0.0, Culture=neutral, PublicKeyToken=c219ff1ca8c2ce46, processorArchitecture=MSIL">
|
||||
<HintPath>..\packages\StackExchange.Redis.2.1.30\lib\net461\StackExchange.Redis.dll</HintPath>
|
||||
@@ -58,7 +58,7 @@
|
||||
</Reference>
|
||||
<Reference Include="System.IO.Compression" />
|
||||
<Reference Include="System.IO.Pipelines, Version=4.0.2.1, Culture=neutral, PublicKeyToken=cc7b13ffcd2ddd51, processorArchitecture=MSIL">
|
||||
<HintPath>..\packages\System.IO.Pipelines.4.7.1\lib\netstandard2.0\System.IO.Pipelines.dll</HintPath>
|
||||
<HintPath>..\packages\System.IO.Pipelines.4.7.2\lib\net461\System.IO.Pipelines.dll</HintPath>
|
||||
</Reference>
|
||||
<Reference Include="System.Memory, Version=4.0.1.1, Culture=neutral, PublicKeyToken=cc7b13ffcd2ddd51, processorArchitecture=MSIL">
|
||||
<HintPath>..\packages\System.Memory.4.5.4\lib\net461\System.Memory.dll</HintPath>
|
||||
@@ -73,7 +73,7 @@
|
||||
<Reference Include="System.Runtime.Serialization" />
|
||||
<Reference Include="System.ServiceModel" />
|
||||
<Reference Include="System.Threading.Channels, Version=4.0.2.0, Culture=neutral, PublicKeyToken=cc7b13ffcd2ddd51, processorArchitecture=MSIL">
|
||||
<HintPath>..\packages\System.Threading.Channels.4.7.0\lib\netstandard2.0\System.Threading.Channels.dll</HintPath>
|
||||
<HintPath>..\packages\System.Threading.Channels.4.7.1\lib\net461\System.Threading.Channels.dll</HintPath>
|
||||
</Reference>
|
||||
<Reference Include="System.Threading.Tasks.Extensions, Version=4.2.0.1, Culture=neutral, PublicKeyToken=cc7b13ffcd2ddd51, processorArchitecture=MSIL">
|
||||
<HintPath>..\packages\System.Threading.Tasks.Extensions.4.5.4\lib\net461\System.Threading.Tasks.Extensions.dll</HintPath>
|
||||
|
||||
@@ -1,17 +1,17 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<packages>
|
||||
<package id="Microsoft.Bcl.AsyncInterfaces" version="1.1.0" targetFramework="net462" />
|
||||
<package id="Microsoft.Bcl.AsyncInterfaces" version="1.1.1" targetFramework="net462" />
|
||||
<package id="Newtonsoft.Json" version="12.0.3" targetFramework="net452" />
|
||||
<package id="NLog" version="4.7.0" targetFramework="net452" />
|
||||
<package id="NLog.Schema" version="4.7.0" targetFramework="net452" />
|
||||
<package id="Pipelines.Sockets.Unofficial" version="2.1.8" targetFramework="net462" />
|
||||
<package id="Pipelines.Sockets.Unofficial" version="2.1.11" targetFramework="net462" />
|
||||
<package id="StackExchange.Redis" version="2.1.30" targetFramework="net462" />
|
||||
<package id="System.Buffers" version="4.5.1" targetFramework="net462" />
|
||||
<package id="System.Diagnostics.PerformanceCounter" version="4.7.0" targetFramework="net462" />
|
||||
<package id="System.IO.Pipelines" version="4.7.1" targetFramework="net462" />
|
||||
<package id="System.IO.Pipelines" version="4.7.2" targetFramework="net462" />
|
||||
<package id="System.Memory" version="4.5.4" targetFramework="net462" />
|
||||
<package id="System.Numerics.Vectors" version="4.5.0" targetFramework="net462" />
|
||||
<package id="System.Runtime.CompilerServices.Unsafe" version="4.7.1" targetFramework="net462" />
|
||||
<package id="System.Threading.Channels" version="4.7.0" targetFramework="net462" />
|
||||
<package id="System.Threading.Channels" version="4.7.1" targetFramework="net462" />
|
||||
<package id="System.Threading.Tasks.Extensions" version="4.5.4" targetFramework="net462" />
|
||||
</packages>
|
||||
BIN
Binary file not shown.
BIN
Binary file not shown.
BIN
Binary file not shown.
+794
@@ -0,0 +1,794 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>K4os.Compression.LZ4</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:K4os.Compression.LZ4.Encoders.EncoderAction">
|
||||
<summary>
|
||||
Action performed by encoder using <c>FlushAndEncode</c> method.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Encoders.EncoderAction.None">
|
||||
<summary>Nothing has happened, most likely loading 0 bytes.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Encoders.EncoderAction.Loaded">
|
||||
<summary>Some bytes has been loaded into encoder.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Encoders.EncoderAction.Copied">
|
||||
<summary>Compression was not possible so bytes has been copied.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Encoders.EncoderAction.Encoded">
|
||||
<summary>Compression succeeded.</summary>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Encoders.ILZ4Decoder">
|
||||
<summary>
|
||||
Interface of LZ4 decoder used by LZ4 streams.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Encoders.ILZ4Decoder.BlockSize">
|
||||
<summary>Block size.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Encoders.ILZ4Decoder.BytesReady">
|
||||
<summary>Bytes already decoded and available to be read.
|
||||
Always smaller than <see cref="P:K4os.Compression.LZ4.Encoders.ILZ4Decoder.BlockSize"/></summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.ILZ4Decoder.Decode(System.Byte*,System.Int32,System.Int32)">
|
||||
<summary>
|
||||
Decodes previously compressed block and caches decompressed block in decoder.
|
||||
Returns number of bytes decoded. These bytes can be read with <see cref="M:K4os.Compression.LZ4.Encoders.ILZ4Decoder.Drain(System.Byte*,System.Int32,System.Int32)" />.
|
||||
</summary>
|
||||
<param name="source">Points to compressed block.</param>
|
||||
<param name="length">Length of compressed block.</param>
|
||||
<param name="blockSize">Size of the block. Value <c>0</c> indicates default block size.</param>
|
||||
<returns>Number of decoded bytes.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.ILZ4Decoder.Inject(System.Byte*,System.Int32)">
|
||||
<summary>
|
||||
Inject already decompressed block and caches it in decoder.
|
||||
Used with uncompressed-yet-chained blocks and pre-made dictionaries.
|
||||
These bytes can be read with <see cref="M:K4os.Compression.LZ4.Encoders.ILZ4Decoder.Drain(System.Byte*,System.Int32,System.Int32)" />.
|
||||
</summary>
|
||||
<param name="source">Points to uncompressed block.</param>
|
||||
<param name="length">Length of uncompressed block.</param>
|
||||
<returns>Number of decoded bytes.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.ILZ4Decoder.Drain(System.Byte*,System.Int32,System.Int32)">
|
||||
<summary>
|
||||
Reads previously decoded bytes. Please note, <paramref name="offset"/> should be
|
||||
negative number, pointing to bytes before current head.
|
||||
</summary>
|
||||
<param name="target">Buffer to write to.</param>
|
||||
<param name="offset">Offset in source buffer relatively to current head.
|
||||
Please note, it should be negative value.</param>
|
||||
<param name="length">Number of bytes to read.</param>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Encoders.ILZ4Encoder">
|
||||
<summary>
|
||||
Interface of LZ4 encoder used by LZ4 streams.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Encoders.ILZ4Encoder.BlockSize">
|
||||
<summary>Block size.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Encoders.ILZ4Encoder.BytesReady">
|
||||
<summary>Number of bytes read for compression.
|
||||
Always smaller than <see cref="P:K4os.Compression.LZ4.Encoders.ILZ4Encoder.BlockSize"/></summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.ILZ4Encoder.Topup(System.Byte*,System.Int32)">
|
||||
<summary>Adds bytes to internal buffer. Increases <see cref="P:K4os.Compression.LZ4.Encoders.ILZ4Encoder.BytesReady"/></summary>
|
||||
<param name="source">Source buffer.</param>
|
||||
<param name="length">Source buffer length.</param>
|
||||
<returns>Number of bytes topped up. If this function returns 0 it means that buffer
|
||||
is full (<see cref="P:K4os.Compression.LZ4.Encoders.ILZ4Encoder.BytesReady"/> equals <see cref="P:K4os.Compression.LZ4.Encoders.ILZ4Encoder.BlockSize"/>) and
|
||||
<see cref="M:K4os.Compression.LZ4.Encoders.ILZ4Encoder.Encode(System.Byte*,System.Int32,System.Boolean)"/> should be called to flush it.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.ILZ4Encoder.Encode(System.Byte*,System.Int32,System.Boolean)">
|
||||
<summary>
|
||||
Encodes bytes in internal buffer (see: <see cref="P:K4os.Compression.LZ4.Encoders.ILZ4Encoder.BytesReady"/>, <see cref="M:K4os.Compression.LZ4.Encoders.ILZ4Encoder.Topup(System.Byte*,System.Int32)"/>).
|
||||
If <paramref name="allowCopy"/> is <c>true</c> then if encoded buffer is bigger than
|
||||
source buffer source bytes are copied instead. In such case returned length is negative.
|
||||
</summary>
|
||||
<param name="target">Target buffer.</param>
|
||||
<param name="length">Target buffer length.</param>
|
||||
<param name="allowCopy">Indicates if copying is allowed.</param>
|
||||
<returns>Length of encoded buffer. Negative if bytes are just copied.</returns>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Encoders.LZ4BlockDecoder">
|
||||
<summary>
|
||||
LZ4 decoder used with independent blocks mode. Plase note, that it will fail
|
||||
if input data has been compressed with chained blocks
|
||||
(<see cref="T:K4os.Compression.LZ4.Encoders.LZ4FastChainEncoder"/> and <see cref="T:K4os.Compression.LZ4.Encoders.LZ4HighChainEncoder"/>)
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Encoders.LZ4BlockDecoder.BlockSize">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Encoders.LZ4BlockDecoder.BytesReady">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4BlockDecoder.#ctor(System.Int32)">
|
||||
<summary>Creates new instance of block decoder.</summary>
|
||||
<param name="blockSize">Block size. Must be equal or greater to one used for compression.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4BlockDecoder.Decode(System.Byte*,System.Int32,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4BlockDecoder.Inject(System.Byte*,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4BlockDecoder.Drain(System.Byte*,System.Int32,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4BlockDecoder.ReleaseUnmanaged">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Encoders.LZ4BlockEncoder">
|
||||
<summary>
|
||||
Independent block encoder. Produces larger files but uses less memory and
|
||||
gives better performance.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4BlockEncoder.#ctor(K4os.Compression.LZ4.LZ4Level,System.Int32)">
|
||||
<summary>Creates new instance of <see cref="T:K4os.Compression.LZ4.Encoders.LZ4BlockEncoder"/></summary>
|
||||
<param name="level">Compression level.</param>
|
||||
<param name="blockSize">Block size.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4BlockEncoder.EncodeBlock(System.Byte*,System.Int32,System.Byte*,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4BlockEncoder.CopyDict(System.Byte*,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Encoders.LZ4ChainDecoder">
|
||||
<summary>LZ4 decoder handling dependent blocks.</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4ChainDecoder.#ctor(System.Int32,System.Int32)">
|
||||
<summary>Creates new instance of <see cref="T:K4os.Compression.LZ4.Encoders.LZ4ChainDecoder"/>.</summary>
|
||||
<param name="blockSize">Block size.</param>
|
||||
<param name="extraBlocks">Number of extra blocks.</param>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Encoders.LZ4ChainDecoder.BlockSize">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Encoders.LZ4ChainDecoder.BytesReady">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4ChainDecoder.Decode(System.Byte*,System.Int32,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4ChainDecoder.Inject(System.Byte*,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4ChainDecoder.Drain(System.Byte*,System.Int32,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4ChainDecoder.ReleaseUnmanaged">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Encoders.LZ4Decoder">
|
||||
<summary>
|
||||
Static class with factory methods to create LZ4 decoders.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4Decoder.Create(System.Boolean,System.Int32,System.Int32)">
|
||||
<summary>Creates appropriate decoder for given parameters.</summary>
|
||||
<param name="chaining">Dependent blocks.</param>
|
||||
<param name="blockSize">Block size.</param>
|
||||
<param name="extraBlocks">Number of extra blocks.</param>
|
||||
<returns>LZ4 decoder.</returns>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Encoders.LZ4Encoder">
|
||||
<summary>
|
||||
Static class with factory method to create LZ4 encoders.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4Encoder.Create(System.Boolean,K4os.Compression.LZ4.LZ4Level,System.Int32,System.Int32)">
|
||||
<summary>Creates appropriate decoder for given parameters.</summary>
|
||||
<param name="chaining">Dependent blocks.</param>
|
||||
<param name="level">Compression level.</param>
|
||||
<param name="blockSize">Block size.</param>
|
||||
<param name="extraBlocks">Number of extra blocks.</param>
|
||||
<returns>LZ4 encoder.</returns>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Encoders.LZ4EncoderBase">
|
||||
<summary>
|
||||
Base class for LZ4 encoders. Provides basic functionality shared by
|
||||
<see cref="T:K4os.Compression.LZ4.Encoders.LZ4BlockEncoder"/>, <see cref="T:K4os.Compression.LZ4.Encoders.LZ4FastChainEncoder"/>,
|
||||
and <see cref="T:K4os.Compression.LZ4.Encoders.LZ4HighChainEncoder"/> encoders. Do not used directly.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderBase.#ctor(System.Boolean,System.Int32,System.Int32)">
|
||||
<summary>Creates new instance of encoder.</summary>
|
||||
<param name="chaining">Needs to be <c>true</c> if using dependent blocks.</param>
|
||||
<param name="blockSize">Block size.</param>
|
||||
<param name="extraBlocks">Number of extra blocks.</param>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Encoders.LZ4EncoderBase.BlockSize">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Encoders.LZ4EncoderBase.BytesReady">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderBase.Topup(System.Byte*,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderBase.Encode(System.Byte*,System.Int32,System.Boolean)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderBase.EncodeBlock(System.Byte*,System.Int32,System.Byte*,System.Int32)">
|
||||
<summary>Encodes single block using appropriate algorithm.</summary>
|
||||
<param name="source">Source buffer.</param>
|
||||
<param name="sourceLength">Source buffer length.</param>
|
||||
<param name="target">Target buffer.</param>
|
||||
<param name="targetLength">Target buffer length.</param>
|
||||
<returns>Number of bytes actually written to target buffer.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderBase.CopyDict(System.Byte*,System.Int32)">
|
||||
<summary>Copies current dictionary.</summary>
|
||||
<param name="target">Target buffer.</param>
|
||||
<param name="dictionaryLength">Dictionary length.</param>
|
||||
<returns>Dictionary length.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderBase.ReleaseUnmanaged">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions">
|
||||
<summary>
|
||||
Functionality of encoders added on top of fixed interface.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.Topup(K4os.Compression.LZ4.Encoders.ILZ4Encoder,System.Byte*@,System.Int32)">
|
||||
<summary>Tops encoder up with some data.</summary>
|
||||
<param name="encoder">Encoder.</param>
|
||||
<param name="source">Buffer pointer, will be shifted after operation by the number of
|
||||
bytes actually loaded.</param>
|
||||
<param name="length">Length of buffer.</param>
|
||||
<returns><c>true</c> if buffer was topped up, <c>false</c> if no bytes were loaded.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.Topup(K4os.Compression.LZ4.Encoders.ILZ4Encoder,System.Byte[],System.Int32,System.Int32)">
|
||||
<summary>Tops encoder up with some data.</summary>
|
||||
<param name="encoder">Encoder.</param>
|
||||
<param name="source">Buffer.</param>
|
||||
<param name="offset">Buffer offset.</param>
|
||||
<param name="length">Length of buffer.</param>
|
||||
<returns>Number of bytes actually loaded.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.Topup(K4os.Compression.LZ4.Encoders.ILZ4Encoder,System.Byte[],System.Int32@,System.Int32)">
|
||||
<summary>Tops encoder up with some data.</summary>
|
||||
<param name="encoder">Encoder.</param>
|
||||
<param name="source">Buffer.</param>
|
||||
<param name="offset">Buffer offset, will be increased after operation by the number
|
||||
of bytes actually loaded.</param>
|
||||
<param name="length">Length of buffer.</param>
|
||||
<returns><c>true</c> if buffer was topped up, <c>false</c> if no bytes were loaded.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.Encode(K4os.Compression.LZ4.Encoders.ILZ4Encoder,System.Byte[],System.Int32,System.Int32,System.Boolean)">
|
||||
<summary>Encodes all bytes currently stored in encoder into target buffer.</summary>
|
||||
<param name="encoder">Encoder.</param>
|
||||
<param name="target">Target buffer.</param>
|
||||
<param name="offset">Offset in target buffer.</param>
|
||||
<param name="length">Length of target buffer.</param>
|
||||
<param name="allowCopy">if <c>true</c> copying bytes is allowed.</param>
|
||||
<returns>Number of bytes encoder. If bytes were copied than this value is negative.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.Encode(K4os.Compression.LZ4.Encoders.ILZ4Encoder,System.Byte[],System.Int32@,System.Int32,System.Boolean)">
|
||||
<summary>Encodes all bytes currently stored in encoder into target buffer.</summary>
|
||||
<param name="encoder">Encoder.</param>
|
||||
<param name="target">Target buffer.</param>
|
||||
<param name="offset">Offset in target buffer. Will be updated after operation.</param>
|
||||
<param name="length">Length of target buffer.</param>
|
||||
<param name="allowCopy">if <c>true</c> copying bytes is allowed.</param>
|
||||
<returns>Result of this action. Bytes can be Copied (<see cref="F:K4os.Compression.LZ4.Encoders.EncoderAction.Copied"/>),
|
||||
Encoded (<see cref="F:K4os.Compression.LZ4.Encoders.EncoderAction.Encoded"/>) or nothing could have
|
||||
happened (<see cref="F:K4os.Compression.LZ4.Encoders.EncoderAction.None"/>).</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.Encode(K4os.Compression.LZ4.Encoders.ILZ4Encoder,System.Byte*@,System.Int32,System.Boolean)">
|
||||
<summary>Encodes all bytes currently stored in encoder into target buffer.</summary>
|
||||
<param name="encoder">Encoder.</param>
|
||||
<param name="target">Target buffer. Will be updated after operation.</param>
|
||||
<param name="length">Length of buffer.</param>
|
||||
<param name="allowCopy">if <c>true</c> copying bytes is allowed.</param>
|
||||
<returns>Result of this action. Bytes can be Copied (<see cref="F:K4os.Compression.LZ4.Encoders.EncoderAction.Copied"/>),
|
||||
Encoded (<see cref="F:K4os.Compression.LZ4.Encoders.EncoderAction.Encoded"/>) or nothing could have
|
||||
happened (<see cref="F:K4os.Compression.LZ4.Encoders.EncoderAction.None"/>).</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.TopupAndEncode(K4os.Compression.LZ4.Encoders.ILZ4Encoder,System.Byte*,System.Int32,System.Byte*,System.Int32,System.Boolean,System.Boolean,System.Int32@,System.Int32@)">
|
||||
<summary>Tops encoder and encodes content.</summary>
|
||||
<param name="encoder">Encoder.</param>
|
||||
<param name="source">Source buffer (used to top up from).</param>
|
||||
<param name="sourceLength">Source buffer length.</param>
|
||||
<param name="target">Target buffer (used to encode into)</param>
|
||||
<param name="targetLength">Target buffer length.</param>
|
||||
<param name="forceEncode">Forces encoding even if encoder is not full.</param>
|
||||
<param name="allowCopy">Allows to copy bytes if compression was not possible.</param>
|
||||
<param name="loaded">Number of bytes loaded (topped up)</param>
|
||||
<param name="encoded">Number if bytes encoded or copied.
|
||||
Value is 0 if no encoding was done.</param>
|
||||
<returns>Action performed.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.TopupAndEncode(K4os.Compression.LZ4.Encoders.ILZ4Encoder,System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32,System.Int32,System.Boolean,System.Boolean,System.Int32@,System.Int32@)">
|
||||
<summary>Tops encoder and encodes content.</summary>
|
||||
<param name="encoder">Encoder.</param>
|
||||
<param name="source">Source buffer (used to top up from).</param>
|
||||
<param name="sourceOffset">Offset within source buffer.</param>
|
||||
<param name="sourceLength">Source buffer length.</param>
|
||||
<param name="target">Target buffer (used to encode into)</param>
|
||||
<param name="targetOffset">Offset within target buffer.</param>
|
||||
<param name="targetLength">Target buffer length.</param>
|
||||
<param name="forceEncode">Forces encoding even if encoder is not full.</param>
|
||||
<param name="allowCopy">Allows to copy bytes if compression was not possible.</param>
|
||||
<param name="loaded">Number of bytes loaded (topped up)</param>
|
||||
<param name="encoded">Number if bytes encoded or copied.
|
||||
Value is 0 if no encoding was done.</param>
|
||||
<returns>Action performed.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.FlushAndEncode(K4os.Compression.LZ4.Encoders.ILZ4Encoder,System.Byte*,System.Int32,System.Boolean,System.Int32@)">
|
||||
<summary>Encoded remaining bytes in encoder.</summary>
|
||||
<param name="encoder">Encoder.</param>
|
||||
<param name="target">Target buffer.</param>
|
||||
<param name="targetLength">Target buffer length.</param>
|
||||
<param name="allowCopy">Allows to copy bytes if compression was not possible.</param>
|
||||
<param name="encoded">Number if bytes encoded or copied.
|
||||
Value is 0 if no encoding was done.</param>
|
||||
<returns>Action performed.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.FlushAndEncode(K4os.Compression.LZ4.Encoders.ILZ4Encoder,System.Byte[],System.Int32,System.Int32,System.Boolean,System.Int32@)">
|
||||
<summary>Encoded remaining bytes in encoder.</summary>
|
||||
<param name="encoder">Encoder.</param>
|
||||
<param name="target">Target buffer.</param>
|
||||
<param name="targetOffset">Offset within target buffer.</param>
|
||||
<param name="targetLength">Target buffer length.</param>
|
||||
<param name="allowCopy">Allows to copy bytes if compression was not possible.</param>
|
||||
<param name="encoded">Number if bytes encoded or copied.
|
||||
Value is 0 if no encoding was done.</param>
|
||||
<returns>Action performed.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.Drain(K4os.Compression.LZ4.Encoders.ILZ4Decoder,System.Byte[],System.Int32,System.Int32,System.Int32)">
|
||||
<summary>Drains decoder by reading all bytes which are ready.</summary>
|
||||
<param name="decoder">Decoder.</param>
|
||||
<param name="target">Target buffer.</param>
|
||||
<param name="targetOffset">Offset within target buffer.</param>
|
||||
<param name="offset">Offset in decoder relatively to decoder's head.
|
||||
Please note, it should be negative value.</param>
|
||||
<param name="length">Number of bytes.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.DecodeAndDrain(K4os.Compression.LZ4.Encoders.ILZ4Decoder,System.Byte*,System.Int32,System.Byte*,System.Int32,System.Int32@)">
|
||||
<summary>Decodes data and immediately drains it into target buffer.</summary>
|
||||
<param name="decoder">Decoder.</param>
|
||||
<param name="source">Source buffer (with compressed data, to be decoded).</param>
|
||||
<param name="sourceLength">Source buffer length.</param>
|
||||
<param name="target">Target buffer (to drained into).</param>
|
||||
<param name="targetLength">Target buffer length.</param>
|
||||
<param name="decoded">Number of bytes actually decoded.</param>
|
||||
<returns><c>true</c> decoder was drained, <c>false</c> otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.DecodeAndDrain(K4os.Compression.LZ4.Encoders.ILZ4Decoder,System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32,System.Int32,System.Int32@)">
|
||||
<summary>Decodes data and immediately drains it into target buffer.</summary>
|
||||
<param name="decoder">Decoder.</param>
|
||||
<param name="source">Source buffer (with compressed data, to be decoded).</param>
|
||||
<param name="sourceOffset">Offset within source buffer.</param>
|
||||
<param name="sourceLength">Source buffer length.</param>
|
||||
<param name="target">Target buffer (to drained into).</param>
|
||||
<param name="targetOffset">Offset within target buffer.</param>
|
||||
<param name="targetLength">Target buffer length.</param>
|
||||
<param name="decoded">Number of bytes actually decoded.</param>
|
||||
<returns><c>true</c> decoder was drained, <c>false</c> otherwise.</returns>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Encoders.LZ4FastChainEncoder">
|
||||
<summary>
|
||||
LZ4 encoder using dependent blocks with fast compression.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4FastChainEncoder.#ctor(System.Int32,System.Int32)">
|
||||
<summary>Creates new instance of <see cref="T:K4os.Compression.LZ4.Encoders.LZ4FastChainEncoder"/></summary>
|
||||
<param name="blockSize">Block size.</param>
|
||||
<param name="extraBlocks">Number of extra blocks.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4FastChainEncoder.ReleaseUnmanaged">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4FastChainEncoder.EncodeBlock(System.Byte*,System.Int32,System.Byte*,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4FastChainEncoder.CopyDict(System.Byte*,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Encoders.LZ4HighChainEncoder">
|
||||
<summary>
|
||||
LZ4 encoder using dependent blocks with high compression.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4HighChainEncoder.#ctor(K4os.Compression.LZ4.LZ4Level,System.Int32,System.Int32)">
|
||||
<summary>Creates new instance of <see cref="T:K4os.Compression.LZ4.Encoders.LZ4HighChainEncoder"/></summary>
|
||||
<param name="level">Compression level.</param>
|
||||
<param name="blockSize">Block size.</param>
|
||||
<param name="extraBlocks">Number of extra blocks.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4HighChainEncoder.ReleaseUnmanaged">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4HighChainEncoder.EncodeBlock(System.Byte*,System.Int32,System.Byte*,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4HighChainEncoder.CopyDict(System.Byte*,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Internal.Mem">
|
||||
<summary>Utility class with memory related functions.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.K1">
|
||||
<summary>1 KiB</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.K2">
|
||||
<summary>2 KiB</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.K4">
|
||||
<summary>4 KiB</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.K8">
|
||||
<summary>8 KiB</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.K16">
|
||||
<summary>16 KiB</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.K32">
|
||||
<summary>32 KiB</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.K64">
|
||||
<summary>64 KiB</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.K128">
|
||||
<summary>128 KiB</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.K256">
|
||||
<summary>256 KiB</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.K512">
|
||||
<summary>512 KiB</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.M1">
|
||||
<summary>1 MiB</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.M4">
|
||||
<summary>4 MiB</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.Empty">
|
||||
<summary>Empty byte array.</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.RoundUp(System.Int32,System.Int32)">
|
||||
<summary>Rounds integer value up to nearest multiple of step.</summary>
|
||||
<param name="value">A value.</param>
|
||||
<param name="step">A step.</param>
|
||||
<returns>Value rounded up.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Copy(System.Byte*,System.Byte*,System.Int32)">
|
||||
<summary>
|
||||
Copies memory block for <paramref name="source"/> to <paramref name="target"/>.
|
||||
Even though it is called "copy" it actually behaves like "move" which
|
||||
might be potential problem, although it shouldn't as I cannot think about
|
||||
any situation when "copy" invalid behaviour (forward copy of overlapping blocks)
|
||||
can be a desired.
|
||||
</summary>
|
||||
<param name="target">The target block address.</param>
|
||||
<param name="source">The source block address.</param>
|
||||
<param name="length">Length in bytes.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Move(System.Byte*,System.Byte*,System.Int32)">
|
||||
<summary>
|
||||
Copies memory block for <paramref name="source"/> to <paramref name="target"/>.
|
||||
It handle "move" semantic properly handling overlapping blocks properly.
|
||||
</summary>
|
||||
<param name="target">The target block address.</param>
|
||||
<param name="source">The source block address.</param>
|
||||
<param name="length">Length in bytes.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.WildCopy(System.Byte*,System.Byte*,System.Void*)">
|
||||
<summary>
|
||||
Copies memory block for <paramref name="source"/> to <paramref name="target"/>
|
||||
up to (around) <paramref name="limit"/>.
|
||||
It does not handle overlapping blocks and may copy up to 8 bytes more than expected.
|
||||
</summary>
|
||||
<param name="target">The target block address.</param>
|
||||
<param name="source">The source block address.</param>
|
||||
<param name="limit">The limit (in target block).</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Zero(System.Byte*,System.Int32)">
|
||||
<summary>Fill block of memory with zeroes.</summary>
|
||||
<param name="target">Address.</param>
|
||||
<param name="length">Length.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Fill(System.Byte*,System.Byte,System.Int32)">
|
||||
<summary>Fills memory block with repeating pattern of a single byte.</summary>
|
||||
<param name="target">Address.</param>
|
||||
<param name="value">A pattern.</param>
|
||||
<param name="length">Length.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.LoopCopy(System.Byte*,System.Byte*,System.Int32)">
|
||||
<summary>
|
||||
Copies memory block for <paramref name="source"/> to <paramref name="target"/>.
|
||||
This is proper implementation of memcpy (with all then weird behaviour for
|
||||
overlapping blocks). It is slower than "Copy" but may be required if "Copy"
|
||||
causes problems.
|
||||
</summary>
|
||||
<param name="target">The target block address.</param>
|
||||
<param name="source">The source block address.</param>
|
||||
<param name="length">Length in bytes.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.LoopCopyBack(System.Byte*,System.Byte*,System.Int32)">
|
||||
<summary>
|
||||
Copies memory block backwards from <paramref name="source"/> to <paramref name="target"/>.
|
||||
This is needed to implement memmove It is slower than "Move" but is needed for .NET 4.5,
|
||||
which does not implement Buffer.MemoryCopy.
|
||||
</summary>
|
||||
<param name="target">The target block address.</param>
|
||||
<param name="source">The source block address.</param>
|
||||
<param name="length">Length in bytes.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.LoopMove(System.Byte*,System.Byte*,System.Int32)">
|
||||
<summary>
|
||||
Moves memory block for <paramref name="source"/> to <paramref name="target"/>.
|
||||
It handles overlapping block properly.
|
||||
</summary>
|
||||
<param name="target">The target block address.</param>
|
||||
<param name="source">The source block address.</param>
|
||||
<param name="length">Length in bytes.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Copy8(System.Byte*,System.Byte*)">
|
||||
<summary>Copies exactly 8 bytes from source to target.</summary>
|
||||
<param name="target">Target address.</param>
|
||||
<param name="source">Source address.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Copy16(System.Byte*,System.Byte*)">
|
||||
<summary>Copies exactly 16 bytes from source to target.</summary>
|
||||
<param name="target">Target address.</param>
|
||||
<param name="source">Source address.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Copy18(System.Byte*,System.Byte*)">
|
||||
<summary>Copies exactly 18 bytes from source to target.</summary>
|
||||
<param name="target">Target address.</param>
|
||||
<param name="source">Source address.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Alloc(System.Int32)">
|
||||
<summary>Allocated block of memory. It is NOT initialized with zeroes.</summary>
|
||||
<param name="size">Size in bytes.</param>
|
||||
<returns>Pointer to allocated block.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.AllocZero(System.Int32)">
|
||||
<summary>Allocated block of memory and fills it with zeroes.</summary>
|
||||
<param name="size">Size in bytes.</param>
|
||||
<returns>Pointer to allocated block.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Free(System.Void*)">
|
||||
<summary>
|
||||
Free memory allocated previously with <see cref="M:K4os.Compression.LZ4.Internal.Mem.Alloc(System.Int32)"/> or <see cref="M:K4os.Compression.LZ4.Internal.Mem.AllocZero(System.Int32)"/>
|
||||
</summary>
|
||||
<param name="ptr"></param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Peek8(System.Void*)">
|
||||
<summary>Reads exactly 1 byte from given address.</summary>
|
||||
<param name="p">Address.</param>
|
||||
<returns>Byte at given address.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Peek16(System.Void*)">
|
||||
<summary>Reads exactly 2 bytes from given address.</summary>
|
||||
<param name="p">Address.</param>
|
||||
<returns>2 bytes at given address.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Peek32(System.Void*)">
|
||||
<summary>Reads exactly 4 bytes from given address.</summary>
|
||||
<param name="p">Address.</param>
|
||||
<returns>4 bytes at given address.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Peek64(System.Void*)">
|
||||
<summary>Reads exactly 8 bytes from given address.</summary>
|
||||
<param name="p">Address.</param>
|
||||
<returns>8 bytes at given address.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Poke8(System.Void*,System.Byte)">
|
||||
<summary>Writes exactly 1 byte to given address.</summary>
|
||||
<param name="p">Address.</param>
|
||||
<param name="v">Value.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Poke16(System.Void*,System.UInt16)">
|
||||
<summary>Writes exactly 2 bytes to given address.</summary>
|
||||
<param name="p">Address.</param>
|
||||
<param name="v">Value.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Poke32(System.Void*,System.UInt32)">
|
||||
<summary>Writes exactly 4 bytes to given address.</summary>
|
||||
<param name="p">Address.</param>
|
||||
<param name="v">Value.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Poke64(System.Void*,System.UInt64)">
|
||||
<summary>Writes exactly 8 bytes to given address.</summary>
|
||||
<param name="p">Address.</param>
|
||||
<param name="v">Value.</param>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Internal.UnmanagedResources">
|
||||
<summary>
|
||||
Skeleton for class with unmanaged resources.
|
||||
Implements <see cref="T:System.IDisposable"/> but also handles proper release in
|
||||
case <see cref="M:K4os.Compression.LZ4.Internal.UnmanagedResources.Dispose"/> was not called.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Internal.UnmanagedResources.IsDisposed">
|
||||
<summary>Determines if object was already disposed.</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.UnmanagedResources.ThrowIfDisposed">
|
||||
<summary>Throws exception is object has been disposed already. Convenience method.</summary>
|
||||
<exception cref="T:System.ObjectDisposedException">Thrown if object is already disposed.</exception>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.UnmanagedResources.ReleaseUnmanaged">
|
||||
<summary>Method releasing unmanaged resources.</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.UnmanagedResources.ReleaseManaged">
|
||||
<summary>Method releasing managed resources.</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.UnmanagedResources.Dispose(System.Boolean)">
|
||||
<summary>
|
||||
Disposed resources.
|
||||
</summary>
|
||||
<param name="disposing"><c>true</c> if dispose was explicitly called,
|
||||
<c>false</c> if called from GC.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.UnmanagedResources.Dispose">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.UnmanagedResources.Finalize">
|
||||
<summary>Destructor.</summary>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.LZ4Codec">
|
||||
<summary>
|
||||
Static class exposing LZ4 block compression methods.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Codec.MaximumOutputSize(System.Int32)">
|
||||
<summary>Maximum size after compression.</summary>
|
||||
<param name="length">Length of input buffer.</param>
|
||||
<returns>Maximum length after compression.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Codec.Encode(System.Byte*,System.Int32,System.Byte*,System.Int32,K4os.Compression.LZ4.LZ4Level)">
|
||||
<summary>Compresses data from one buffer into another.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<param name="sourceLength">Length of input buffer.</param>
|
||||
<param name="target">Output buffer.</param>
|
||||
<param name="targetLength">Output buffer length.</param>
|
||||
<param name="level">Compression level.</param>
|
||||
<returns>Number of bytes written, or negative value if output buffer is too small.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Codec.Encode(System.ReadOnlySpan{System.Byte},System.Span{System.Byte},K4os.Compression.LZ4.LZ4Level)">
|
||||
<summary>Compresses data from one buffer into another.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<param name="target">Output buffer.</param>
|
||||
<param name="level">Compression level.</param>
|
||||
<returns>Number of bytes written, or negative value if output buffer is too small.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Codec.Encode(System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32,System.Int32,K4os.Compression.LZ4.LZ4Level)">
|
||||
<summary>Compresses data from one buffer into another.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<param name="sourceOffset">Input buffer offset.</param>
|
||||
<param name="sourceLength">Input buffer length.</param>
|
||||
<param name="target">Output buffer.</param>
|
||||
<param name="targetOffset">Output buffer offset.</param>
|
||||
<param name="targetLength">Output buffer length.</param>
|
||||
<param name="level">Compression level.</param>
|
||||
<returns>Number of bytes written, or negative value if output buffer is too small.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Codec.Decode(System.Byte*,System.Int32,System.Byte*,System.Int32)">
|
||||
<summary>Decompresses data from given buffer.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<param name="sourceLength">Input buffer length.</param>
|
||||
<param name="target">Output buffer.</param>
|
||||
<param name="targetLength">Output buffer length.</param>
|
||||
<returns>Number of bytes written, or negative value if output buffer is too small.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Codec.Decode(System.ReadOnlySpan{System.Byte},System.Span{System.Byte})">
|
||||
<summary>Decompresses data from given buffer.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<param name="target">Output buffer.</param>
|
||||
<returns>Number of bytes written, or negative value if output buffer is too small.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Codec.Decode(System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32,System.Int32)">
|
||||
<summary>Decompresses data from given buffer.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<param name="sourceOffset">Input buffer offset.</param>
|
||||
<param name="sourceLength">Input buffer length.</param>
|
||||
<param name="target">Output buffer.</param>
|
||||
<param name="targetOffset">Output buffer offset.</param>
|
||||
<param name="targetLength">Output buffer length.</param>
|
||||
<returns>Number of bytes written, or negative value if output buffer is too small.</returns>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.LZ4Level">
|
||||
<summary>Compression level.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.LZ4Level.L00_FAST">
|
||||
<summary>Fast compression.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.LZ4Level.L03_HC">
|
||||
<summary>High compression, level 3.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.LZ4Level.L04_HC">
|
||||
<summary>High compression, level 4.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.LZ4Level.L05_HC">
|
||||
<summary>High compression, level 5.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.LZ4Level.L06_HC">
|
||||
<summary>High compression, level 6.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.LZ4Level.L07_HC">
|
||||
<summary>High compression, level 7.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.LZ4Level.L08_HC">
|
||||
<summary>High compression, level 8.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.LZ4Level.L09_HC">
|
||||
<summary>High compression, level 9.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.LZ4Level.L10_OPT">
|
||||
<summary>Optimal compression, level 10.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.LZ4Level.L11_OPT">
|
||||
<summary>Optimal compression, level 11.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.LZ4Level.L12_MAX">
|
||||
<summary>Maximum compression, level 12.</summary>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.LZ4Pickler">
|
||||
<summary>
|
||||
Pickling support with LZ4 compression.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Pickler.Pickle(System.Byte[],K4os.Compression.LZ4.LZ4Level)">
|
||||
<summary>Compresses input buffer into self-contained package.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<param name="level">Compression level.</param>
|
||||
<returns>Output buffer.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Pickler.Pickle(System.Byte[],System.Int32,System.Int32,K4os.Compression.LZ4.LZ4Level)">
|
||||
<summary>Compresses input buffer into self-contained package.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<param name="sourceOffset">Input buffer offset.</param>
|
||||
<param name="sourceLength">Input buffer length.</param>
|
||||
<param name="level">Compression level.</param>
|
||||
<returns>Output buffer.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Pickler.Pickle(System.ReadOnlySpan{System.Byte},K4os.Compression.LZ4.LZ4Level)">
|
||||
<summary>Compresses input buffer into self-contained package.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<param name="level">Compression level.</param>
|
||||
<returns>Output buffer.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Pickler.Pickle(System.Byte*,System.Int32,K4os.Compression.LZ4.LZ4Level)">
|
||||
<summary>Compresses input buffer into self-contained package.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<param name="sourceLength">Length of input data.</param>
|
||||
<param name="level">Compression level.</param>
|
||||
<returns>Output buffer.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Pickler.Unpickle(System.Byte[])">
|
||||
<summary>Decompresses previously pickled buffer (see: <see cref="T:K4os.Compression.LZ4.LZ4Pickler"/>.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<returns>Output buffer.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Pickler.Unpickle(System.Byte[],System.Int32,System.Int32)">
|
||||
<summary>Decompresses previously pickled buffer (see: <see cref="T:K4os.Compression.LZ4.LZ4Pickler"/>.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<param name="sourceOffset">Input buffer offset.</param>
|
||||
<param name="sourceLength">Input buffer length.</param>
|
||||
<returns>Output buffer.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Pickler.Unpickle(System.ReadOnlySpan{System.Byte})">
|
||||
<summary>Decompresses previously pickled buffer (see: <see cref="T:K4os.Compression.LZ4.LZ4Pickler"/>.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<returns>Output buffer.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Pickler.Unpickle(System.Byte*,System.Int32)">
|
||||
<summary>Decompresses previously pickled buffer (see: <see cref="T:K4os.Compression.LZ4.LZ4Pickler"/>.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<param name="sourceLength">Input buffer length.</param>
|
||||
<returns>Output buffer.</returns>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
BIN
Binary file not shown.
+794
@@ -0,0 +1,794 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>K4os.Compression.LZ4</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:K4os.Compression.LZ4.Encoders.EncoderAction">
|
||||
<summary>
|
||||
Action performed by encoder using <c>FlushAndEncode</c> method.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Encoders.EncoderAction.None">
|
||||
<summary>Nothing has happened, most likely loading 0 bytes.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Encoders.EncoderAction.Loaded">
|
||||
<summary>Some bytes has been loaded into encoder.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Encoders.EncoderAction.Copied">
|
||||
<summary>Compression was not possible so bytes has been copied.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Encoders.EncoderAction.Encoded">
|
||||
<summary>Compression succeeded.</summary>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Encoders.ILZ4Decoder">
|
||||
<summary>
|
||||
Interface of LZ4 decoder used by LZ4 streams.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Encoders.ILZ4Decoder.BlockSize">
|
||||
<summary>Block size.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Encoders.ILZ4Decoder.BytesReady">
|
||||
<summary>Bytes already decoded and available to be read.
|
||||
Always smaller than <see cref="P:K4os.Compression.LZ4.Encoders.ILZ4Decoder.BlockSize"/></summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.ILZ4Decoder.Decode(System.Byte*,System.Int32,System.Int32)">
|
||||
<summary>
|
||||
Decodes previously compressed block and caches decompressed block in decoder.
|
||||
Returns number of bytes decoded. These bytes can be read with <see cref="M:K4os.Compression.LZ4.Encoders.ILZ4Decoder.Drain(System.Byte*,System.Int32,System.Int32)" />.
|
||||
</summary>
|
||||
<param name="source">Points to compressed block.</param>
|
||||
<param name="length">Length of compressed block.</param>
|
||||
<param name="blockSize">Size of the block. Value <c>0</c> indicates default block size.</param>
|
||||
<returns>Number of decoded bytes.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.ILZ4Decoder.Inject(System.Byte*,System.Int32)">
|
||||
<summary>
|
||||
Inject already decompressed block and caches it in decoder.
|
||||
Used with uncompressed-yet-chained blocks and pre-made dictionaries.
|
||||
These bytes can be read with <see cref="M:K4os.Compression.LZ4.Encoders.ILZ4Decoder.Drain(System.Byte*,System.Int32,System.Int32)" />.
|
||||
</summary>
|
||||
<param name="source">Points to uncompressed block.</param>
|
||||
<param name="length">Length of uncompressed block.</param>
|
||||
<returns>Number of decoded bytes.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.ILZ4Decoder.Drain(System.Byte*,System.Int32,System.Int32)">
|
||||
<summary>
|
||||
Reads previously decoded bytes. Please note, <paramref name="offset"/> should be
|
||||
negative number, pointing to bytes before current head.
|
||||
</summary>
|
||||
<param name="target">Buffer to write to.</param>
|
||||
<param name="offset">Offset in source buffer relatively to current head.
|
||||
Please note, it should be negative value.</param>
|
||||
<param name="length">Number of bytes to read.</param>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Encoders.ILZ4Encoder">
|
||||
<summary>
|
||||
Interface of LZ4 encoder used by LZ4 streams.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Encoders.ILZ4Encoder.BlockSize">
|
||||
<summary>Block size.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Encoders.ILZ4Encoder.BytesReady">
|
||||
<summary>Number of bytes read for compression.
|
||||
Always smaller than <see cref="P:K4os.Compression.LZ4.Encoders.ILZ4Encoder.BlockSize"/></summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.ILZ4Encoder.Topup(System.Byte*,System.Int32)">
|
||||
<summary>Adds bytes to internal buffer. Increases <see cref="P:K4os.Compression.LZ4.Encoders.ILZ4Encoder.BytesReady"/></summary>
|
||||
<param name="source">Source buffer.</param>
|
||||
<param name="length">Source buffer length.</param>
|
||||
<returns>Number of bytes topped up. If this function returns 0 it means that buffer
|
||||
is full (<see cref="P:K4os.Compression.LZ4.Encoders.ILZ4Encoder.BytesReady"/> equals <see cref="P:K4os.Compression.LZ4.Encoders.ILZ4Encoder.BlockSize"/>) and
|
||||
<see cref="M:K4os.Compression.LZ4.Encoders.ILZ4Encoder.Encode(System.Byte*,System.Int32,System.Boolean)"/> should be called to flush it.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.ILZ4Encoder.Encode(System.Byte*,System.Int32,System.Boolean)">
|
||||
<summary>
|
||||
Encodes bytes in internal buffer (see: <see cref="P:K4os.Compression.LZ4.Encoders.ILZ4Encoder.BytesReady"/>, <see cref="M:K4os.Compression.LZ4.Encoders.ILZ4Encoder.Topup(System.Byte*,System.Int32)"/>).
|
||||
If <paramref name="allowCopy"/> is <c>true</c> then if encoded buffer is bigger than
|
||||
source buffer source bytes are copied instead. In such case returned length is negative.
|
||||
</summary>
|
||||
<param name="target">Target buffer.</param>
|
||||
<param name="length">Target buffer length.</param>
|
||||
<param name="allowCopy">Indicates if copying is allowed.</param>
|
||||
<returns>Length of encoded buffer. Negative if bytes are just copied.</returns>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Encoders.LZ4BlockDecoder">
|
||||
<summary>
|
||||
LZ4 decoder used with independent blocks mode. Plase note, that it will fail
|
||||
if input data has been compressed with chained blocks
|
||||
(<see cref="T:K4os.Compression.LZ4.Encoders.LZ4FastChainEncoder"/> and <see cref="T:K4os.Compression.LZ4.Encoders.LZ4HighChainEncoder"/>)
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Encoders.LZ4BlockDecoder.BlockSize">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Encoders.LZ4BlockDecoder.BytesReady">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4BlockDecoder.#ctor(System.Int32)">
|
||||
<summary>Creates new instance of block decoder.</summary>
|
||||
<param name="blockSize">Block size. Must be equal or greater to one used for compression.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4BlockDecoder.Decode(System.Byte*,System.Int32,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4BlockDecoder.Inject(System.Byte*,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4BlockDecoder.Drain(System.Byte*,System.Int32,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4BlockDecoder.ReleaseUnmanaged">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Encoders.LZ4BlockEncoder">
|
||||
<summary>
|
||||
Independent block encoder. Produces larger files but uses less memory and
|
||||
gives better performance.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4BlockEncoder.#ctor(K4os.Compression.LZ4.LZ4Level,System.Int32)">
|
||||
<summary>Creates new instance of <see cref="T:K4os.Compression.LZ4.Encoders.LZ4BlockEncoder"/></summary>
|
||||
<param name="level">Compression level.</param>
|
||||
<param name="blockSize">Block size.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4BlockEncoder.EncodeBlock(System.Byte*,System.Int32,System.Byte*,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4BlockEncoder.CopyDict(System.Byte*,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Encoders.LZ4ChainDecoder">
|
||||
<summary>LZ4 decoder handling dependent blocks.</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4ChainDecoder.#ctor(System.Int32,System.Int32)">
|
||||
<summary>Creates new instance of <see cref="T:K4os.Compression.LZ4.Encoders.LZ4ChainDecoder"/>.</summary>
|
||||
<param name="blockSize">Block size.</param>
|
||||
<param name="extraBlocks">Number of extra blocks.</param>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Encoders.LZ4ChainDecoder.BlockSize">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Encoders.LZ4ChainDecoder.BytesReady">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4ChainDecoder.Decode(System.Byte*,System.Int32,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4ChainDecoder.Inject(System.Byte*,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4ChainDecoder.Drain(System.Byte*,System.Int32,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4ChainDecoder.ReleaseUnmanaged">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Encoders.LZ4Decoder">
|
||||
<summary>
|
||||
Static class with factory methods to create LZ4 decoders.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4Decoder.Create(System.Boolean,System.Int32,System.Int32)">
|
||||
<summary>Creates appropriate decoder for given parameters.</summary>
|
||||
<param name="chaining">Dependent blocks.</param>
|
||||
<param name="blockSize">Block size.</param>
|
||||
<param name="extraBlocks">Number of extra blocks.</param>
|
||||
<returns>LZ4 decoder.</returns>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Encoders.LZ4Encoder">
|
||||
<summary>
|
||||
Static class with factory method to create LZ4 encoders.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4Encoder.Create(System.Boolean,K4os.Compression.LZ4.LZ4Level,System.Int32,System.Int32)">
|
||||
<summary>Creates appropriate decoder for given parameters.</summary>
|
||||
<param name="chaining">Dependent blocks.</param>
|
||||
<param name="level">Compression level.</param>
|
||||
<param name="blockSize">Block size.</param>
|
||||
<param name="extraBlocks">Number of extra blocks.</param>
|
||||
<returns>LZ4 encoder.</returns>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Encoders.LZ4EncoderBase">
|
||||
<summary>
|
||||
Base class for LZ4 encoders. Provides basic functionality shared by
|
||||
<see cref="T:K4os.Compression.LZ4.Encoders.LZ4BlockEncoder"/>, <see cref="T:K4os.Compression.LZ4.Encoders.LZ4FastChainEncoder"/>,
|
||||
and <see cref="T:K4os.Compression.LZ4.Encoders.LZ4HighChainEncoder"/> encoders. Do not used directly.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderBase.#ctor(System.Boolean,System.Int32,System.Int32)">
|
||||
<summary>Creates new instance of encoder.</summary>
|
||||
<param name="chaining">Needs to be <c>true</c> if using dependent blocks.</param>
|
||||
<param name="blockSize">Block size.</param>
|
||||
<param name="extraBlocks">Number of extra blocks.</param>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Encoders.LZ4EncoderBase.BlockSize">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Encoders.LZ4EncoderBase.BytesReady">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderBase.Topup(System.Byte*,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderBase.Encode(System.Byte*,System.Int32,System.Boolean)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderBase.EncodeBlock(System.Byte*,System.Int32,System.Byte*,System.Int32)">
|
||||
<summary>Encodes single block using appropriate algorithm.</summary>
|
||||
<param name="source">Source buffer.</param>
|
||||
<param name="sourceLength">Source buffer length.</param>
|
||||
<param name="target">Target buffer.</param>
|
||||
<param name="targetLength">Target buffer length.</param>
|
||||
<returns>Number of bytes actually written to target buffer.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderBase.CopyDict(System.Byte*,System.Int32)">
|
||||
<summary>Copies current dictionary.</summary>
|
||||
<param name="target">Target buffer.</param>
|
||||
<param name="dictionaryLength">Dictionary length.</param>
|
||||
<returns>Dictionary length.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderBase.ReleaseUnmanaged">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions">
|
||||
<summary>
|
||||
Functionality of encoders added on top of fixed interface.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.Topup(K4os.Compression.LZ4.Encoders.ILZ4Encoder,System.Byte*@,System.Int32)">
|
||||
<summary>Tops encoder up with some data.</summary>
|
||||
<param name="encoder">Encoder.</param>
|
||||
<param name="source">Buffer pointer, will be shifted after operation by the number of
|
||||
bytes actually loaded.</param>
|
||||
<param name="length">Length of buffer.</param>
|
||||
<returns><c>true</c> if buffer was topped up, <c>false</c> if no bytes were loaded.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.Topup(K4os.Compression.LZ4.Encoders.ILZ4Encoder,System.Byte[],System.Int32,System.Int32)">
|
||||
<summary>Tops encoder up with some data.</summary>
|
||||
<param name="encoder">Encoder.</param>
|
||||
<param name="source">Buffer.</param>
|
||||
<param name="offset">Buffer offset.</param>
|
||||
<param name="length">Length of buffer.</param>
|
||||
<returns>Number of bytes actually loaded.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.Topup(K4os.Compression.LZ4.Encoders.ILZ4Encoder,System.Byte[],System.Int32@,System.Int32)">
|
||||
<summary>Tops encoder up with some data.</summary>
|
||||
<param name="encoder">Encoder.</param>
|
||||
<param name="source">Buffer.</param>
|
||||
<param name="offset">Buffer offset, will be increased after operation by the number
|
||||
of bytes actually loaded.</param>
|
||||
<param name="length">Length of buffer.</param>
|
||||
<returns><c>true</c> if buffer was topped up, <c>false</c> if no bytes were loaded.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.Encode(K4os.Compression.LZ4.Encoders.ILZ4Encoder,System.Byte[],System.Int32,System.Int32,System.Boolean)">
|
||||
<summary>Encodes all bytes currently stored in encoder into target buffer.</summary>
|
||||
<param name="encoder">Encoder.</param>
|
||||
<param name="target">Target buffer.</param>
|
||||
<param name="offset">Offset in target buffer.</param>
|
||||
<param name="length">Length of target buffer.</param>
|
||||
<param name="allowCopy">if <c>true</c> copying bytes is allowed.</param>
|
||||
<returns>Number of bytes encoder. If bytes were copied than this value is negative.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.Encode(K4os.Compression.LZ4.Encoders.ILZ4Encoder,System.Byte[],System.Int32@,System.Int32,System.Boolean)">
|
||||
<summary>Encodes all bytes currently stored in encoder into target buffer.</summary>
|
||||
<param name="encoder">Encoder.</param>
|
||||
<param name="target">Target buffer.</param>
|
||||
<param name="offset">Offset in target buffer. Will be updated after operation.</param>
|
||||
<param name="length">Length of target buffer.</param>
|
||||
<param name="allowCopy">if <c>true</c> copying bytes is allowed.</param>
|
||||
<returns>Result of this action. Bytes can be Copied (<see cref="F:K4os.Compression.LZ4.Encoders.EncoderAction.Copied"/>),
|
||||
Encoded (<see cref="F:K4os.Compression.LZ4.Encoders.EncoderAction.Encoded"/>) or nothing could have
|
||||
happened (<see cref="F:K4os.Compression.LZ4.Encoders.EncoderAction.None"/>).</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.Encode(K4os.Compression.LZ4.Encoders.ILZ4Encoder,System.Byte*@,System.Int32,System.Boolean)">
|
||||
<summary>Encodes all bytes currently stored in encoder into target buffer.</summary>
|
||||
<param name="encoder">Encoder.</param>
|
||||
<param name="target">Target buffer. Will be updated after operation.</param>
|
||||
<param name="length">Length of buffer.</param>
|
||||
<param name="allowCopy">if <c>true</c> copying bytes is allowed.</param>
|
||||
<returns>Result of this action. Bytes can be Copied (<see cref="F:K4os.Compression.LZ4.Encoders.EncoderAction.Copied"/>),
|
||||
Encoded (<see cref="F:K4os.Compression.LZ4.Encoders.EncoderAction.Encoded"/>) or nothing could have
|
||||
happened (<see cref="F:K4os.Compression.LZ4.Encoders.EncoderAction.None"/>).</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.TopupAndEncode(K4os.Compression.LZ4.Encoders.ILZ4Encoder,System.Byte*,System.Int32,System.Byte*,System.Int32,System.Boolean,System.Boolean,System.Int32@,System.Int32@)">
|
||||
<summary>Tops encoder and encodes content.</summary>
|
||||
<param name="encoder">Encoder.</param>
|
||||
<param name="source">Source buffer (used to top up from).</param>
|
||||
<param name="sourceLength">Source buffer length.</param>
|
||||
<param name="target">Target buffer (used to encode into)</param>
|
||||
<param name="targetLength">Target buffer length.</param>
|
||||
<param name="forceEncode">Forces encoding even if encoder is not full.</param>
|
||||
<param name="allowCopy">Allows to copy bytes if compression was not possible.</param>
|
||||
<param name="loaded">Number of bytes loaded (topped up)</param>
|
||||
<param name="encoded">Number if bytes encoded or copied.
|
||||
Value is 0 if no encoding was done.</param>
|
||||
<returns>Action performed.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.TopupAndEncode(K4os.Compression.LZ4.Encoders.ILZ4Encoder,System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32,System.Int32,System.Boolean,System.Boolean,System.Int32@,System.Int32@)">
|
||||
<summary>Tops encoder and encodes content.</summary>
|
||||
<param name="encoder">Encoder.</param>
|
||||
<param name="source">Source buffer (used to top up from).</param>
|
||||
<param name="sourceOffset">Offset within source buffer.</param>
|
||||
<param name="sourceLength">Source buffer length.</param>
|
||||
<param name="target">Target buffer (used to encode into)</param>
|
||||
<param name="targetOffset">Offset within target buffer.</param>
|
||||
<param name="targetLength">Target buffer length.</param>
|
||||
<param name="forceEncode">Forces encoding even if encoder is not full.</param>
|
||||
<param name="allowCopy">Allows to copy bytes if compression was not possible.</param>
|
||||
<param name="loaded">Number of bytes loaded (topped up)</param>
|
||||
<param name="encoded">Number if bytes encoded or copied.
|
||||
Value is 0 if no encoding was done.</param>
|
||||
<returns>Action performed.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.FlushAndEncode(K4os.Compression.LZ4.Encoders.ILZ4Encoder,System.Byte*,System.Int32,System.Boolean,System.Int32@)">
|
||||
<summary>Encoded remaining bytes in encoder.</summary>
|
||||
<param name="encoder">Encoder.</param>
|
||||
<param name="target">Target buffer.</param>
|
||||
<param name="targetLength">Target buffer length.</param>
|
||||
<param name="allowCopy">Allows to copy bytes if compression was not possible.</param>
|
||||
<param name="encoded">Number if bytes encoded or copied.
|
||||
Value is 0 if no encoding was done.</param>
|
||||
<returns>Action performed.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.FlushAndEncode(K4os.Compression.LZ4.Encoders.ILZ4Encoder,System.Byte[],System.Int32,System.Int32,System.Boolean,System.Int32@)">
|
||||
<summary>Encoded remaining bytes in encoder.</summary>
|
||||
<param name="encoder">Encoder.</param>
|
||||
<param name="target">Target buffer.</param>
|
||||
<param name="targetOffset">Offset within target buffer.</param>
|
||||
<param name="targetLength">Target buffer length.</param>
|
||||
<param name="allowCopy">Allows to copy bytes if compression was not possible.</param>
|
||||
<param name="encoded">Number if bytes encoded or copied.
|
||||
Value is 0 if no encoding was done.</param>
|
||||
<returns>Action performed.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.Drain(K4os.Compression.LZ4.Encoders.ILZ4Decoder,System.Byte[],System.Int32,System.Int32,System.Int32)">
|
||||
<summary>Drains decoder by reading all bytes which are ready.</summary>
|
||||
<param name="decoder">Decoder.</param>
|
||||
<param name="target">Target buffer.</param>
|
||||
<param name="targetOffset">Offset within target buffer.</param>
|
||||
<param name="offset">Offset in decoder relatively to decoder's head.
|
||||
Please note, it should be negative value.</param>
|
||||
<param name="length">Number of bytes.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.DecodeAndDrain(K4os.Compression.LZ4.Encoders.ILZ4Decoder,System.Byte*,System.Int32,System.Byte*,System.Int32,System.Int32@)">
|
||||
<summary>Decodes data and immediately drains it into target buffer.</summary>
|
||||
<param name="decoder">Decoder.</param>
|
||||
<param name="source">Source buffer (with compressed data, to be decoded).</param>
|
||||
<param name="sourceLength">Source buffer length.</param>
|
||||
<param name="target">Target buffer (to drained into).</param>
|
||||
<param name="targetLength">Target buffer length.</param>
|
||||
<param name="decoded">Number of bytes actually decoded.</param>
|
||||
<returns><c>true</c> decoder was drained, <c>false</c> otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.DecodeAndDrain(K4os.Compression.LZ4.Encoders.ILZ4Decoder,System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32,System.Int32,System.Int32@)">
|
||||
<summary>Decodes data and immediately drains it into target buffer.</summary>
|
||||
<param name="decoder">Decoder.</param>
|
||||
<param name="source">Source buffer (with compressed data, to be decoded).</param>
|
||||
<param name="sourceOffset">Offset within source buffer.</param>
|
||||
<param name="sourceLength">Source buffer length.</param>
|
||||
<param name="target">Target buffer (to drained into).</param>
|
||||
<param name="targetOffset">Offset within target buffer.</param>
|
||||
<param name="targetLength">Target buffer length.</param>
|
||||
<param name="decoded">Number of bytes actually decoded.</param>
|
||||
<returns><c>true</c> decoder was drained, <c>false</c> otherwise.</returns>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Encoders.LZ4FastChainEncoder">
|
||||
<summary>
|
||||
LZ4 encoder using dependent blocks with fast compression.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4FastChainEncoder.#ctor(System.Int32,System.Int32)">
|
||||
<summary>Creates new instance of <see cref="T:K4os.Compression.LZ4.Encoders.LZ4FastChainEncoder"/></summary>
|
||||
<param name="blockSize">Block size.</param>
|
||||
<param name="extraBlocks">Number of extra blocks.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4FastChainEncoder.ReleaseUnmanaged">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4FastChainEncoder.EncodeBlock(System.Byte*,System.Int32,System.Byte*,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4FastChainEncoder.CopyDict(System.Byte*,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Encoders.LZ4HighChainEncoder">
|
||||
<summary>
|
||||
LZ4 encoder using dependent blocks with high compression.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4HighChainEncoder.#ctor(K4os.Compression.LZ4.LZ4Level,System.Int32,System.Int32)">
|
||||
<summary>Creates new instance of <see cref="T:K4os.Compression.LZ4.Encoders.LZ4HighChainEncoder"/></summary>
|
||||
<param name="level">Compression level.</param>
|
||||
<param name="blockSize">Block size.</param>
|
||||
<param name="extraBlocks">Number of extra blocks.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4HighChainEncoder.ReleaseUnmanaged">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4HighChainEncoder.EncodeBlock(System.Byte*,System.Int32,System.Byte*,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4HighChainEncoder.CopyDict(System.Byte*,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Internal.Mem">
|
||||
<summary>Utility class with memory related functions.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.K1">
|
||||
<summary>1 KiB</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.K2">
|
||||
<summary>2 KiB</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.K4">
|
||||
<summary>4 KiB</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.K8">
|
||||
<summary>8 KiB</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.K16">
|
||||
<summary>16 KiB</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.K32">
|
||||
<summary>32 KiB</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.K64">
|
||||
<summary>64 KiB</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.K128">
|
||||
<summary>128 KiB</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.K256">
|
||||
<summary>256 KiB</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.K512">
|
||||
<summary>512 KiB</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.M1">
|
||||
<summary>1 MiB</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.M4">
|
||||
<summary>4 MiB</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.Empty">
|
||||
<summary>Empty byte array.</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.RoundUp(System.Int32,System.Int32)">
|
||||
<summary>Rounds integer value up to nearest multiple of step.</summary>
|
||||
<param name="value">A value.</param>
|
||||
<param name="step">A step.</param>
|
||||
<returns>Value rounded up.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Copy(System.Byte*,System.Byte*,System.Int32)">
|
||||
<summary>
|
||||
Copies memory block for <paramref name="source"/> to <paramref name="target"/>.
|
||||
Even though it is called "copy" it actually behaves like "move" which
|
||||
might be potential problem, although it shouldn't as I cannot think about
|
||||
any situation when "copy" invalid behaviour (forward copy of overlapping blocks)
|
||||
can be a desired.
|
||||
</summary>
|
||||
<param name="target">The target block address.</param>
|
||||
<param name="source">The source block address.</param>
|
||||
<param name="length">Length in bytes.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Move(System.Byte*,System.Byte*,System.Int32)">
|
||||
<summary>
|
||||
Copies memory block for <paramref name="source"/> to <paramref name="target"/>.
|
||||
It handle "move" semantic properly handling overlapping blocks properly.
|
||||
</summary>
|
||||
<param name="target">The target block address.</param>
|
||||
<param name="source">The source block address.</param>
|
||||
<param name="length">Length in bytes.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.WildCopy(System.Byte*,System.Byte*,System.Void*)">
|
||||
<summary>
|
||||
Copies memory block for <paramref name="source"/> to <paramref name="target"/>
|
||||
up to (around) <paramref name="limit"/>.
|
||||
It does not handle overlapping blocks and may copy up to 8 bytes more than expected.
|
||||
</summary>
|
||||
<param name="target">The target block address.</param>
|
||||
<param name="source">The source block address.</param>
|
||||
<param name="limit">The limit (in target block).</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Zero(System.Byte*,System.Int32)">
|
||||
<summary>Fill block of memory with zeroes.</summary>
|
||||
<param name="target">Address.</param>
|
||||
<param name="length">Length.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Fill(System.Byte*,System.Byte,System.Int32)">
|
||||
<summary>Fills memory block with repeating pattern of a single byte.</summary>
|
||||
<param name="target">Address.</param>
|
||||
<param name="value">A pattern.</param>
|
||||
<param name="length">Length.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.LoopCopy(System.Byte*,System.Byte*,System.Int32)">
|
||||
<summary>
|
||||
Copies memory block for <paramref name="source"/> to <paramref name="target"/>.
|
||||
This is proper implementation of memcpy (with all then weird behaviour for
|
||||
overlapping blocks). It is slower than "Copy" but may be required if "Copy"
|
||||
causes problems.
|
||||
</summary>
|
||||
<param name="target">The target block address.</param>
|
||||
<param name="source">The source block address.</param>
|
||||
<param name="length">Length in bytes.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.LoopCopyBack(System.Byte*,System.Byte*,System.Int32)">
|
||||
<summary>
|
||||
Copies memory block backwards from <paramref name="source"/> to <paramref name="target"/>.
|
||||
This is needed to implement memmove It is slower than "Move" but is needed for .NET 4.5,
|
||||
which does not implement Buffer.MemoryCopy.
|
||||
</summary>
|
||||
<param name="target">The target block address.</param>
|
||||
<param name="source">The source block address.</param>
|
||||
<param name="length">Length in bytes.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.LoopMove(System.Byte*,System.Byte*,System.Int32)">
|
||||
<summary>
|
||||
Moves memory block for <paramref name="source"/> to <paramref name="target"/>.
|
||||
It handles overlapping block properly.
|
||||
</summary>
|
||||
<param name="target">The target block address.</param>
|
||||
<param name="source">The source block address.</param>
|
||||
<param name="length">Length in bytes.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Copy8(System.Byte*,System.Byte*)">
|
||||
<summary>Copies exactly 8 bytes from source to target.</summary>
|
||||
<param name="target">Target address.</param>
|
||||
<param name="source">Source address.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Copy16(System.Byte*,System.Byte*)">
|
||||
<summary>Copies exactly 16 bytes from source to target.</summary>
|
||||
<param name="target">Target address.</param>
|
||||
<param name="source">Source address.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Copy18(System.Byte*,System.Byte*)">
|
||||
<summary>Copies exactly 18 bytes from source to target.</summary>
|
||||
<param name="target">Target address.</param>
|
||||
<param name="source">Source address.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Alloc(System.Int32)">
|
||||
<summary>Allocated block of memory. It is NOT initialized with zeroes.</summary>
|
||||
<param name="size">Size in bytes.</param>
|
||||
<returns>Pointer to allocated block.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.AllocZero(System.Int32)">
|
||||
<summary>Allocated block of memory and fills it with zeroes.</summary>
|
||||
<param name="size">Size in bytes.</param>
|
||||
<returns>Pointer to allocated block.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Free(System.Void*)">
|
||||
<summary>
|
||||
Free memory allocated previously with <see cref="M:K4os.Compression.LZ4.Internal.Mem.Alloc(System.Int32)"/> or <see cref="M:K4os.Compression.LZ4.Internal.Mem.AllocZero(System.Int32)"/>
|
||||
</summary>
|
||||
<param name="ptr"></param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Peek8(System.Void*)">
|
||||
<summary>Reads exactly 1 byte from given address.</summary>
|
||||
<param name="p">Address.</param>
|
||||
<returns>Byte at given address.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Peek16(System.Void*)">
|
||||
<summary>Reads exactly 2 bytes from given address.</summary>
|
||||
<param name="p">Address.</param>
|
||||
<returns>2 bytes at given address.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Peek32(System.Void*)">
|
||||
<summary>Reads exactly 4 bytes from given address.</summary>
|
||||
<param name="p">Address.</param>
|
||||
<returns>4 bytes at given address.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Peek64(System.Void*)">
|
||||
<summary>Reads exactly 8 bytes from given address.</summary>
|
||||
<param name="p">Address.</param>
|
||||
<returns>8 bytes at given address.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Poke8(System.Void*,System.Byte)">
|
||||
<summary>Writes exactly 1 byte to given address.</summary>
|
||||
<param name="p">Address.</param>
|
||||
<param name="v">Value.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Poke16(System.Void*,System.UInt16)">
|
||||
<summary>Writes exactly 2 bytes to given address.</summary>
|
||||
<param name="p">Address.</param>
|
||||
<param name="v">Value.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Poke32(System.Void*,System.UInt32)">
|
||||
<summary>Writes exactly 4 bytes to given address.</summary>
|
||||
<param name="p">Address.</param>
|
||||
<param name="v">Value.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Poke64(System.Void*,System.UInt64)">
|
||||
<summary>Writes exactly 8 bytes to given address.</summary>
|
||||
<param name="p">Address.</param>
|
||||
<param name="v">Value.</param>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Internal.UnmanagedResources">
|
||||
<summary>
|
||||
Skeleton for class with unmanaged resources.
|
||||
Implements <see cref="T:System.IDisposable"/> but also handles proper release in
|
||||
case <see cref="M:K4os.Compression.LZ4.Internal.UnmanagedResources.Dispose"/> was not called.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Internal.UnmanagedResources.IsDisposed">
|
||||
<summary>Determines if object was already disposed.</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.UnmanagedResources.ThrowIfDisposed">
|
||||
<summary>Throws exception is object has been disposed already. Convenience method.</summary>
|
||||
<exception cref="T:System.ObjectDisposedException">Thrown if object is already disposed.</exception>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.UnmanagedResources.ReleaseUnmanaged">
|
||||
<summary>Method releasing unmanaged resources.</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.UnmanagedResources.ReleaseManaged">
|
||||
<summary>Method releasing managed resources.</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.UnmanagedResources.Dispose(System.Boolean)">
|
||||
<summary>
|
||||
Disposed resources.
|
||||
</summary>
|
||||
<param name="disposing"><c>true</c> if dispose was explicitly called,
|
||||
<c>false</c> if called from GC.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.UnmanagedResources.Dispose">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.UnmanagedResources.Finalize">
|
||||
<summary>Destructor.</summary>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.LZ4Codec">
|
||||
<summary>
|
||||
Static class exposing LZ4 block compression methods.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Codec.MaximumOutputSize(System.Int32)">
|
||||
<summary>Maximum size after compression.</summary>
|
||||
<param name="length">Length of input buffer.</param>
|
||||
<returns>Maximum length after compression.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Codec.Encode(System.Byte*,System.Int32,System.Byte*,System.Int32,K4os.Compression.LZ4.LZ4Level)">
|
||||
<summary>Compresses data from one buffer into another.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<param name="sourceLength">Length of input buffer.</param>
|
||||
<param name="target">Output buffer.</param>
|
||||
<param name="targetLength">Output buffer length.</param>
|
||||
<param name="level">Compression level.</param>
|
||||
<returns>Number of bytes written, or negative value if output buffer is too small.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Codec.Encode(System.ReadOnlySpan{System.Byte},System.Span{System.Byte},K4os.Compression.LZ4.LZ4Level)">
|
||||
<summary>Compresses data from one buffer into another.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<param name="target">Output buffer.</param>
|
||||
<param name="level">Compression level.</param>
|
||||
<returns>Number of bytes written, or negative value if output buffer is too small.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Codec.Encode(System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32,System.Int32,K4os.Compression.LZ4.LZ4Level)">
|
||||
<summary>Compresses data from one buffer into another.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<param name="sourceOffset">Input buffer offset.</param>
|
||||
<param name="sourceLength">Input buffer length.</param>
|
||||
<param name="target">Output buffer.</param>
|
||||
<param name="targetOffset">Output buffer offset.</param>
|
||||
<param name="targetLength">Output buffer length.</param>
|
||||
<param name="level">Compression level.</param>
|
||||
<returns>Number of bytes written, or negative value if output buffer is too small.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Codec.Decode(System.Byte*,System.Int32,System.Byte*,System.Int32)">
|
||||
<summary>Decompresses data from given buffer.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<param name="sourceLength">Input buffer length.</param>
|
||||
<param name="target">Output buffer.</param>
|
||||
<param name="targetLength">Output buffer length.</param>
|
||||
<returns>Number of bytes written, or negative value if output buffer is too small.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Codec.Decode(System.ReadOnlySpan{System.Byte},System.Span{System.Byte})">
|
||||
<summary>Decompresses data from given buffer.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<param name="target">Output buffer.</param>
|
||||
<returns>Number of bytes written, or negative value if output buffer is too small.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Codec.Decode(System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32,System.Int32)">
|
||||
<summary>Decompresses data from given buffer.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<param name="sourceOffset">Input buffer offset.</param>
|
||||
<param name="sourceLength">Input buffer length.</param>
|
||||
<param name="target">Output buffer.</param>
|
||||
<param name="targetOffset">Output buffer offset.</param>
|
||||
<param name="targetLength">Output buffer length.</param>
|
||||
<returns>Number of bytes written, or negative value if output buffer is too small.</returns>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.LZ4Level">
|
||||
<summary>Compression level.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.LZ4Level.L00_FAST">
|
||||
<summary>Fast compression.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.LZ4Level.L03_HC">
|
||||
<summary>High compression, level 3.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.LZ4Level.L04_HC">
|
||||
<summary>High compression, level 4.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.LZ4Level.L05_HC">
|
||||
<summary>High compression, level 5.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.LZ4Level.L06_HC">
|
||||
<summary>High compression, level 6.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.LZ4Level.L07_HC">
|
||||
<summary>High compression, level 7.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.LZ4Level.L08_HC">
|
||||
<summary>High compression, level 8.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.LZ4Level.L09_HC">
|
||||
<summary>High compression, level 9.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.LZ4Level.L10_OPT">
|
||||
<summary>Optimal compression, level 10.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.LZ4Level.L11_OPT">
|
||||
<summary>Optimal compression, level 11.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.LZ4Level.L12_MAX">
|
||||
<summary>Maximum compression, level 12.</summary>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.LZ4Pickler">
|
||||
<summary>
|
||||
Pickling support with LZ4 compression.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Pickler.Pickle(System.Byte[],K4os.Compression.LZ4.LZ4Level)">
|
||||
<summary>Compresses input buffer into self-contained package.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<param name="level">Compression level.</param>
|
||||
<returns>Output buffer.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Pickler.Pickle(System.Byte[],System.Int32,System.Int32,K4os.Compression.LZ4.LZ4Level)">
|
||||
<summary>Compresses input buffer into self-contained package.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<param name="sourceOffset">Input buffer offset.</param>
|
||||
<param name="sourceLength">Input buffer length.</param>
|
||||
<param name="level">Compression level.</param>
|
||||
<returns>Output buffer.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Pickler.Pickle(System.ReadOnlySpan{System.Byte},K4os.Compression.LZ4.LZ4Level)">
|
||||
<summary>Compresses input buffer into self-contained package.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<param name="level">Compression level.</param>
|
||||
<returns>Output buffer.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Pickler.Pickle(System.Byte*,System.Int32,K4os.Compression.LZ4.LZ4Level)">
|
||||
<summary>Compresses input buffer into self-contained package.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<param name="sourceLength">Length of input data.</param>
|
||||
<param name="level">Compression level.</param>
|
||||
<returns>Output buffer.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Pickler.Unpickle(System.Byte[])">
|
||||
<summary>Decompresses previously pickled buffer (see: <see cref="T:K4os.Compression.LZ4.LZ4Pickler"/>.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<returns>Output buffer.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Pickler.Unpickle(System.Byte[],System.Int32,System.Int32)">
|
||||
<summary>Decompresses previously pickled buffer (see: <see cref="T:K4os.Compression.LZ4.LZ4Pickler"/>.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<param name="sourceOffset">Input buffer offset.</param>
|
||||
<param name="sourceLength">Input buffer length.</param>
|
||||
<returns>Output buffer.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Pickler.Unpickle(System.ReadOnlySpan{System.Byte})">
|
||||
<summary>Decompresses previously pickled buffer (see: <see cref="T:K4os.Compression.LZ4.LZ4Pickler"/>.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<returns>Output buffer.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Pickler.Unpickle(System.Byte*,System.Int32)">
|
||||
<summary>Decompresses previously pickled buffer (see: <see cref="T:K4os.Compression.LZ4.LZ4Pickler"/>.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<param name="sourceLength">Input buffer length.</param>
|
||||
<returns>Output buffer.</returns>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Vendored
BIN
Binary file not shown.
Vendored
+794
@@ -0,0 +1,794 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>K4os.Compression.LZ4</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:K4os.Compression.LZ4.Encoders.EncoderAction">
|
||||
<summary>
|
||||
Action performed by encoder using <c>FlushAndEncode</c> method.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Encoders.EncoderAction.None">
|
||||
<summary>Nothing has happened, most likely loading 0 bytes.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Encoders.EncoderAction.Loaded">
|
||||
<summary>Some bytes has been loaded into encoder.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Encoders.EncoderAction.Copied">
|
||||
<summary>Compression was not possible so bytes has been copied.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Encoders.EncoderAction.Encoded">
|
||||
<summary>Compression succeeded.</summary>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Encoders.ILZ4Decoder">
|
||||
<summary>
|
||||
Interface of LZ4 decoder used by LZ4 streams.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Encoders.ILZ4Decoder.BlockSize">
|
||||
<summary>Block size.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Encoders.ILZ4Decoder.BytesReady">
|
||||
<summary>Bytes already decoded and available to be read.
|
||||
Always smaller than <see cref="P:K4os.Compression.LZ4.Encoders.ILZ4Decoder.BlockSize"/></summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.ILZ4Decoder.Decode(System.Byte*,System.Int32,System.Int32)">
|
||||
<summary>
|
||||
Decodes previously compressed block and caches decompressed block in decoder.
|
||||
Returns number of bytes decoded. These bytes can be read with <see cref="M:K4os.Compression.LZ4.Encoders.ILZ4Decoder.Drain(System.Byte*,System.Int32,System.Int32)" />.
|
||||
</summary>
|
||||
<param name="source">Points to compressed block.</param>
|
||||
<param name="length">Length of compressed block.</param>
|
||||
<param name="blockSize">Size of the block. Value <c>0</c> indicates default block size.</param>
|
||||
<returns>Number of decoded bytes.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.ILZ4Decoder.Inject(System.Byte*,System.Int32)">
|
||||
<summary>
|
||||
Inject already decompressed block and caches it in decoder.
|
||||
Used with uncompressed-yet-chained blocks and pre-made dictionaries.
|
||||
These bytes can be read with <see cref="M:K4os.Compression.LZ4.Encoders.ILZ4Decoder.Drain(System.Byte*,System.Int32,System.Int32)" />.
|
||||
</summary>
|
||||
<param name="source">Points to uncompressed block.</param>
|
||||
<param name="length">Length of uncompressed block.</param>
|
||||
<returns>Number of decoded bytes.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.ILZ4Decoder.Drain(System.Byte*,System.Int32,System.Int32)">
|
||||
<summary>
|
||||
Reads previously decoded bytes. Please note, <paramref name="offset"/> should be
|
||||
negative number, pointing to bytes before current head.
|
||||
</summary>
|
||||
<param name="target">Buffer to write to.</param>
|
||||
<param name="offset">Offset in source buffer relatively to current head.
|
||||
Please note, it should be negative value.</param>
|
||||
<param name="length">Number of bytes to read.</param>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Encoders.ILZ4Encoder">
|
||||
<summary>
|
||||
Interface of LZ4 encoder used by LZ4 streams.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Encoders.ILZ4Encoder.BlockSize">
|
||||
<summary>Block size.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Encoders.ILZ4Encoder.BytesReady">
|
||||
<summary>Number of bytes read for compression.
|
||||
Always smaller than <see cref="P:K4os.Compression.LZ4.Encoders.ILZ4Encoder.BlockSize"/></summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.ILZ4Encoder.Topup(System.Byte*,System.Int32)">
|
||||
<summary>Adds bytes to internal buffer. Increases <see cref="P:K4os.Compression.LZ4.Encoders.ILZ4Encoder.BytesReady"/></summary>
|
||||
<param name="source">Source buffer.</param>
|
||||
<param name="length">Source buffer length.</param>
|
||||
<returns>Number of bytes topped up. If this function returns 0 it means that buffer
|
||||
is full (<see cref="P:K4os.Compression.LZ4.Encoders.ILZ4Encoder.BytesReady"/> equals <see cref="P:K4os.Compression.LZ4.Encoders.ILZ4Encoder.BlockSize"/>) and
|
||||
<see cref="M:K4os.Compression.LZ4.Encoders.ILZ4Encoder.Encode(System.Byte*,System.Int32,System.Boolean)"/> should be called to flush it.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.ILZ4Encoder.Encode(System.Byte*,System.Int32,System.Boolean)">
|
||||
<summary>
|
||||
Encodes bytes in internal buffer (see: <see cref="P:K4os.Compression.LZ4.Encoders.ILZ4Encoder.BytesReady"/>, <see cref="M:K4os.Compression.LZ4.Encoders.ILZ4Encoder.Topup(System.Byte*,System.Int32)"/>).
|
||||
If <paramref name="allowCopy"/> is <c>true</c> then if encoded buffer is bigger than
|
||||
source buffer source bytes are copied instead. In such case returned length is negative.
|
||||
</summary>
|
||||
<param name="target">Target buffer.</param>
|
||||
<param name="length">Target buffer length.</param>
|
||||
<param name="allowCopy">Indicates if copying is allowed.</param>
|
||||
<returns>Length of encoded buffer. Negative if bytes are just copied.</returns>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Encoders.LZ4BlockDecoder">
|
||||
<summary>
|
||||
LZ4 decoder used with independent blocks mode. Plase note, that it will fail
|
||||
if input data has been compressed with chained blocks
|
||||
(<see cref="T:K4os.Compression.LZ4.Encoders.LZ4FastChainEncoder"/> and <see cref="T:K4os.Compression.LZ4.Encoders.LZ4HighChainEncoder"/>)
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Encoders.LZ4BlockDecoder.BlockSize">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Encoders.LZ4BlockDecoder.BytesReady">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4BlockDecoder.#ctor(System.Int32)">
|
||||
<summary>Creates new instance of block decoder.</summary>
|
||||
<param name="blockSize">Block size. Must be equal or greater to one used for compression.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4BlockDecoder.Decode(System.Byte*,System.Int32,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4BlockDecoder.Inject(System.Byte*,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4BlockDecoder.Drain(System.Byte*,System.Int32,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4BlockDecoder.ReleaseUnmanaged">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Encoders.LZ4BlockEncoder">
|
||||
<summary>
|
||||
Independent block encoder. Produces larger files but uses less memory and
|
||||
gives better performance.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4BlockEncoder.#ctor(K4os.Compression.LZ4.LZ4Level,System.Int32)">
|
||||
<summary>Creates new instance of <see cref="T:K4os.Compression.LZ4.Encoders.LZ4BlockEncoder"/></summary>
|
||||
<param name="level">Compression level.</param>
|
||||
<param name="blockSize">Block size.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4BlockEncoder.EncodeBlock(System.Byte*,System.Int32,System.Byte*,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4BlockEncoder.CopyDict(System.Byte*,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Encoders.LZ4ChainDecoder">
|
||||
<summary>LZ4 decoder handling dependent blocks.</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4ChainDecoder.#ctor(System.Int32,System.Int32)">
|
||||
<summary>Creates new instance of <see cref="T:K4os.Compression.LZ4.Encoders.LZ4ChainDecoder"/>.</summary>
|
||||
<param name="blockSize">Block size.</param>
|
||||
<param name="extraBlocks">Number of extra blocks.</param>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Encoders.LZ4ChainDecoder.BlockSize">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Encoders.LZ4ChainDecoder.BytesReady">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4ChainDecoder.Decode(System.Byte*,System.Int32,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4ChainDecoder.Inject(System.Byte*,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4ChainDecoder.Drain(System.Byte*,System.Int32,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4ChainDecoder.ReleaseUnmanaged">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Encoders.LZ4Decoder">
|
||||
<summary>
|
||||
Static class with factory methods to create LZ4 decoders.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4Decoder.Create(System.Boolean,System.Int32,System.Int32)">
|
||||
<summary>Creates appropriate decoder for given parameters.</summary>
|
||||
<param name="chaining">Dependent blocks.</param>
|
||||
<param name="blockSize">Block size.</param>
|
||||
<param name="extraBlocks">Number of extra blocks.</param>
|
||||
<returns>LZ4 decoder.</returns>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Encoders.LZ4Encoder">
|
||||
<summary>
|
||||
Static class with factory method to create LZ4 encoders.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4Encoder.Create(System.Boolean,K4os.Compression.LZ4.LZ4Level,System.Int32,System.Int32)">
|
||||
<summary>Creates appropriate decoder for given parameters.</summary>
|
||||
<param name="chaining">Dependent blocks.</param>
|
||||
<param name="level">Compression level.</param>
|
||||
<param name="blockSize">Block size.</param>
|
||||
<param name="extraBlocks">Number of extra blocks.</param>
|
||||
<returns>LZ4 encoder.</returns>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Encoders.LZ4EncoderBase">
|
||||
<summary>
|
||||
Base class for LZ4 encoders. Provides basic functionality shared by
|
||||
<see cref="T:K4os.Compression.LZ4.Encoders.LZ4BlockEncoder"/>, <see cref="T:K4os.Compression.LZ4.Encoders.LZ4FastChainEncoder"/>,
|
||||
and <see cref="T:K4os.Compression.LZ4.Encoders.LZ4HighChainEncoder"/> encoders. Do not used directly.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderBase.#ctor(System.Boolean,System.Int32,System.Int32)">
|
||||
<summary>Creates new instance of encoder.</summary>
|
||||
<param name="chaining">Needs to be <c>true</c> if using dependent blocks.</param>
|
||||
<param name="blockSize">Block size.</param>
|
||||
<param name="extraBlocks">Number of extra blocks.</param>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Encoders.LZ4EncoderBase.BlockSize">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Encoders.LZ4EncoderBase.BytesReady">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderBase.Topup(System.Byte*,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderBase.Encode(System.Byte*,System.Int32,System.Boolean)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderBase.EncodeBlock(System.Byte*,System.Int32,System.Byte*,System.Int32)">
|
||||
<summary>Encodes single block using appropriate algorithm.</summary>
|
||||
<param name="source">Source buffer.</param>
|
||||
<param name="sourceLength">Source buffer length.</param>
|
||||
<param name="target">Target buffer.</param>
|
||||
<param name="targetLength">Target buffer length.</param>
|
||||
<returns>Number of bytes actually written to target buffer.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderBase.CopyDict(System.Byte*,System.Int32)">
|
||||
<summary>Copies current dictionary.</summary>
|
||||
<param name="target">Target buffer.</param>
|
||||
<param name="dictionaryLength">Dictionary length.</param>
|
||||
<returns>Dictionary length.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderBase.ReleaseUnmanaged">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions">
|
||||
<summary>
|
||||
Functionality of encoders added on top of fixed interface.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.Topup(K4os.Compression.LZ4.Encoders.ILZ4Encoder,System.Byte*@,System.Int32)">
|
||||
<summary>Tops encoder up with some data.</summary>
|
||||
<param name="encoder">Encoder.</param>
|
||||
<param name="source">Buffer pointer, will be shifted after operation by the number of
|
||||
bytes actually loaded.</param>
|
||||
<param name="length">Length of buffer.</param>
|
||||
<returns><c>true</c> if buffer was topped up, <c>false</c> if no bytes were loaded.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.Topup(K4os.Compression.LZ4.Encoders.ILZ4Encoder,System.Byte[],System.Int32,System.Int32)">
|
||||
<summary>Tops encoder up with some data.</summary>
|
||||
<param name="encoder">Encoder.</param>
|
||||
<param name="source">Buffer.</param>
|
||||
<param name="offset">Buffer offset.</param>
|
||||
<param name="length">Length of buffer.</param>
|
||||
<returns>Number of bytes actually loaded.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.Topup(K4os.Compression.LZ4.Encoders.ILZ4Encoder,System.Byte[],System.Int32@,System.Int32)">
|
||||
<summary>Tops encoder up with some data.</summary>
|
||||
<param name="encoder">Encoder.</param>
|
||||
<param name="source">Buffer.</param>
|
||||
<param name="offset">Buffer offset, will be increased after operation by the number
|
||||
of bytes actually loaded.</param>
|
||||
<param name="length">Length of buffer.</param>
|
||||
<returns><c>true</c> if buffer was topped up, <c>false</c> if no bytes were loaded.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.Encode(K4os.Compression.LZ4.Encoders.ILZ4Encoder,System.Byte[],System.Int32,System.Int32,System.Boolean)">
|
||||
<summary>Encodes all bytes currently stored in encoder into target buffer.</summary>
|
||||
<param name="encoder">Encoder.</param>
|
||||
<param name="target">Target buffer.</param>
|
||||
<param name="offset">Offset in target buffer.</param>
|
||||
<param name="length">Length of target buffer.</param>
|
||||
<param name="allowCopy">if <c>true</c> copying bytes is allowed.</param>
|
||||
<returns>Number of bytes encoder. If bytes were copied than this value is negative.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.Encode(K4os.Compression.LZ4.Encoders.ILZ4Encoder,System.Byte[],System.Int32@,System.Int32,System.Boolean)">
|
||||
<summary>Encodes all bytes currently stored in encoder into target buffer.</summary>
|
||||
<param name="encoder">Encoder.</param>
|
||||
<param name="target">Target buffer.</param>
|
||||
<param name="offset">Offset in target buffer. Will be updated after operation.</param>
|
||||
<param name="length">Length of target buffer.</param>
|
||||
<param name="allowCopy">if <c>true</c> copying bytes is allowed.</param>
|
||||
<returns>Result of this action. Bytes can be Copied (<see cref="F:K4os.Compression.LZ4.Encoders.EncoderAction.Copied"/>),
|
||||
Encoded (<see cref="F:K4os.Compression.LZ4.Encoders.EncoderAction.Encoded"/>) or nothing could have
|
||||
happened (<see cref="F:K4os.Compression.LZ4.Encoders.EncoderAction.None"/>).</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.Encode(K4os.Compression.LZ4.Encoders.ILZ4Encoder,System.Byte*@,System.Int32,System.Boolean)">
|
||||
<summary>Encodes all bytes currently stored in encoder into target buffer.</summary>
|
||||
<param name="encoder">Encoder.</param>
|
||||
<param name="target">Target buffer. Will be updated after operation.</param>
|
||||
<param name="length">Length of buffer.</param>
|
||||
<param name="allowCopy">if <c>true</c> copying bytes is allowed.</param>
|
||||
<returns>Result of this action. Bytes can be Copied (<see cref="F:K4os.Compression.LZ4.Encoders.EncoderAction.Copied"/>),
|
||||
Encoded (<see cref="F:K4os.Compression.LZ4.Encoders.EncoderAction.Encoded"/>) or nothing could have
|
||||
happened (<see cref="F:K4os.Compression.LZ4.Encoders.EncoderAction.None"/>).</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.TopupAndEncode(K4os.Compression.LZ4.Encoders.ILZ4Encoder,System.Byte*,System.Int32,System.Byte*,System.Int32,System.Boolean,System.Boolean,System.Int32@,System.Int32@)">
|
||||
<summary>Tops encoder and encodes content.</summary>
|
||||
<param name="encoder">Encoder.</param>
|
||||
<param name="source">Source buffer (used to top up from).</param>
|
||||
<param name="sourceLength">Source buffer length.</param>
|
||||
<param name="target">Target buffer (used to encode into)</param>
|
||||
<param name="targetLength">Target buffer length.</param>
|
||||
<param name="forceEncode">Forces encoding even if encoder is not full.</param>
|
||||
<param name="allowCopy">Allows to copy bytes if compression was not possible.</param>
|
||||
<param name="loaded">Number of bytes loaded (topped up)</param>
|
||||
<param name="encoded">Number if bytes encoded or copied.
|
||||
Value is 0 if no encoding was done.</param>
|
||||
<returns>Action performed.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.TopupAndEncode(K4os.Compression.LZ4.Encoders.ILZ4Encoder,System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32,System.Int32,System.Boolean,System.Boolean,System.Int32@,System.Int32@)">
|
||||
<summary>Tops encoder and encodes content.</summary>
|
||||
<param name="encoder">Encoder.</param>
|
||||
<param name="source">Source buffer (used to top up from).</param>
|
||||
<param name="sourceOffset">Offset within source buffer.</param>
|
||||
<param name="sourceLength">Source buffer length.</param>
|
||||
<param name="target">Target buffer (used to encode into)</param>
|
||||
<param name="targetOffset">Offset within target buffer.</param>
|
||||
<param name="targetLength">Target buffer length.</param>
|
||||
<param name="forceEncode">Forces encoding even if encoder is not full.</param>
|
||||
<param name="allowCopy">Allows to copy bytes if compression was not possible.</param>
|
||||
<param name="loaded">Number of bytes loaded (topped up)</param>
|
||||
<param name="encoded">Number if bytes encoded or copied.
|
||||
Value is 0 if no encoding was done.</param>
|
||||
<returns>Action performed.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.FlushAndEncode(K4os.Compression.LZ4.Encoders.ILZ4Encoder,System.Byte*,System.Int32,System.Boolean,System.Int32@)">
|
||||
<summary>Encoded remaining bytes in encoder.</summary>
|
||||
<param name="encoder">Encoder.</param>
|
||||
<param name="target">Target buffer.</param>
|
||||
<param name="targetLength">Target buffer length.</param>
|
||||
<param name="allowCopy">Allows to copy bytes if compression was not possible.</param>
|
||||
<param name="encoded">Number if bytes encoded or copied.
|
||||
Value is 0 if no encoding was done.</param>
|
||||
<returns>Action performed.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.FlushAndEncode(K4os.Compression.LZ4.Encoders.ILZ4Encoder,System.Byte[],System.Int32,System.Int32,System.Boolean,System.Int32@)">
|
||||
<summary>Encoded remaining bytes in encoder.</summary>
|
||||
<param name="encoder">Encoder.</param>
|
||||
<param name="target">Target buffer.</param>
|
||||
<param name="targetOffset">Offset within target buffer.</param>
|
||||
<param name="targetLength">Target buffer length.</param>
|
||||
<param name="allowCopy">Allows to copy bytes if compression was not possible.</param>
|
||||
<param name="encoded">Number if bytes encoded or copied.
|
||||
Value is 0 if no encoding was done.</param>
|
||||
<returns>Action performed.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.Drain(K4os.Compression.LZ4.Encoders.ILZ4Decoder,System.Byte[],System.Int32,System.Int32,System.Int32)">
|
||||
<summary>Drains decoder by reading all bytes which are ready.</summary>
|
||||
<param name="decoder">Decoder.</param>
|
||||
<param name="target">Target buffer.</param>
|
||||
<param name="targetOffset">Offset within target buffer.</param>
|
||||
<param name="offset">Offset in decoder relatively to decoder's head.
|
||||
Please note, it should be negative value.</param>
|
||||
<param name="length">Number of bytes.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.DecodeAndDrain(K4os.Compression.LZ4.Encoders.ILZ4Decoder,System.Byte*,System.Int32,System.Byte*,System.Int32,System.Int32@)">
|
||||
<summary>Decodes data and immediately drains it into target buffer.</summary>
|
||||
<param name="decoder">Decoder.</param>
|
||||
<param name="source">Source buffer (with compressed data, to be decoded).</param>
|
||||
<param name="sourceLength">Source buffer length.</param>
|
||||
<param name="target">Target buffer (to drained into).</param>
|
||||
<param name="targetLength">Target buffer length.</param>
|
||||
<param name="decoded">Number of bytes actually decoded.</param>
|
||||
<returns><c>true</c> decoder was drained, <c>false</c> otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.DecodeAndDrain(K4os.Compression.LZ4.Encoders.ILZ4Decoder,System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32,System.Int32,System.Int32@)">
|
||||
<summary>Decodes data and immediately drains it into target buffer.</summary>
|
||||
<param name="decoder">Decoder.</param>
|
||||
<param name="source">Source buffer (with compressed data, to be decoded).</param>
|
||||
<param name="sourceOffset">Offset within source buffer.</param>
|
||||
<param name="sourceLength">Source buffer length.</param>
|
||||
<param name="target">Target buffer (to drained into).</param>
|
||||
<param name="targetOffset">Offset within target buffer.</param>
|
||||
<param name="targetLength">Target buffer length.</param>
|
||||
<param name="decoded">Number of bytes actually decoded.</param>
|
||||
<returns><c>true</c> decoder was drained, <c>false</c> otherwise.</returns>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Encoders.LZ4FastChainEncoder">
|
||||
<summary>
|
||||
LZ4 encoder using dependent blocks with fast compression.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4FastChainEncoder.#ctor(System.Int32,System.Int32)">
|
||||
<summary>Creates new instance of <see cref="T:K4os.Compression.LZ4.Encoders.LZ4FastChainEncoder"/></summary>
|
||||
<param name="blockSize">Block size.</param>
|
||||
<param name="extraBlocks">Number of extra blocks.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4FastChainEncoder.ReleaseUnmanaged">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4FastChainEncoder.EncodeBlock(System.Byte*,System.Int32,System.Byte*,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4FastChainEncoder.CopyDict(System.Byte*,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Encoders.LZ4HighChainEncoder">
|
||||
<summary>
|
||||
LZ4 encoder using dependent blocks with high compression.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4HighChainEncoder.#ctor(K4os.Compression.LZ4.LZ4Level,System.Int32,System.Int32)">
|
||||
<summary>Creates new instance of <see cref="T:K4os.Compression.LZ4.Encoders.LZ4HighChainEncoder"/></summary>
|
||||
<param name="level">Compression level.</param>
|
||||
<param name="blockSize">Block size.</param>
|
||||
<param name="extraBlocks">Number of extra blocks.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4HighChainEncoder.ReleaseUnmanaged">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4HighChainEncoder.EncodeBlock(System.Byte*,System.Int32,System.Byte*,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4HighChainEncoder.CopyDict(System.Byte*,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Internal.Mem">
|
||||
<summary>Utility class with memory related functions.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.K1">
|
||||
<summary>1 KiB</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.K2">
|
||||
<summary>2 KiB</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.K4">
|
||||
<summary>4 KiB</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.K8">
|
||||
<summary>8 KiB</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.K16">
|
||||
<summary>16 KiB</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.K32">
|
||||
<summary>32 KiB</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.K64">
|
||||
<summary>64 KiB</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.K128">
|
||||
<summary>128 KiB</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.K256">
|
||||
<summary>256 KiB</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.K512">
|
||||
<summary>512 KiB</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.M1">
|
||||
<summary>1 MiB</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.M4">
|
||||
<summary>4 MiB</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.Empty">
|
||||
<summary>Empty byte array.</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.RoundUp(System.Int32,System.Int32)">
|
||||
<summary>Rounds integer value up to nearest multiple of step.</summary>
|
||||
<param name="value">A value.</param>
|
||||
<param name="step">A step.</param>
|
||||
<returns>Value rounded up.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Copy(System.Byte*,System.Byte*,System.Int32)">
|
||||
<summary>
|
||||
Copies memory block for <paramref name="source"/> to <paramref name="target"/>.
|
||||
Even though it is called "copy" it actually behaves like "move" which
|
||||
might be potential problem, although it shouldn't as I cannot think about
|
||||
any situation when "copy" invalid behaviour (forward copy of overlapping blocks)
|
||||
can be a desired.
|
||||
</summary>
|
||||
<param name="target">The target block address.</param>
|
||||
<param name="source">The source block address.</param>
|
||||
<param name="length">Length in bytes.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Move(System.Byte*,System.Byte*,System.Int32)">
|
||||
<summary>
|
||||
Copies memory block for <paramref name="source"/> to <paramref name="target"/>.
|
||||
It handle "move" semantic properly handling overlapping blocks properly.
|
||||
</summary>
|
||||
<param name="target">The target block address.</param>
|
||||
<param name="source">The source block address.</param>
|
||||
<param name="length">Length in bytes.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.WildCopy(System.Byte*,System.Byte*,System.Void*)">
|
||||
<summary>
|
||||
Copies memory block for <paramref name="source"/> to <paramref name="target"/>
|
||||
up to (around) <paramref name="limit"/>.
|
||||
It does not handle overlapping blocks and may copy up to 8 bytes more than expected.
|
||||
</summary>
|
||||
<param name="target">The target block address.</param>
|
||||
<param name="source">The source block address.</param>
|
||||
<param name="limit">The limit (in target block).</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Zero(System.Byte*,System.Int32)">
|
||||
<summary>Fill block of memory with zeroes.</summary>
|
||||
<param name="target">Address.</param>
|
||||
<param name="length">Length.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Fill(System.Byte*,System.Byte,System.Int32)">
|
||||
<summary>Fills memory block with repeating pattern of a single byte.</summary>
|
||||
<param name="target">Address.</param>
|
||||
<param name="value">A pattern.</param>
|
||||
<param name="length">Length.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.LoopCopy(System.Byte*,System.Byte*,System.Int32)">
|
||||
<summary>
|
||||
Copies memory block for <paramref name="source"/> to <paramref name="target"/>.
|
||||
This is proper implementation of memcpy (with all then weird behaviour for
|
||||
overlapping blocks). It is slower than "Copy" but may be required if "Copy"
|
||||
causes problems.
|
||||
</summary>
|
||||
<param name="target">The target block address.</param>
|
||||
<param name="source">The source block address.</param>
|
||||
<param name="length">Length in bytes.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.LoopCopyBack(System.Byte*,System.Byte*,System.Int32)">
|
||||
<summary>
|
||||
Copies memory block backwards from <paramref name="source"/> to <paramref name="target"/>.
|
||||
This is needed to implement memmove It is slower than "Move" but is needed for .NET 4.5,
|
||||
which does not implement Buffer.MemoryCopy.
|
||||
</summary>
|
||||
<param name="target">The target block address.</param>
|
||||
<param name="source">The source block address.</param>
|
||||
<param name="length">Length in bytes.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.LoopMove(System.Byte*,System.Byte*,System.Int32)">
|
||||
<summary>
|
||||
Moves memory block for <paramref name="source"/> to <paramref name="target"/>.
|
||||
It handles overlapping block properly.
|
||||
</summary>
|
||||
<param name="target">The target block address.</param>
|
||||
<param name="source">The source block address.</param>
|
||||
<param name="length">Length in bytes.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Copy8(System.Byte*,System.Byte*)">
|
||||
<summary>Copies exactly 8 bytes from source to target.</summary>
|
||||
<param name="target">Target address.</param>
|
||||
<param name="source">Source address.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Copy16(System.Byte*,System.Byte*)">
|
||||
<summary>Copies exactly 16 bytes from source to target.</summary>
|
||||
<param name="target">Target address.</param>
|
||||
<param name="source">Source address.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Copy18(System.Byte*,System.Byte*)">
|
||||
<summary>Copies exactly 18 bytes from source to target.</summary>
|
||||
<param name="target">Target address.</param>
|
||||
<param name="source">Source address.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Alloc(System.Int32)">
|
||||
<summary>Allocated block of memory. It is NOT initialized with zeroes.</summary>
|
||||
<param name="size">Size in bytes.</param>
|
||||
<returns>Pointer to allocated block.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.AllocZero(System.Int32)">
|
||||
<summary>Allocated block of memory and fills it with zeroes.</summary>
|
||||
<param name="size">Size in bytes.</param>
|
||||
<returns>Pointer to allocated block.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Free(System.Void*)">
|
||||
<summary>
|
||||
Free memory allocated previously with <see cref="M:K4os.Compression.LZ4.Internal.Mem.Alloc(System.Int32)"/> or <see cref="M:K4os.Compression.LZ4.Internal.Mem.AllocZero(System.Int32)"/>
|
||||
</summary>
|
||||
<param name="ptr"></param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Peek8(System.Void*)">
|
||||
<summary>Reads exactly 1 byte from given address.</summary>
|
||||
<param name="p">Address.</param>
|
||||
<returns>Byte at given address.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Peek16(System.Void*)">
|
||||
<summary>Reads exactly 2 bytes from given address.</summary>
|
||||
<param name="p">Address.</param>
|
||||
<returns>2 bytes at given address.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Peek32(System.Void*)">
|
||||
<summary>Reads exactly 4 bytes from given address.</summary>
|
||||
<param name="p">Address.</param>
|
||||
<returns>4 bytes at given address.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Peek64(System.Void*)">
|
||||
<summary>Reads exactly 8 bytes from given address.</summary>
|
||||
<param name="p">Address.</param>
|
||||
<returns>8 bytes at given address.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Poke8(System.Void*,System.Byte)">
|
||||
<summary>Writes exactly 1 byte to given address.</summary>
|
||||
<param name="p">Address.</param>
|
||||
<param name="v">Value.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Poke16(System.Void*,System.UInt16)">
|
||||
<summary>Writes exactly 2 bytes to given address.</summary>
|
||||
<param name="p">Address.</param>
|
||||
<param name="v">Value.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Poke32(System.Void*,System.UInt32)">
|
||||
<summary>Writes exactly 4 bytes to given address.</summary>
|
||||
<param name="p">Address.</param>
|
||||
<param name="v">Value.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Poke64(System.Void*,System.UInt64)">
|
||||
<summary>Writes exactly 8 bytes to given address.</summary>
|
||||
<param name="p">Address.</param>
|
||||
<param name="v">Value.</param>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Internal.UnmanagedResources">
|
||||
<summary>
|
||||
Skeleton for class with unmanaged resources.
|
||||
Implements <see cref="T:System.IDisposable"/> but also handles proper release in
|
||||
case <see cref="M:K4os.Compression.LZ4.Internal.UnmanagedResources.Dispose"/> was not called.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Internal.UnmanagedResources.IsDisposed">
|
||||
<summary>Determines if object was already disposed.</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.UnmanagedResources.ThrowIfDisposed">
|
||||
<summary>Throws exception is object has been disposed already. Convenience method.</summary>
|
||||
<exception cref="T:System.ObjectDisposedException">Thrown if object is already disposed.</exception>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.UnmanagedResources.ReleaseUnmanaged">
|
||||
<summary>Method releasing unmanaged resources.</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.UnmanagedResources.ReleaseManaged">
|
||||
<summary>Method releasing managed resources.</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.UnmanagedResources.Dispose(System.Boolean)">
|
||||
<summary>
|
||||
Disposed resources.
|
||||
</summary>
|
||||
<param name="disposing"><c>true</c> if dispose was explicitly called,
|
||||
<c>false</c> if called from GC.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.UnmanagedResources.Dispose">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.UnmanagedResources.Finalize">
|
||||
<summary>Destructor.</summary>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.LZ4Codec">
|
||||
<summary>
|
||||
Static class exposing LZ4 block compression methods.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Codec.MaximumOutputSize(System.Int32)">
|
||||
<summary>Maximum size after compression.</summary>
|
||||
<param name="length">Length of input buffer.</param>
|
||||
<returns>Maximum length after compression.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Codec.Encode(System.Byte*,System.Int32,System.Byte*,System.Int32,K4os.Compression.LZ4.LZ4Level)">
|
||||
<summary>Compresses data from one buffer into another.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<param name="sourceLength">Length of input buffer.</param>
|
||||
<param name="target">Output buffer.</param>
|
||||
<param name="targetLength">Output buffer length.</param>
|
||||
<param name="level">Compression level.</param>
|
||||
<returns>Number of bytes written, or negative value if output buffer is too small.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Codec.Encode(System.ReadOnlySpan{System.Byte},System.Span{System.Byte},K4os.Compression.LZ4.LZ4Level)">
|
||||
<summary>Compresses data from one buffer into another.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<param name="target">Output buffer.</param>
|
||||
<param name="level">Compression level.</param>
|
||||
<returns>Number of bytes written, or negative value if output buffer is too small.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Codec.Encode(System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32,System.Int32,K4os.Compression.LZ4.LZ4Level)">
|
||||
<summary>Compresses data from one buffer into another.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<param name="sourceOffset">Input buffer offset.</param>
|
||||
<param name="sourceLength">Input buffer length.</param>
|
||||
<param name="target">Output buffer.</param>
|
||||
<param name="targetOffset">Output buffer offset.</param>
|
||||
<param name="targetLength">Output buffer length.</param>
|
||||
<param name="level">Compression level.</param>
|
||||
<returns>Number of bytes written, or negative value if output buffer is too small.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Codec.Decode(System.Byte*,System.Int32,System.Byte*,System.Int32)">
|
||||
<summary>Decompresses data from given buffer.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<param name="sourceLength">Input buffer length.</param>
|
||||
<param name="target">Output buffer.</param>
|
||||
<param name="targetLength">Output buffer length.</param>
|
||||
<returns>Number of bytes written, or negative value if output buffer is too small.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Codec.Decode(System.ReadOnlySpan{System.Byte},System.Span{System.Byte})">
|
||||
<summary>Decompresses data from given buffer.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<param name="target">Output buffer.</param>
|
||||
<returns>Number of bytes written, or negative value if output buffer is too small.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Codec.Decode(System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32,System.Int32)">
|
||||
<summary>Decompresses data from given buffer.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<param name="sourceOffset">Input buffer offset.</param>
|
||||
<param name="sourceLength">Input buffer length.</param>
|
||||
<param name="target">Output buffer.</param>
|
||||
<param name="targetOffset">Output buffer offset.</param>
|
||||
<param name="targetLength">Output buffer length.</param>
|
||||
<returns>Number of bytes written, or negative value if output buffer is too small.</returns>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.LZ4Level">
|
||||
<summary>Compression level.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.LZ4Level.L00_FAST">
|
||||
<summary>Fast compression.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.LZ4Level.L03_HC">
|
||||
<summary>High compression, level 3.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.LZ4Level.L04_HC">
|
||||
<summary>High compression, level 4.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.LZ4Level.L05_HC">
|
||||
<summary>High compression, level 5.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.LZ4Level.L06_HC">
|
||||
<summary>High compression, level 6.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.LZ4Level.L07_HC">
|
||||
<summary>High compression, level 7.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.LZ4Level.L08_HC">
|
||||
<summary>High compression, level 8.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.LZ4Level.L09_HC">
|
||||
<summary>High compression, level 9.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.LZ4Level.L10_OPT">
|
||||
<summary>Optimal compression, level 10.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.LZ4Level.L11_OPT">
|
||||
<summary>Optimal compression, level 11.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.LZ4Level.L12_MAX">
|
||||
<summary>Maximum compression, level 12.</summary>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.LZ4Pickler">
|
||||
<summary>
|
||||
Pickling support with LZ4 compression.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Pickler.Pickle(System.Byte[],K4os.Compression.LZ4.LZ4Level)">
|
||||
<summary>Compresses input buffer into self-contained package.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<param name="level">Compression level.</param>
|
||||
<returns>Output buffer.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Pickler.Pickle(System.Byte[],System.Int32,System.Int32,K4os.Compression.LZ4.LZ4Level)">
|
||||
<summary>Compresses input buffer into self-contained package.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<param name="sourceOffset">Input buffer offset.</param>
|
||||
<param name="sourceLength">Input buffer length.</param>
|
||||
<param name="level">Compression level.</param>
|
||||
<returns>Output buffer.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Pickler.Pickle(System.ReadOnlySpan{System.Byte},K4os.Compression.LZ4.LZ4Level)">
|
||||
<summary>Compresses input buffer into self-contained package.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<param name="level">Compression level.</param>
|
||||
<returns>Output buffer.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Pickler.Pickle(System.Byte*,System.Int32,K4os.Compression.LZ4.LZ4Level)">
|
||||
<summary>Compresses input buffer into self-contained package.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<param name="sourceLength">Length of input data.</param>
|
||||
<param name="level">Compression level.</param>
|
||||
<returns>Output buffer.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Pickler.Unpickle(System.Byte[])">
|
||||
<summary>Decompresses previously pickled buffer (see: <see cref="T:K4os.Compression.LZ4.LZ4Pickler"/>.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<returns>Output buffer.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Pickler.Unpickle(System.Byte[],System.Int32,System.Int32)">
|
||||
<summary>Decompresses previously pickled buffer (see: <see cref="T:K4os.Compression.LZ4.LZ4Pickler"/>.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<param name="sourceOffset">Input buffer offset.</param>
|
||||
<param name="sourceLength">Input buffer length.</param>
|
||||
<returns>Output buffer.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Pickler.Unpickle(System.ReadOnlySpan{System.Byte})">
|
||||
<summary>Decompresses previously pickled buffer (see: <see cref="T:K4os.Compression.LZ4.LZ4Pickler"/>.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<returns>Output buffer.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Pickler.Unpickle(System.Byte*,System.Int32)">
|
||||
<summary>Decompresses previously pickled buffer (see: <see cref="T:K4os.Compression.LZ4.LZ4Pickler"/>.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<param name="sourceLength">Input buffer length.</param>
|
||||
<returns>Output buffer.</returns>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Vendored
BIN
Binary file not shown.
Vendored
+794
@@ -0,0 +1,794 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>K4os.Compression.LZ4</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:K4os.Compression.LZ4.Encoders.EncoderAction">
|
||||
<summary>
|
||||
Action performed by encoder using <c>FlushAndEncode</c> method.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Encoders.EncoderAction.None">
|
||||
<summary>Nothing has happened, most likely loading 0 bytes.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Encoders.EncoderAction.Loaded">
|
||||
<summary>Some bytes has been loaded into encoder.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Encoders.EncoderAction.Copied">
|
||||
<summary>Compression was not possible so bytes has been copied.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Encoders.EncoderAction.Encoded">
|
||||
<summary>Compression succeeded.</summary>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Encoders.ILZ4Decoder">
|
||||
<summary>
|
||||
Interface of LZ4 decoder used by LZ4 streams.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Encoders.ILZ4Decoder.BlockSize">
|
||||
<summary>Block size.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Encoders.ILZ4Decoder.BytesReady">
|
||||
<summary>Bytes already decoded and available to be read.
|
||||
Always smaller than <see cref="P:K4os.Compression.LZ4.Encoders.ILZ4Decoder.BlockSize"/></summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.ILZ4Decoder.Decode(System.Byte*,System.Int32,System.Int32)">
|
||||
<summary>
|
||||
Decodes previously compressed block and caches decompressed block in decoder.
|
||||
Returns number of bytes decoded. These bytes can be read with <see cref="M:K4os.Compression.LZ4.Encoders.ILZ4Decoder.Drain(System.Byte*,System.Int32,System.Int32)" />.
|
||||
</summary>
|
||||
<param name="source">Points to compressed block.</param>
|
||||
<param name="length">Length of compressed block.</param>
|
||||
<param name="blockSize">Size of the block. Value <c>0</c> indicates default block size.</param>
|
||||
<returns>Number of decoded bytes.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.ILZ4Decoder.Inject(System.Byte*,System.Int32)">
|
||||
<summary>
|
||||
Inject already decompressed block and caches it in decoder.
|
||||
Used with uncompressed-yet-chained blocks and pre-made dictionaries.
|
||||
These bytes can be read with <see cref="M:K4os.Compression.LZ4.Encoders.ILZ4Decoder.Drain(System.Byte*,System.Int32,System.Int32)" />.
|
||||
</summary>
|
||||
<param name="source">Points to uncompressed block.</param>
|
||||
<param name="length">Length of uncompressed block.</param>
|
||||
<returns>Number of decoded bytes.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.ILZ4Decoder.Drain(System.Byte*,System.Int32,System.Int32)">
|
||||
<summary>
|
||||
Reads previously decoded bytes. Please note, <paramref name="offset"/> should be
|
||||
negative number, pointing to bytes before current head.
|
||||
</summary>
|
||||
<param name="target">Buffer to write to.</param>
|
||||
<param name="offset">Offset in source buffer relatively to current head.
|
||||
Please note, it should be negative value.</param>
|
||||
<param name="length">Number of bytes to read.</param>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Encoders.ILZ4Encoder">
|
||||
<summary>
|
||||
Interface of LZ4 encoder used by LZ4 streams.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Encoders.ILZ4Encoder.BlockSize">
|
||||
<summary>Block size.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Encoders.ILZ4Encoder.BytesReady">
|
||||
<summary>Number of bytes read for compression.
|
||||
Always smaller than <see cref="P:K4os.Compression.LZ4.Encoders.ILZ4Encoder.BlockSize"/></summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.ILZ4Encoder.Topup(System.Byte*,System.Int32)">
|
||||
<summary>Adds bytes to internal buffer. Increases <see cref="P:K4os.Compression.LZ4.Encoders.ILZ4Encoder.BytesReady"/></summary>
|
||||
<param name="source">Source buffer.</param>
|
||||
<param name="length">Source buffer length.</param>
|
||||
<returns>Number of bytes topped up. If this function returns 0 it means that buffer
|
||||
is full (<see cref="P:K4os.Compression.LZ4.Encoders.ILZ4Encoder.BytesReady"/> equals <see cref="P:K4os.Compression.LZ4.Encoders.ILZ4Encoder.BlockSize"/>) and
|
||||
<see cref="M:K4os.Compression.LZ4.Encoders.ILZ4Encoder.Encode(System.Byte*,System.Int32,System.Boolean)"/> should be called to flush it.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.ILZ4Encoder.Encode(System.Byte*,System.Int32,System.Boolean)">
|
||||
<summary>
|
||||
Encodes bytes in internal buffer (see: <see cref="P:K4os.Compression.LZ4.Encoders.ILZ4Encoder.BytesReady"/>, <see cref="M:K4os.Compression.LZ4.Encoders.ILZ4Encoder.Topup(System.Byte*,System.Int32)"/>).
|
||||
If <paramref name="allowCopy"/> is <c>true</c> then if encoded buffer is bigger than
|
||||
source buffer source bytes are copied instead. In such case returned length is negative.
|
||||
</summary>
|
||||
<param name="target">Target buffer.</param>
|
||||
<param name="length">Target buffer length.</param>
|
||||
<param name="allowCopy">Indicates if copying is allowed.</param>
|
||||
<returns>Length of encoded buffer. Negative if bytes are just copied.</returns>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Encoders.LZ4BlockDecoder">
|
||||
<summary>
|
||||
LZ4 decoder used with independent blocks mode. Plase note, that it will fail
|
||||
if input data has been compressed with chained blocks
|
||||
(<see cref="T:K4os.Compression.LZ4.Encoders.LZ4FastChainEncoder"/> and <see cref="T:K4os.Compression.LZ4.Encoders.LZ4HighChainEncoder"/>)
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Encoders.LZ4BlockDecoder.BlockSize">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Encoders.LZ4BlockDecoder.BytesReady">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4BlockDecoder.#ctor(System.Int32)">
|
||||
<summary>Creates new instance of block decoder.</summary>
|
||||
<param name="blockSize">Block size. Must be equal or greater to one used for compression.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4BlockDecoder.Decode(System.Byte*,System.Int32,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4BlockDecoder.Inject(System.Byte*,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4BlockDecoder.Drain(System.Byte*,System.Int32,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4BlockDecoder.ReleaseUnmanaged">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Encoders.LZ4BlockEncoder">
|
||||
<summary>
|
||||
Independent block encoder. Produces larger files but uses less memory and
|
||||
gives better performance.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4BlockEncoder.#ctor(K4os.Compression.LZ4.LZ4Level,System.Int32)">
|
||||
<summary>Creates new instance of <see cref="T:K4os.Compression.LZ4.Encoders.LZ4BlockEncoder"/></summary>
|
||||
<param name="level">Compression level.</param>
|
||||
<param name="blockSize">Block size.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4BlockEncoder.EncodeBlock(System.Byte*,System.Int32,System.Byte*,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4BlockEncoder.CopyDict(System.Byte*,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Encoders.LZ4ChainDecoder">
|
||||
<summary>LZ4 decoder handling dependent blocks.</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4ChainDecoder.#ctor(System.Int32,System.Int32)">
|
||||
<summary>Creates new instance of <see cref="T:K4os.Compression.LZ4.Encoders.LZ4ChainDecoder"/>.</summary>
|
||||
<param name="blockSize">Block size.</param>
|
||||
<param name="extraBlocks">Number of extra blocks.</param>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Encoders.LZ4ChainDecoder.BlockSize">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Encoders.LZ4ChainDecoder.BytesReady">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4ChainDecoder.Decode(System.Byte*,System.Int32,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4ChainDecoder.Inject(System.Byte*,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4ChainDecoder.Drain(System.Byte*,System.Int32,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4ChainDecoder.ReleaseUnmanaged">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Encoders.LZ4Decoder">
|
||||
<summary>
|
||||
Static class with factory methods to create LZ4 decoders.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4Decoder.Create(System.Boolean,System.Int32,System.Int32)">
|
||||
<summary>Creates appropriate decoder for given parameters.</summary>
|
||||
<param name="chaining">Dependent blocks.</param>
|
||||
<param name="blockSize">Block size.</param>
|
||||
<param name="extraBlocks">Number of extra blocks.</param>
|
||||
<returns>LZ4 decoder.</returns>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Encoders.LZ4Encoder">
|
||||
<summary>
|
||||
Static class with factory method to create LZ4 encoders.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4Encoder.Create(System.Boolean,K4os.Compression.LZ4.LZ4Level,System.Int32,System.Int32)">
|
||||
<summary>Creates appropriate decoder for given parameters.</summary>
|
||||
<param name="chaining">Dependent blocks.</param>
|
||||
<param name="level">Compression level.</param>
|
||||
<param name="blockSize">Block size.</param>
|
||||
<param name="extraBlocks">Number of extra blocks.</param>
|
||||
<returns>LZ4 encoder.</returns>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Encoders.LZ4EncoderBase">
|
||||
<summary>
|
||||
Base class for LZ4 encoders. Provides basic functionality shared by
|
||||
<see cref="T:K4os.Compression.LZ4.Encoders.LZ4BlockEncoder"/>, <see cref="T:K4os.Compression.LZ4.Encoders.LZ4FastChainEncoder"/>,
|
||||
and <see cref="T:K4os.Compression.LZ4.Encoders.LZ4HighChainEncoder"/> encoders. Do not used directly.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderBase.#ctor(System.Boolean,System.Int32,System.Int32)">
|
||||
<summary>Creates new instance of encoder.</summary>
|
||||
<param name="chaining">Needs to be <c>true</c> if using dependent blocks.</param>
|
||||
<param name="blockSize">Block size.</param>
|
||||
<param name="extraBlocks">Number of extra blocks.</param>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Encoders.LZ4EncoderBase.BlockSize">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Encoders.LZ4EncoderBase.BytesReady">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderBase.Topup(System.Byte*,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderBase.Encode(System.Byte*,System.Int32,System.Boolean)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderBase.EncodeBlock(System.Byte*,System.Int32,System.Byte*,System.Int32)">
|
||||
<summary>Encodes single block using appropriate algorithm.</summary>
|
||||
<param name="source">Source buffer.</param>
|
||||
<param name="sourceLength">Source buffer length.</param>
|
||||
<param name="target">Target buffer.</param>
|
||||
<param name="targetLength">Target buffer length.</param>
|
||||
<returns>Number of bytes actually written to target buffer.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderBase.CopyDict(System.Byte*,System.Int32)">
|
||||
<summary>Copies current dictionary.</summary>
|
||||
<param name="target">Target buffer.</param>
|
||||
<param name="dictionaryLength">Dictionary length.</param>
|
||||
<returns>Dictionary length.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderBase.ReleaseUnmanaged">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions">
|
||||
<summary>
|
||||
Functionality of encoders added on top of fixed interface.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.Topup(K4os.Compression.LZ4.Encoders.ILZ4Encoder,System.Byte*@,System.Int32)">
|
||||
<summary>Tops encoder up with some data.</summary>
|
||||
<param name="encoder">Encoder.</param>
|
||||
<param name="source">Buffer pointer, will be shifted after operation by the number of
|
||||
bytes actually loaded.</param>
|
||||
<param name="length">Length of buffer.</param>
|
||||
<returns><c>true</c> if buffer was topped up, <c>false</c> if no bytes were loaded.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.Topup(K4os.Compression.LZ4.Encoders.ILZ4Encoder,System.Byte[],System.Int32,System.Int32)">
|
||||
<summary>Tops encoder up with some data.</summary>
|
||||
<param name="encoder">Encoder.</param>
|
||||
<param name="source">Buffer.</param>
|
||||
<param name="offset">Buffer offset.</param>
|
||||
<param name="length">Length of buffer.</param>
|
||||
<returns>Number of bytes actually loaded.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.Topup(K4os.Compression.LZ4.Encoders.ILZ4Encoder,System.Byte[],System.Int32@,System.Int32)">
|
||||
<summary>Tops encoder up with some data.</summary>
|
||||
<param name="encoder">Encoder.</param>
|
||||
<param name="source">Buffer.</param>
|
||||
<param name="offset">Buffer offset, will be increased after operation by the number
|
||||
of bytes actually loaded.</param>
|
||||
<param name="length">Length of buffer.</param>
|
||||
<returns><c>true</c> if buffer was topped up, <c>false</c> if no bytes were loaded.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.Encode(K4os.Compression.LZ4.Encoders.ILZ4Encoder,System.Byte[],System.Int32,System.Int32,System.Boolean)">
|
||||
<summary>Encodes all bytes currently stored in encoder into target buffer.</summary>
|
||||
<param name="encoder">Encoder.</param>
|
||||
<param name="target">Target buffer.</param>
|
||||
<param name="offset">Offset in target buffer.</param>
|
||||
<param name="length">Length of target buffer.</param>
|
||||
<param name="allowCopy">if <c>true</c> copying bytes is allowed.</param>
|
||||
<returns>Number of bytes encoder. If bytes were copied than this value is negative.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.Encode(K4os.Compression.LZ4.Encoders.ILZ4Encoder,System.Byte[],System.Int32@,System.Int32,System.Boolean)">
|
||||
<summary>Encodes all bytes currently stored in encoder into target buffer.</summary>
|
||||
<param name="encoder">Encoder.</param>
|
||||
<param name="target">Target buffer.</param>
|
||||
<param name="offset">Offset in target buffer. Will be updated after operation.</param>
|
||||
<param name="length">Length of target buffer.</param>
|
||||
<param name="allowCopy">if <c>true</c> copying bytes is allowed.</param>
|
||||
<returns>Result of this action. Bytes can be Copied (<see cref="F:K4os.Compression.LZ4.Encoders.EncoderAction.Copied"/>),
|
||||
Encoded (<see cref="F:K4os.Compression.LZ4.Encoders.EncoderAction.Encoded"/>) or nothing could have
|
||||
happened (<see cref="F:K4os.Compression.LZ4.Encoders.EncoderAction.None"/>).</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.Encode(K4os.Compression.LZ4.Encoders.ILZ4Encoder,System.Byte*@,System.Int32,System.Boolean)">
|
||||
<summary>Encodes all bytes currently stored in encoder into target buffer.</summary>
|
||||
<param name="encoder">Encoder.</param>
|
||||
<param name="target">Target buffer. Will be updated after operation.</param>
|
||||
<param name="length">Length of buffer.</param>
|
||||
<param name="allowCopy">if <c>true</c> copying bytes is allowed.</param>
|
||||
<returns>Result of this action. Bytes can be Copied (<see cref="F:K4os.Compression.LZ4.Encoders.EncoderAction.Copied"/>),
|
||||
Encoded (<see cref="F:K4os.Compression.LZ4.Encoders.EncoderAction.Encoded"/>) or nothing could have
|
||||
happened (<see cref="F:K4os.Compression.LZ4.Encoders.EncoderAction.None"/>).</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.TopupAndEncode(K4os.Compression.LZ4.Encoders.ILZ4Encoder,System.Byte*,System.Int32,System.Byte*,System.Int32,System.Boolean,System.Boolean,System.Int32@,System.Int32@)">
|
||||
<summary>Tops encoder and encodes content.</summary>
|
||||
<param name="encoder">Encoder.</param>
|
||||
<param name="source">Source buffer (used to top up from).</param>
|
||||
<param name="sourceLength">Source buffer length.</param>
|
||||
<param name="target">Target buffer (used to encode into)</param>
|
||||
<param name="targetLength">Target buffer length.</param>
|
||||
<param name="forceEncode">Forces encoding even if encoder is not full.</param>
|
||||
<param name="allowCopy">Allows to copy bytes if compression was not possible.</param>
|
||||
<param name="loaded">Number of bytes loaded (topped up)</param>
|
||||
<param name="encoded">Number if bytes encoded or copied.
|
||||
Value is 0 if no encoding was done.</param>
|
||||
<returns>Action performed.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.TopupAndEncode(K4os.Compression.LZ4.Encoders.ILZ4Encoder,System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32,System.Int32,System.Boolean,System.Boolean,System.Int32@,System.Int32@)">
|
||||
<summary>Tops encoder and encodes content.</summary>
|
||||
<param name="encoder">Encoder.</param>
|
||||
<param name="source">Source buffer (used to top up from).</param>
|
||||
<param name="sourceOffset">Offset within source buffer.</param>
|
||||
<param name="sourceLength">Source buffer length.</param>
|
||||
<param name="target">Target buffer (used to encode into)</param>
|
||||
<param name="targetOffset">Offset within target buffer.</param>
|
||||
<param name="targetLength">Target buffer length.</param>
|
||||
<param name="forceEncode">Forces encoding even if encoder is not full.</param>
|
||||
<param name="allowCopy">Allows to copy bytes if compression was not possible.</param>
|
||||
<param name="loaded">Number of bytes loaded (topped up)</param>
|
||||
<param name="encoded">Number if bytes encoded or copied.
|
||||
Value is 0 if no encoding was done.</param>
|
||||
<returns>Action performed.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.FlushAndEncode(K4os.Compression.LZ4.Encoders.ILZ4Encoder,System.Byte*,System.Int32,System.Boolean,System.Int32@)">
|
||||
<summary>Encoded remaining bytes in encoder.</summary>
|
||||
<param name="encoder">Encoder.</param>
|
||||
<param name="target">Target buffer.</param>
|
||||
<param name="targetLength">Target buffer length.</param>
|
||||
<param name="allowCopy">Allows to copy bytes if compression was not possible.</param>
|
||||
<param name="encoded">Number if bytes encoded or copied.
|
||||
Value is 0 if no encoding was done.</param>
|
||||
<returns>Action performed.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.FlushAndEncode(K4os.Compression.LZ4.Encoders.ILZ4Encoder,System.Byte[],System.Int32,System.Int32,System.Boolean,System.Int32@)">
|
||||
<summary>Encoded remaining bytes in encoder.</summary>
|
||||
<param name="encoder">Encoder.</param>
|
||||
<param name="target">Target buffer.</param>
|
||||
<param name="targetOffset">Offset within target buffer.</param>
|
||||
<param name="targetLength">Target buffer length.</param>
|
||||
<param name="allowCopy">Allows to copy bytes if compression was not possible.</param>
|
||||
<param name="encoded">Number if bytes encoded or copied.
|
||||
Value is 0 if no encoding was done.</param>
|
||||
<returns>Action performed.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.Drain(K4os.Compression.LZ4.Encoders.ILZ4Decoder,System.Byte[],System.Int32,System.Int32,System.Int32)">
|
||||
<summary>Drains decoder by reading all bytes which are ready.</summary>
|
||||
<param name="decoder">Decoder.</param>
|
||||
<param name="target">Target buffer.</param>
|
||||
<param name="targetOffset">Offset within target buffer.</param>
|
||||
<param name="offset">Offset in decoder relatively to decoder's head.
|
||||
Please note, it should be negative value.</param>
|
||||
<param name="length">Number of bytes.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.DecodeAndDrain(K4os.Compression.LZ4.Encoders.ILZ4Decoder,System.Byte*,System.Int32,System.Byte*,System.Int32,System.Int32@)">
|
||||
<summary>Decodes data and immediately drains it into target buffer.</summary>
|
||||
<param name="decoder">Decoder.</param>
|
||||
<param name="source">Source buffer (with compressed data, to be decoded).</param>
|
||||
<param name="sourceLength">Source buffer length.</param>
|
||||
<param name="target">Target buffer (to drained into).</param>
|
||||
<param name="targetLength">Target buffer length.</param>
|
||||
<param name="decoded">Number of bytes actually decoded.</param>
|
||||
<returns><c>true</c> decoder was drained, <c>false</c> otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.DecodeAndDrain(K4os.Compression.LZ4.Encoders.ILZ4Decoder,System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32,System.Int32,System.Int32@)">
|
||||
<summary>Decodes data and immediately drains it into target buffer.</summary>
|
||||
<param name="decoder">Decoder.</param>
|
||||
<param name="source">Source buffer (with compressed data, to be decoded).</param>
|
||||
<param name="sourceOffset">Offset within source buffer.</param>
|
||||
<param name="sourceLength">Source buffer length.</param>
|
||||
<param name="target">Target buffer (to drained into).</param>
|
||||
<param name="targetOffset">Offset within target buffer.</param>
|
||||
<param name="targetLength">Target buffer length.</param>
|
||||
<param name="decoded">Number of bytes actually decoded.</param>
|
||||
<returns><c>true</c> decoder was drained, <c>false</c> otherwise.</returns>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Encoders.LZ4FastChainEncoder">
|
||||
<summary>
|
||||
LZ4 encoder using dependent blocks with fast compression.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4FastChainEncoder.#ctor(System.Int32,System.Int32)">
|
||||
<summary>Creates new instance of <see cref="T:K4os.Compression.LZ4.Encoders.LZ4FastChainEncoder"/></summary>
|
||||
<param name="blockSize">Block size.</param>
|
||||
<param name="extraBlocks">Number of extra blocks.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4FastChainEncoder.ReleaseUnmanaged">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4FastChainEncoder.EncodeBlock(System.Byte*,System.Int32,System.Byte*,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4FastChainEncoder.CopyDict(System.Byte*,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Encoders.LZ4HighChainEncoder">
|
||||
<summary>
|
||||
LZ4 encoder using dependent blocks with high compression.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4HighChainEncoder.#ctor(K4os.Compression.LZ4.LZ4Level,System.Int32,System.Int32)">
|
||||
<summary>Creates new instance of <see cref="T:K4os.Compression.LZ4.Encoders.LZ4HighChainEncoder"/></summary>
|
||||
<param name="level">Compression level.</param>
|
||||
<param name="blockSize">Block size.</param>
|
||||
<param name="extraBlocks">Number of extra blocks.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4HighChainEncoder.ReleaseUnmanaged">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4HighChainEncoder.EncodeBlock(System.Byte*,System.Int32,System.Byte*,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Encoders.LZ4HighChainEncoder.CopyDict(System.Byte*,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Internal.Mem">
|
||||
<summary>Utility class with memory related functions.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.K1">
|
||||
<summary>1 KiB</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.K2">
|
||||
<summary>2 KiB</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.K4">
|
||||
<summary>4 KiB</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.K8">
|
||||
<summary>8 KiB</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.K16">
|
||||
<summary>16 KiB</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.K32">
|
||||
<summary>32 KiB</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.K64">
|
||||
<summary>64 KiB</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.K128">
|
||||
<summary>128 KiB</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.K256">
|
||||
<summary>256 KiB</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.K512">
|
||||
<summary>512 KiB</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.M1">
|
||||
<summary>1 MiB</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.M4">
|
||||
<summary>4 MiB</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.Internal.Mem.Empty">
|
||||
<summary>Empty byte array.</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.RoundUp(System.Int32,System.Int32)">
|
||||
<summary>Rounds integer value up to nearest multiple of step.</summary>
|
||||
<param name="value">A value.</param>
|
||||
<param name="step">A step.</param>
|
||||
<returns>Value rounded up.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Copy(System.Byte*,System.Byte*,System.Int32)">
|
||||
<summary>
|
||||
Copies memory block for <paramref name="source"/> to <paramref name="target"/>.
|
||||
Even though it is called "copy" it actually behaves like "move" which
|
||||
might be potential problem, although it shouldn't as I cannot think about
|
||||
any situation when "copy" invalid behaviour (forward copy of overlapping blocks)
|
||||
can be a desired.
|
||||
</summary>
|
||||
<param name="target">The target block address.</param>
|
||||
<param name="source">The source block address.</param>
|
||||
<param name="length">Length in bytes.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Move(System.Byte*,System.Byte*,System.Int32)">
|
||||
<summary>
|
||||
Copies memory block for <paramref name="source"/> to <paramref name="target"/>.
|
||||
It handle "move" semantic properly handling overlapping blocks properly.
|
||||
</summary>
|
||||
<param name="target">The target block address.</param>
|
||||
<param name="source">The source block address.</param>
|
||||
<param name="length">Length in bytes.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.WildCopy(System.Byte*,System.Byte*,System.Void*)">
|
||||
<summary>
|
||||
Copies memory block for <paramref name="source"/> to <paramref name="target"/>
|
||||
up to (around) <paramref name="limit"/>.
|
||||
It does not handle overlapping blocks and may copy up to 8 bytes more than expected.
|
||||
</summary>
|
||||
<param name="target">The target block address.</param>
|
||||
<param name="source">The source block address.</param>
|
||||
<param name="limit">The limit (in target block).</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Zero(System.Byte*,System.Int32)">
|
||||
<summary>Fill block of memory with zeroes.</summary>
|
||||
<param name="target">Address.</param>
|
||||
<param name="length">Length.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Fill(System.Byte*,System.Byte,System.Int32)">
|
||||
<summary>Fills memory block with repeating pattern of a single byte.</summary>
|
||||
<param name="target">Address.</param>
|
||||
<param name="value">A pattern.</param>
|
||||
<param name="length">Length.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.LoopCopy(System.Byte*,System.Byte*,System.Int32)">
|
||||
<summary>
|
||||
Copies memory block for <paramref name="source"/> to <paramref name="target"/>.
|
||||
This is proper implementation of memcpy (with all then weird behaviour for
|
||||
overlapping blocks). It is slower than "Copy" but may be required if "Copy"
|
||||
causes problems.
|
||||
</summary>
|
||||
<param name="target">The target block address.</param>
|
||||
<param name="source">The source block address.</param>
|
||||
<param name="length">Length in bytes.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.LoopCopyBack(System.Byte*,System.Byte*,System.Int32)">
|
||||
<summary>
|
||||
Copies memory block backwards from <paramref name="source"/> to <paramref name="target"/>.
|
||||
This is needed to implement memmove It is slower than "Move" but is needed for .NET 4.5,
|
||||
which does not implement Buffer.MemoryCopy.
|
||||
</summary>
|
||||
<param name="target">The target block address.</param>
|
||||
<param name="source">The source block address.</param>
|
||||
<param name="length">Length in bytes.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.LoopMove(System.Byte*,System.Byte*,System.Int32)">
|
||||
<summary>
|
||||
Moves memory block for <paramref name="source"/> to <paramref name="target"/>.
|
||||
It handles overlapping block properly.
|
||||
</summary>
|
||||
<param name="target">The target block address.</param>
|
||||
<param name="source">The source block address.</param>
|
||||
<param name="length">Length in bytes.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Copy8(System.Byte*,System.Byte*)">
|
||||
<summary>Copies exactly 8 bytes from source to target.</summary>
|
||||
<param name="target">Target address.</param>
|
||||
<param name="source">Source address.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Copy16(System.Byte*,System.Byte*)">
|
||||
<summary>Copies exactly 16 bytes from source to target.</summary>
|
||||
<param name="target">Target address.</param>
|
||||
<param name="source">Source address.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Copy18(System.Byte*,System.Byte*)">
|
||||
<summary>Copies exactly 18 bytes from source to target.</summary>
|
||||
<param name="target">Target address.</param>
|
||||
<param name="source">Source address.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Alloc(System.Int32)">
|
||||
<summary>Allocated block of memory. It is NOT initialized with zeroes.</summary>
|
||||
<param name="size">Size in bytes.</param>
|
||||
<returns>Pointer to allocated block.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.AllocZero(System.Int32)">
|
||||
<summary>Allocated block of memory and fills it with zeroes.</summary>
|
||||
<param name="size">Size in bytes.</param>
|
||||
<returns>Pointer to allocated block.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Free(System.Void*)">
|
||||
<summary>
|
||||
Free memory allocated previously with <see cref="M:K4os.Compression.LZ4.Internal.Mem.Alloc(System.Int32)"/> or <see cref="M:K4os.Compression.LZ4.Internal.Mem.AllocZero(System.Int32)"/>
|
||||
</summary>
|
||||
<param name="ptr"></param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Peek8(System.Void*)">
|
||||
<summary>Reads exactly 1 byte from given address.</summary>
|
||||
<param name="p">Address.</param>
|
||||
<returns>Byte at given address.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Peek16(System.Void*)">
|
||||
<summary>Reads exactly 2 bytes from given address.</summary>
|
||||
<param name="p">Address.</param>
|
||||
<returns>2 bytes at given address.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Peek32(System.Void*)">
|
||||
<summary>Reads exactly 4 bytes from given address.</summary>
|
||||
<param name="p">Address.</param>
|
||||
<returns>4 bytes at given address.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Peek64(System.Void*)">
|
||||
<summary>Reads exactly 8 bytes from given address.</summary>
|
||||
<param name="p">Address.</param>
|
||||
<returns>8 bytes at given address.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Poke8(System.Void*,System.Byte)">
|
||||
<summary>Writes exactly 1 byte to given address.</summary>
|
||||
<param name="p">Address.</param>
|
||||
<param name="v">Value.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Poke16(System.Void*,System.UInt16)">
|
||||
<summary>Writes exactly 2 bytes to given address.</summary>
|
||||
<param name="p">Address.</param>
|
||||
<param name="v">Value.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Poke32(System.Void*,System.UInt32)">
|
||||
<summary>Writes exactly 4 bytes to given address.</summary>
|
||||
<param name="p">Address.</param>
|
||||
<param name="v">Value.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.Mem.Poke64(System.Void*,System.UInt64)">
|
||||
<summary>Writes exactly 8 bytes to given address.</summary>
|
||||
<param name="p">Address.</param>
|
||||
<param name="v">Value.</param>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Internal.UnmanagedResources">
|
||||
<summary>
|
||||
Skeleton for class with unmanaged resources.
|
||||
Implements <see cref="T:System.IDisposable"/> but also handles proper release in
|
||||
case <see cref="M:K4os.Compression.LZ4.Internal.UnmanagedResources.Dispose"/> was not called.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Internal.UnmanagedResources.IsDisposed">
|
||||
<summary>Determines if object was already disposed.</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.UnmanagedResources.ThrowIfDisposed">
|
||||
<summary>Throws exception is object has been disposed already. Convenience method.</summary>
|
||||
<exception cref="T:System.ObjectDisposedException">Thrown if object is already disposed.</exception>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.UnmanagedResources.ReleaseUnmanaged">
|
||||
<summary>Method releasing unmanaged resources.</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.UnmanagedResources.ReleaseManaged">
|
||||
<summary>Method releasing managed resources.</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.UnmanagedResources.Dispose(System.Boolean)">
|
||||
<summary>
|
||||
Disposed resources.
|
||||
</summary>
|
||||
<param name="disposing"><c>true</c> if dispose was explicitly called,
|
||||
<c>false</c> if called from GC.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.UnmanagedResources.Dispose">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Internal.UnmanagedResources.Finalize">
|
||||
<summary>Destructor.</summary>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.LZ4Codec">
|
||||
<summary>
|
||||
Static class exposing LZ4 block compression methods.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Codec.MaximumOutputSize(System.Int32)">
|
||||
<summary>Maximum size after compression.</summary>
|
||||
<param name="length">Length of input buffer.</param>
|
||||
<returns>Maximum length after compression.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Codec.Encode(System.Byte*,System.Int32,System.Byte*,System.Int32,K4os.Compression.LZ4.LZ4Level)">
|
||||
<summary>Compresses data from one buffer into another.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<param name="sourceLength">Length of input buffer.</param>
|
||||
<param name="target">Output buffer.</param>
|
||||
<param name="targetLength">Output buffer length.</param>
|
||||
<param name="level">Compression level.</param>
|
||||
<returns>Number of bytes written, or negative value if output buffer is too small.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Codec.Encode(System.ReadOnlySpan{System.Byte},System.Span{System.Byte},K4os.Compression.LZ4.LZ4Level)">
|
||||
<summary>Compresses data from one buffer into another.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<param name="target">Output buffer.</param>
|
||||
<param name="level">Compression level.</param>
|
||||
<returns>Number of bytes written, or negative value if output buffer is too small.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Codec.Encode(System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32,System.Int32,K4os.Compression.LZ4.LZ4Level)">
|
||||
<summary>Compresses data from one buffer into another.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<param name="sourceOffset">Input buffer offset.</param>
|
||||
<param name="sourceLength">Input buffer length.</param>
|
||||
<param name="target">Output buffer.</param>
|
||||
<param name="targetOffset">Output buffer offset.</param>
|
||||
<param name="targetLength">Output buffer length.</param>
|
||||
<param name="level">Compression level.</param>
|
||||
<returns>Number of bytes written, or negative value if output buffer is too small.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Codec.Decode(System.Byte*,System.Int32,System.Byte*,System.Int32)">
|
||||
<summary>Decompresses data from given buffer.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<param name="sourceLength">Input buffer length.</param>
|
||||
<param name="target">Output buffer.</param>
|
||||
<param name="targetLength">Output buffer length.</param>
|
||||
<returns>Number of bytes written, or negative value if output buffer is too small.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Codec.Decode(System.ReadOnlySpan{System.Byte},System.Span{System.Byte})">
|
||||
<summary>Decompresses data from given buffer.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<param name="target">Output buffer.</param>
|
||||
<returns>Number of bytes written, or negative value if output buffer is too small.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Codec.Decode(System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32,System.Int32)">
|
||||
<summary>Decompresses data from given buffer.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<param name="sourceOffset">Input buffer offset.</param>
|
||||
<param name="sourceLength">Input buffer length.</param>
|
||||
<param name="target">Output buffer.</param>
|
||||
<param name="targetOffset">Output buffer offset.</param>
|
||||
<param name="targetLength">Output buffer length.</param>
|
||||
<returns>Number of bytes written, or negative value if output buffer is too small.</returns>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.LZ4Level">
|
||||
<summary>Compression level.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.LZ4Level.L00_FAST">
|
||||
<summary>Fast compression.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.LZ4Level.L03_HC">
|
||||
<summary>High compression, level 3.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.LZ4Level.L04_HC">
|
||||
<summary>High compression, level 4.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.LZ4Level.L05_HC">
|
||||
<summary>High compression, level 5.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.LZ4Level.L06_HC">
|
||||
<summary>High compression, level 6.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.LZ4Level.L07_HC">
|
||||
<summary>High compression, level 7.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.LZ4Level.L08_HC">
|
||||
<summary>High compression, level 8.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.LZ4Level.L09_HC">
|
||||
<summary>High compression, level 9.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.LZ4Level.L10_OPT">
|
||||
<summary>Optimal compression, level 10.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.LZ4Level.L11_OPT">
|
||||
<summary>Optimal compression, level 11.</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Compression.LZ4.LZ4Level.L12_MAX">
|
||||
<summary>Maximum compression, level 12.</summary>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.LZ4Pickler">
|
||||
<summary>
|
||||
Pickling support with LZ4 compression.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Pickler.Pickle(System.Byte[],K4os.Compression.LZ4.LZ4Level)">
|
||||
<summary>Compresses input buffer into self-contained package.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<param name="level">Compression level.</param>
|
||||
<returns>Output buffer.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Pickler.Pickle(System.Byte[],System.Int32,System.Int32,K4os.Compression.LZ4.LZ4Level)">
|
||||
<summary>Compresses input buffer into self-contained package.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<param name="sourceOffset">Input buffer offset.</param>
|
||||
<param name="sourceLength">Input buffer length.</param>
|
||||
<param name="level">Compression level.</param>
|
||||
<returns>Output buffer.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Pickler.Pickle(System.ReadOnlySpan{System.Byte},K4os.Compression.LZ4.LZ4Level)">
|
||||
<summary>Compresses input buffer into self-contained package.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<param name="level">Compression level.</param>
|
||||
<returns>Output buffer.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Pickler.Pickle(System.Byte*,System.Int32,K4os.Compression.LZ4.LZ4Level)">
|
||||
<summary>Compresses input buffer into self-contained package.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<param name="sourceLength">Length of input data.</param>
|
||||
<param name="level">Compression level.</param>
|
||||
<returns>Output buffer.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Pickler.Unpickle(System.Byte[])">
|
||||
<summary>Decompresses previously pickled buffer (see: <see cref="T:K4os.Compression.LZ4.LZ4Pickler"/>.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<returns>Output buffer.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Pickler.Unpickle(System.Byte[],System.Int32,System.Int32)">
|
||||
<summary>Decompresses previously pickled buffer (see: <see cref="T:K4os.Compression.LZ4.LZ4Pickler"/>.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<param name="sourceOffset">Input buffer offset.</param>
|
||||
<param name="sourceLength">Input buffer length.</param>
|
||||
<returns>Output buffer.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Pickler.Unpickle(System.ReadOnlySpan{System.Byte})">
|
||||
<summary>Decompresses previously pickled buffer (see: <see cref="T:K4os.Compression.LZ4.LZ4Pickler"/>.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<returns>Output buffer.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.LZ4Pickler.Unpickle(System.Byte*,System.Int32)">
|
||||
<summary>Decompresses previously pickled buffer (see: <see cref="T:K4os.Compression.LZ4.LZ4Pickler"/>.</summary>
|
||||
<param name="source">Input buffer.</param>
|
||||
<param name="sourceLength">Input buffer length.</param>
|
||||
<returns>Output buffer.</returns>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
Vendored
BIN
Binary file not shown.
Vendored
BIN
Binary file not shown.
Vendored
+296
@@ -0,0 +1,296 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>K4os.Compression.LZ4.Streams</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:K4os.Compression.LZ4.Streams.ILZ4Descriptor">
|
||||
<summary>
|
||||
LZ4 Frame descriptor.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.ILZ4Descriptor.ContentLength">
|
||||
<summary>Content length. Not always known.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.ILZ4Descriptor.ContentChecksum">
|
||||
<summary>Indicates if content checksum is provided.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.ILZ4Descriptor.Chaining">
|
||||
<summary>Indicates if blocks are chained (dependent) or not (independent).</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.ILZ4Descriptor.BlockChecksum">
|
||||
<summary>Indicates if block checksums are provided.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.ILZ4Descriptor.Dictionary">
|
||||
<summary>Dictionary id. May be null.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.ILZ4Descriptor.BlockSize">
|
||||
<summary>Block size.</summary>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Streams.LZ4DecoderSettings">
|
||||
<summary>
|
||||
Decoder settings.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4DecoderSettings.ExtraMemory">
|
||||
<summary>Extra memory for decompression.</summary>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Streams.LZ4DecoderStream">
|
||||
<summary>
|
||||
LZ4 Decompression stream handling.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.#ctor(System.IO.Stream,System.Func{K4os.Compression.LZ4.Streams.ILZ4Descriptor,K4os.Compression.LZ4.Encoders.ILZ4Decoder},System.Boolean)">
|
||||
<summary>Creates new instance <see cref="T:K4os.Compression.LZ4.Streams.LZ4DecoderStream"/>.</summary>
|
||||
<param name="inner">Inner stream.</param>
|
||||
<param name="decoderFactory">A function which will create appropriate decoder depending
|
||||
on frame descriptor.</param>
|
||||
<param name="leaveOpen">If <c>true</c> inner stream will not be closed after disposing.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.Flush">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.FlushAsync(System.Threading.CancellationToken)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.Read(System.Byte[],System.Int32,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.ReadByte">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.Dispose">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.Dispose(System.Boolean)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4DecoderStream.CanRead">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4DecoderStream.CanSeek">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4DecoderStream.CanWrite">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4DecoderStream.Length">
|
||||
<summary>
|
||||
Length of stream. Please note, this will only work if original LZ4 stream has
|
||||
<c>ContentLength</c> field set in descriptor. Otherwise returned value will be <c>-1</c>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4DecoderStream.Position">
|
||||
<summary>
|
||||
Position within the stream. Position can be read, but cannot be set as LZ4 stream does
|
||||
not have <c>Seek</c> capability.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4DecoderStream.CanTimeout">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4DecoderStream.WriteTimeout">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4DecoderStream.ReadTimeout">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.Seek(System.Int64,System.IO.SeekOrigin)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.SetLength(System.Int64)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.Write(System.Byte[],System.Int32,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.WriteByte(System.Byte)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Streams.LZ4EncoderSettings">
|
||||
<summary>
|
||||
LZ4 encoder settings.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderSettings.ContentLength">
|
||||
<summary>
|
||||
Content length. It is not enforced, it can be set to any value, but it will be
|
||||
written to the stream so it can be used while decoding. If you don't know the length
|
||||
just leave default value.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderSettings.ChainBlocks">
|
||||
<summary>
|
||||
Indicates if blocks should be chained (dependent) or not (independent). Dependent blocks
|
||||
(with chaining) provide better compression ratio but are a little but slower and take
|
||||
more memory.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderSettings.BlockSize">
|
||||
<summary>
|
||||
Block size. You can use any block size, but default values for LZ4 are 64k, 256k, 1m,
|
||||
and 4m. 64k is good enough for dependent blocks, but for independent blocks bigger is
|
||||
better.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderSettings.ContentChecksum">
|
||||
<summary>Indicates is content checksum is provided. Not implemented yet.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderSettings.BlockChecksum">
|
||||
<summary>Indicates if block checksum is provided. Not implemented yet.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderSettings.Dictionary">
|
||||
<summary>Dictionary id. Not implemented yet.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderSettings.CompressionLevel">
|
||||
<summary>Compression level.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderSettings.ExtraMemory">
|
||||
<summary>Extra memory (for the process, more is usually better).</summary>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Streams.LZ4EncoderStream">
|
||||
<summary>
|
||||
LZ4 compression stream.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.#ctor(System.IO.Stream,K4os.Compression.LZ4.Streams.ILZ4Descriptor,System.Func{K4os.Compression.LZ4.Streams.ILZ4Descriptor,K4os.Compression.LZ4.Encoders.ILZ4Encoder},System.Boolean)">
|
||||
<summary>Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.LZ4EncoderStream"/>.</summary>
|
||||
<param name="inner">Inner stream.</param>
|
||||
<param name="descriptor">LZ4 Descriptor.</param>
|
||||
<param name="encoderFactory">Function which will take descriptor and return
|
||||
appropriate encoder.</param>
|
||||
<param name="leaveOpen">Indicates if <paramref name="inner"/> stream should be left
|
||||
open after disposing.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Flush">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.FlushAsync(System.Threading.CancellationToken)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Close">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.WriteByte(System.Byte)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Write(System.Byte[],System.Int32,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Dispose">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Dispose(System.Boolean)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderStream.CanRead">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderStream.CanSeek">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderStream.CanWrite">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Length">
|
||||
<summary>Length of the stream and number of bytes written so far.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Position">
|
||||
<summary>Read-only position in the stream. Trying to set it will throw
|
||||
<see cref="T:System.InvalidOperationException"/>.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderStream.CanTimeout">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderStream.ReadTimeout">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderStream.WriteTimeout">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Seek(System.Int64,System.IO.SeekOrigin)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.SetLength(System.Int64)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Read(System.Byte[],System.Int32,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.ReadAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.ReadByte">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Streams.LZ4Descriptor">
|
||||
<summary>
|
||||
LZ4 frame descriptor.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4Descriptor.ContentLength">
|
||||
<summary>Content length (if available).</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4Descriptor.ContentChecksum">
|
||||
<summary>Indicates if content checksum if present.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4Descriptor.Chaining">
|
||||
<summary>Indicates if blocks are chained.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4Descriptor.BlockChecksum">
|
||||
<summary>Indicates if block checksums are present.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4Descriptor.Dictionary">
|
||||
<summary>Dictionary id (or null).</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4Descriptor.BlockSize">
|
||||
<summary>Block size.</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4Descriptor.#ctor(System.Nullable{System.Int64},System.Boolean,System.Boolean,System.Boolean,System.Nullable{System.UInt32},System.Int32)">
|
||||
<summary>Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.LZ4Descriptor"/>.</summary>
|
||||
<param name="contentLength">Content length.</param>
|
||||
<param name="contentChecksum">Content checksum flag.</param>
|
||||
<param name="chaining">Chaining flag.</param>
|
||||
<param name="blockChecksum">Block checksum flag.</param>
|
||||
<param name="dictionary">Dictionary id.</param>
|
||||
<param name="blockSize">Block size.</param>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Streams.LZ4Stream">
|
||||
<summary>
|
||||
Utility class with factory methods to create LZ4 compression and decompression streams.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4Stream.Encode(System.IO.Stream,K4os.Compression.LZ4.Streams.LZ4EncoderSettings,System.Boolean)">
|
||||
<summary>Created compression stream on top of inner stream.</summary>
|
||||
<param name="stream">Inner stream.</param>
|
||||
<param name="settings">Compression settings.</param>
|
||||
<param name="leaveOpen">Leave inner stream open after disposing.</param>
|
||||
<returns>Compression stream.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4Stream.Encode(System.IO.Stream,K4os.Compression.LZ4.LZ4Level,System.Int32,System.Boolean)">
|
||||
<summary>Created compression stream on top of inner stream.</summary>
|
||||
<param name="stream">Inner stream.</param>
|
||||
<param name="level">Compression level.</param>
|
||||
<param name="extraMemory">Extra memory used for compression.</param>
|
||||
<param name="leaveOpen">Leave inner stream open after disposing.</param>
|
||||
<returns>Compression stream.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4Stream.Decode(System.IO.Stream,K4os.Compression.LZ4.Streams.LZ4DecoderSettings,System.Boolean)">
|
||||
<summary>Creates decompression stream on top of inner stream.</summary>
|
||||
<param name="stream">Inner stream.</param>
|
||||
<param name="settings">Decompression settings.</param>
|
||||
<param name="leaveOpen">Leave inner stream open after disposing.</param>
|
||||
<returns>Decompression stream.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4Stream.Decode(System.IO.Stream,System.Int32,System.Boolean)">
|
||||
<summary>Creates decompression stream on top of inner stream.</summary>
|
||||
<param name="stream">Inner stream.</param>
|
||||
<param name="extraMemory">Extra memory used for decompression.</param>
|
||||
<param name="leaveOpen">Leave inner stream open after disposing.</param>
|
||||
<returns>Decompression stream.</returns>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Vendored
BIN
Binary file not shown.
Vendored
+296
@@ -0,0 +1,296 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>K4os.Compression.LZ4.Streams</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:K4os.Compression.LZ4.Streams.ILZ4Descriptor">
|
||||
<summary>
|
||||
LZ4 Frame descriptor.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.ILZ4Descriptor.ContentLength">
|
||||
<summary>Content length. Not always known.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.ILZ4Descriptor.ContentChecksum">
|
||||
<summary>Indicates if content checksum is provided.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.ILZ4Descriptor.Chaining">
|
||||
<summary>Indicates if blocks are chained (dependent) or not (independent).</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.ILZ4Descriptor.BlockChecksum">
|
||||
<summary>Indicates if block checksums are provided.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.ILZ4Descriptor.Dictionary">
|
||||
<summary>Dictionary id. May be null.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.ILZ4Descriptor.BlockSize">
|
||||
<summary>Block size.</summary>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Streams.LZ4DecoderSettings">
|
||||
<summary>
|
||||
Decoder settings.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4DecoderSettings.ExtraMemory">
|
||||
<summary>Extra memory for decompression.</summary>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Streams.LZ4DecoderStream">
|
||||
<summary>
|
||||
LZ4 Decompression stream handling.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.#ctor(System.IO.Stream,System.Func{K4os.Compression.LZ4.Streams.ILZ4Descriptor,K4os.Compression.LZ4.Encoders.ILZ4Decoder},System.Boolean)">
|
||||
<summary>Creates new instance <see cref="T:K4os.Compression.LZ4.Streams.LZ4DecoderStream"/>.</summary>
|
||||
<param name="inner">Inner stream.</param>
|
||||
<param name="decoderFactory">A function which will create appropriate decoder depending
|
||||
on frame descriptor.</param>
|
||||
<param name="leaveOpen">If <c>true</c> inner stream will not be closed after disposing.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.Flush">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.FlushAsync(System.Threading.CancellationToken)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.Read(System.Byte[],System.Int32,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.ReadByte">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.Dispose">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.Dispose(System.Boolean)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4DecoderStream.CanRead">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4DecoderStream.CanSeek">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4DecoderStream.CanWrite">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4DecoderStream.Length">
|
||||
<summary>
|
||||
Length of stream. Please note, this will only work if original LZ4 stream has
|
||||
<c>ContentLength</c> field set in descriptor. Otherwise returned value will be <c>-1</c>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4DecoderStream.Position">
|
||||
<summary>
|
||||
Position within the stream. Position can be read, but cannot be set as LZ4 stream does
|
||||
not have <c>Seek</c> capability.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4DecoderStream.CanTimeout">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4DecoderStream.WriteTimeout">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4DecoderStream.ReadTimeout">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.Seek(System.Int64,System.IO.SeekOrigin)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.SetLength(System.Int64)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.Write(System.Byte[],System.Int32,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.WriteByte(System.Byte)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Streams.LZ4EncoderSettings">
|
||||
<summary>
|
||||
LZ4 encoder settings.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderSettings.ContentLength">
|
||||
<summary>
|
||||
Content length. It is not enforced, it can be set to any value, but it will be
|
||||
written to the stream so it can be used while decoding. If you don't know the length
|
||||
just leave default value.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderSettings.ChainBlocks">
|
||||
<summary>
|
||||
Indicates if blocks should be chained (dependent) or not (independent). Dependent blocks
|
||||
(with chaining) provide better compression ratio but are a little but slower and take
|
||||
more memory.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderSettings.BlockSize">
|
||||
<summary>
|
||||
Block size. You can use any block size, but default values for LZ4 are 64k, 256k, 1m,
|
||||
and 4m. 64k is good enough for dependent blocks, but for independent blocks bigger is
|
||||
better.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderSettings.ContentChecksum">
|
||||
<summary>Indicates is content checksum is provided. Not implemented yet.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderSettings.BlockChecksum">
|
||||
<summary>Indicates if block checksum is provided. Not implemented yet.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderSettings.Dictionary">
|
||||
<summary>Dictionary id. Not implemented yet.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderSettings.CompressionLevel">
|
||||
<summary>Compression level.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderSettings.ExtraMemory">
|
||||
<summary>Extra memory (for the process, more is usually better).</summary>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Streams.LZ4EncoderStream">
|
||||
<summary>
|
||||
LZ4 compression stream.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.#ctor(System.IO.Stream,K4os.Compression.LZ4.Streams.ILZ4Descriptor,System.Func{K4os.Compression.LZ4.Streams.ILZ4Descriptor,K4os.Compression.LZ4.Encoders.ILZ4Encoder},System.Boolean)">
|
||||
<summary>Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.LZ4EncoderStream"/>.</summary>
|
||||
<param name="inner">Inner stream.</param>
|
||||
<param name="descriptor">LZ4 Descriptor.</param>
|
||||
<param name="encoderFactory">Function which will take descriptor and return
|
||||
appropriate encoder.</param>
|
||||
<param name="leaveOpen">Indicates if <paramref name="inner"/> stream should be left
|
||||
open after disposing.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Flush">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.FlushAsync(System.Threading.CancellationToken)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Close">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.WriteByte(System.Byte)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Write(System.Byte[],System.Int32,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Dispose">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Dispose(System.Boolean)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderStream.CanRead">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderStream.CanSeek">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderStream.CanWrite">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Length">
|
||||
<summary>Length of the stream and number of bytes written so far.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Position">
|
||||
<summary>Read-only position in the stream. Trying to set it will throw
|
||||
<see cref="T:System.InvalidOperationException"/>.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderStream.CanTimeout">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderStream.ReadTimeout">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderStream.WriteTimeout">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Seek(System.Int64,System.IO.SeekOrigin)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.SetLength(System.Int64)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Read(System.Byte[],System.Int32,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.ReadAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.ReadByte">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Streams.LZ4Descriptor">
|
||||
<summary>
|
||||
LZ4 frame descriptor.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4Descriptor.ContentLength">
|
||||
<summary>Content length (if available).</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4Descriptor.ContentChecksum">
|
||||
<summary>Indicates if content checksum if present.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4Descriptor.Chaining">
|
||||
<summary>Indicates if blocks are chained.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4Descriptor.BlockChecksum">
|
||||
<summary>Indicates if block checksums are present.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4Descriptor.Dictionary">
|
||||
<summary>Dictionary id (or null).</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4Descriptor.BlockSize">
|
||||
<summary>Block size.</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4Descriptor.#ctor(System.Nullable{System.Int64},System.Boolean,System.Boolean,System.Boolean,System.Nullable{System.UInt32},System.Int32)">
|
||||
<summary>Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.LZ4Descriptor"/>.</summary>
|
||||
<param name="contentLength">Content length.</param>
|
||||
<param name="contentChecksum">Content checksum flag.</param>
|
||||
<param name="chaining">Chaining flag.</param>
|
||||
<param name="blockChecksum">Block checksum flag.</param>
|
||||
<param name="dictionary">Dictionary id.</param>
|
||||
<param name="blockSize">Block size.</param>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Streams.LZ4Stream">
|
||||
<summary>
|
||||
Utility class with factory methods to create LZ4 compression and decompression streams.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4Stream.Encode(System.IO.Stream,K4os.Compression.LZ4.Streams.LZ4EncoderSettings,System.Boolean)">
|
||||
<summary>Created compression stream on top of inner stream.</summary>
|
||||
<param name="stream">Inner stream.</param>
|
||||
<param name="settings">Compression settings.</param>
|
||||
<param name="leaveOpen">Leave inner stream open after disposing.</param>
|
||||
<returns>Compression stream.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4Stream.Encode(System.IO.Stream,K4os.Compression.LZ4.LZ4Level,System.Int32,System.Boolean)">
|
||||
<summary>Created compression stream on top of inner stream.</summary>
|
||||
<param name="stream">Inner stream.</param>
|
||||
<param name="level">Compression level.</param>
|
||||
<param name="extraMemory">Extra memory used for compression.</param>
|
||||
<param name="leaveOpen">Leave inner stream open after disposing.</param>
|
||||
<returns>Compression stream.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4Stream.Decode(System.IO.Stream,K4os.Compression.LZ4.Streams.LZ4DecoderSettings,System.Boolean)">
|
||||
<summary>Creates decompression stream on top of inner stream.</summary>
|
||||
<param name="stream">Inner stream.</param>
|
||||
<param name="settings">Decompression settings.</param>
|
||||
<param name="leaveOpen">Leave inner stream open after disposing.</param>
|
||||
<returns>Decompression stream.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4Stream.Decode(System.IO.Stream,System.Int32,System.Boolean)">
|
||||
<summary>Creates decompression stream on top of inner stream.</summary>
|
||||
<param name="stream">Inner stream.</param>
|
||||
<param name="extraMemory">Extra memory used for decompression.</param>
|
||||
<param name="leaveOpen">Leave inner stream open after disposing.</param>
|
||||
<returns>Decompression stream.</returns>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
BIN
Binary file not shown.
+296
@@ -0,0 +1,296 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>K4os.Compression.LZ4.Streams</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:K4os.Compression.LZ4.Streams.ILZ4Descriptor">
|
||||
<summary>
|
||||
LZ4 Frame descriptor.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.ILZ4Descriptor.ContentLength">
|
||||
<summary>Content length. Not always known.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.ILZ4Descriptor.ContentChecksum">
|
||||
<summary>Indicates if content checksum is provided.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.ILZ4Descriptor.Chaining">
|
||||
<summary>Indicates if blocks are chained (dependent) or not (independent).</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.ILZ4Descriptor.BlockChecksum">
|
||||
<summary>Indicates if block checksums are provided.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.ILZ4Descriptor.Dictionary">
|
||||
<summary>Dictionary id. May be null.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.ILZ4Descriptor.BlockSize">
|
||||
<summary>Block size.</summary>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Streams.LZ4DecoderSettings">
|
||||
<summary>
|
||||
Decoder settings.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4DecoderSettings.ExtraMemory">
|
||||
<summary>Extra memory for decompression.</summary>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Streams.LZ4DecoderStream">
|
||||
<summary>
|
||||
LZ4 Decompression stream handling.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.#ctor(System.IO.Stream,System.Func{K4os.Compression.LZ4.Streams.ILZ4Descriptor,K4os.Compression.LZ4.Encoders.ILZ4Decoder},System.Boolean)">
|
||||
<summary>Creates new instance <see cref="T:K4os.Compression.LZ4.Streams.LZ4DecoderStream"/>.</summary>
|
||||
<param name="inner">Inner stream.</param>
|
||||
<param name="decoderFactory">A function which will create appropriate decoder depending
|
||||
on frame descriptor.</param>
|
||||
<param name="leaveOpen">If <c>true</c> inner stream will not be closed after disposing.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.Flush">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.FlushAsync(System.Threading.CancellationToken)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.Read(System.Byte[],System.Int32,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.ReadByte">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.Dispose">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.Dispose(System.Boolean)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4DecoderStream.CanRead">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4DecoderStream.CanSeek">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4DecoderStream.CanWrite">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4DecoderStream.Length">
|
||||
<summary>
|
||||
Length of stream. Please note, this will only work if original LZ4 stream has
|
||||
<c>ContentLength</c> field set in descriptor. Otherwise returned value will be <c>-1</c>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4DecoderStream.Position">
|
||||
<summary>
|
||||
Position within the stream. Position can be read, but cannot be set as LZ4 stream does
|
||||
not have <c>Seek</c> capability.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4DecoderStream.CanTimeout">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4DecoderStream.WriteTimeout">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4DecoderStream.ReadTimeout">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.Seek(System.Int64,System.IO.SeekOrigin)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.SetLength(System.Int64)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.Write(System.Byte[],System.Int32,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.WriteByte(System.Byte)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Streams.LZ4EncoderSettings">
|
||||
<summary>
|
||||
LZ4 encoder settings.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderSettings.ContentLength">
|
||||
<summary>
|
||||
Content length. It is not enforced, it can be set to any value, but it will be
|
||||
written to the stream so it can be used while decoding. If you don't know the length
|
||||
just leave default value.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderSettings.ChainBlocks">
|
||||
<summary>
|
||||
Indicates if blocks should be chained (dependent) or not (independent). Dependent blocks
|
||||
(with chaining) provide better compression ratio but are a little but slower and take
|
||||
more memory.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderSettings.BlockSize">
|
||||
<summary>
|
||||
Block size. You can use any block size, but default values for LZ4 are 64k, 256k, 1m,
|
||||
and 4m. 64k is good enough for dependent blocks, but for independent blocks bigger is
|
||||
better.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderSettings.ContentChecksum">
|
||||
<summary>Indicates is content checksum is provided. Not implemented yet.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderSettings.BlockChecksum">
|
||||
<summary>Indicates if block checksum is provided. Not implemented yet.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderSettings.Dictionary">
|
||||
<summary>Dictionary id. Not implemented yet.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderSettings.CompressionLevel">
|
||||
<summary>Compression level.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderSettings.ExtraMemory">
|
||||
<summary>Extra memory (for the process, more is usually better).</summary>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Streams.LZ4EncoderStream">
|
||||
<summary>
|
||||
LZ4 compression stream.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.#ctor(System.IO.Stream,K4os.Compression.LZ4.Streams.ILZ4Descriptor,System.Func{K4os.Compression.LZ4.Streams.ILZ4Descriptor,K4os.Compression.LZ4.Encoders.ILZ4Encoder},System.Boolean)">
|
||||
<summary>Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.LZ4EncoderStream"/>.</summary>
|
||||
<param name="inner">Inner stream.</param>
|
||||
<param name="descriptor">LZ4 Descriptor.</param>
|
||||
<param name="encoderFactory">Function which will take descriptor and return
|
||||
appropriate encoder.</param>
|
||||
<param name="leaveOpen">Indicates if <paramref name="inner"/> stream should be left
|
||||
open after disposing.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Flush">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.FlushAsync(System.Threading.CancellationToken)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Close">
|
||||
<summary>Closes stream.</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.WriteByte(System.Byte)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Write(System.Byte[],System.Int32,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Dispose">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Dispose(System.Boolean)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderStream.CanRead">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderStream.CanSeek">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderStream.CanWrite">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Length">
|
||||
<summary>Length of the stream and number of bytes written so far.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Position">
|
||||
<summary>Read-only position in the stream. Trying to set it will throw
|
||||
<see cref="T:System.InvalidOperationException"/>.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderStream.CanTimeout">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderStream.ReadTimeout">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderStream.WriteTimeout">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Seek(System.Int64,System.IO.SeekOrigin)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.SetLength(System.Int64)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Read(System.Byte[],System.Int32,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.ReadAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.ReadByte">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Streams.LZ4Descriptor">
|
||||
<summary>
|
||||
LZ4 frame descriptor.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4Descriptor.ContentLength">
|
||||
<summary>Content length (if available).</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4Descriptor.ContentChecksum">
|
||||
<summary>Indicates if content checksum if present.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4Descriptor.Chaining">
|
||||
<summary>Indicates if blocks are chained.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4Descriptor.BlockChecksum">
|
||||
<summary>Indicates if block checksums are present.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4Descriptor.Dictionary">
|
||||
<summary>Dictionary id (or null).</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4Descriptor.BlockSize">
|
||||
<summary>Block size.</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4Descriptor.#ctor(System.Nullable{System.Int64},System.Boolean,System.Boolean,System.Boolean,System.Nullable{System.UInt32},System.Int32)">
|
||||
<summary>Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.LZ4Descriptor"/>.</summary>
|
||||
<param name="contentLength">Content length.</param>
|
||||
<param name="contentChecksum">Content checksum flag.</param>
|
||||
<param name="chaining">Chaining flag.</param>
|
||||
<param name="blockChecksum">Block checksum flag.</param>
|
||||
<param name="dictionary">Dictionary id.</param>
|
||||
<param name="blockSize">Block size.</param>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Streams.LZ4Stream">
|
||||
<summary>
|
||||
Utility class with factory methods to create LZ4 compression and decompression streams.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4Stream.Encode(System.IO.Stream,K4os.Compression.LZ4.Streams.LZ4EncoderSettings,System.Boolean)">
|
||||
<summary>Created compression stream on top of inner stream.</summary>
|
||||
<param name="stream">Inner stream.</param>
|
||||
<param name="settings">Compression settings.</param>
|
||||
<param name="leaveOpen">Leave inner stream open after disposing.</param>
|
||||
<returns>Compression stream.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4Stream.Encode(System.IO.Stream,K4os.Compression.LZ4.LZ4Level,System.Int32,System.Boolean)">
|
||||
<summary>Created compression stream on top of inner stream.</summary>
|
||||
<param name="stream">Inner stream.</param>
|
||||
<param name="level">Compression level.</param>
|
||||
<param name="extraMemory">Extra memory used for compression.</param>
|
||||
<param name="leaveOpen">Leave inner stream open after disposing.</param>
|
||||
<returns>Compression stream.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4Stream.Decode(System.IO.Stream,K4os.Compression.LZ4.Streams.LZ4DecoderSettings,System.Boolean)">
|
||||
<summary>Creates decompression stream on top of inner stream.</summary>
|
||||
<param name="stream">Inner stream.</param>
|
||||
<param name="settings">Decompression settings.</param>
|
||||
<param name="leaveOpen">Leave inner stream open after disposing.</param>
|
||||
<returns>Decompression stream.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4Stream.Decode(System.IO.Stream,System.Int32,System.Boolean)">
|
||||
<summary>Creates decompression stream on top of inner stream.</summary>
|
||||
<param name="stream">Inner stream.</param>
|
||||
<param name="extraMemory">Extra memory used for decompression.</param>
|
||||
<param name="leaveOpen">Leave inner stream open after disposing.</param>
|
||||
<returns>Decompression stream.</returns>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
BIN
Binary file not shown.
+296
@@ -0,0 +1,296 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>K4os.Compression.LZ4.Streams</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:K4os.Compression.LZ4.Streams.ILZ4Descriptor">
|
||||
<summary>
|
||||
LZ4 Frame descriptor.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.ILZ4Descriptor.ContentLength">
|
||||
<summary>Content length. Not always known.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.ILZ4Descriptor.ContentChecksum">
|
||||
<summary>Indicates if content checksum is provided.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.ILZ4Descriptor.Chaining">
|
||||
<summary>Indicates if blocks are chained (dependent) or not (independent).</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.ILZ4Descriptor.BlockChecksum">
|
||||
<summary>Indicates if block checksums are provided.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.ILZ4Descriptor.Dictionary">
|
||||
<summary>Dictionary id. May be null.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.ILZ4Descriptor.BlockSize">
|
||||
<summary>Block size.</summary>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Streams.LZ4DecoderSettings">
|
||||
<summary>
|
||||
Decoder settings.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4DecoderSettings.ExtraMemory">
|
||||
<summary>Extra memory for decompression.</summary>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Streams.LZ4DecoderStream">
|
||||
<summary>
|
||||
LZ4 Decompression stream handling.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.#ctor(System.IO.Stream,System.Func{K4os.Compression.LZ4.Streams.ILZ4Descriptor,K4os.Compression.LZ4.Encoders.ILZ4Decoder},System.Boolean)">
|
||||
<summary>Creates new instance <see cref="T:K4os.Compression.LZ4.Streams.LZ4DecoderStream"/>.</summary>
|
||||
<param name="inner">Inner stream.</param>
|
||||
<param name="decoderFactory">A function which will create appropriate decoder depending
|
||||
on frame descriptor.</param>
|
||||
<param name="leaveOpen">If <c>true</c> inner stream will not be closed after disposing.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.Flush">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.FlushAsync(System.Threading.CancellationToken)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.Read(System.Byte[],System.Int32,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.ReadByte">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.Dispose">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.Dispose(System.Boolean)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4DecoderStream.CanRead">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4DecoderStream.CanSeek">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4DecoderStream.CanWrite">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4DecoderStream.Length">
|
||||
<summary>
|
||||
Length of stream. Please note, this will only work if original LZ4 stream has
|
||||
<c>ContentLength</c> field set in descriptor. Otherwise returned value will be <c>-1</c>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4DecoderStream.Position">
|
||||
<summary>
|
||||
Position within the stream. Position can be read, but cannot be set as LZ4 stream does
|
||||
not have <c>Seek</c> capability.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4DecoderStream.CanTimeout">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4DecoderStream.WriteTimeout">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4DecoderStream.ReadTimeout">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.Seek(System.Int64,System.IO.SeekOrigin)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.SetLength(System.Int64)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.Write(System.Byte[],System.Int32,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.WriteByte(System.Byte)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Streams.LZ4EncoderSettings">
|
||||
<summary>
|
||||
LZ4 encoder settings.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderSettings.ContentLength">
|
||||
<summary>
|
||||
Content length. It is not enforced, it can be set to any value, but it will be
|
||||
written to the stream so it can be used while decoding. If you don't know the length
|
||||
just leave default value.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderSettings.ChainBlocks">
|
||||
<summary>
|
||||
Indicates if blocks should be chained (dependent) or not (independent). Dependent blocks
|
||||
(with chaining) provide better compression ratio but are a little but slower and take
|
||||
more memory.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderSettings.BlockSize">
|
||||
<summary>
|
||||
Block size. You can use any block size, but default values for LZ4 are 64k, 256k, 1m,
|
||||
and 4m. 64k is good enough for dependent blocks, but for independent blocks bigger is
|
||||
better.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderSettings.ContentChecksum">
|
||||
<summary>Indicates is content checksum is provided. Not implemented yet.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderSettings.BlockChecksum">
|
||||
<summary>Indicates if block checksum is provided. Not implemented yet.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderSettings.Dictionary">
|
||||
<summary>Dictionary id. Not implemented yet.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderSettings.CompressionLevel">
|
||||
<summary>Compression level.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderSettings.ExtraMemory">
|
||||
<summary>Extra memory (for the process, more is usually better).</summary>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Streams.LZ4EncoderStream">
|
||||
<summary>
|
||||
LZ4 compression stream.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.#ctor(System.IO.Stream,K4os.Compression.LZ4.Streams.ILZ4Descriptor,System.Func{K4os.Compression.LZ4.Streams.ILZ4Descriptor,K4os.Compression.LZ4.Encoders.ILZ4Encoder},System.Boolean)">
|
||||
<summary>Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.LZ4EncoderStream"/>.</summary>
|
||||
<param name="inner">Inner stream.</param>
|
||||
<param name="descriptor">LZ4 Descriptor.</param>
|
||||
<param name="encoderFactory">Function which will take descriptor and return
|
||||
appropriate encoder.</param>
|
||||
<param name="leaveOpen">Indicates if <paramref name="inner"/> stream should be left
|
||||
open after disposing.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Flush">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.FlushAsync(System.Threading.CancellationToken)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Close">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.WriteByte(System.Byte)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Write(System.Byte[],System.Int32,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Dispose">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Dispose(System.Boolean)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderStream.CanRead">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderStream.CanSeek">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderStream.CanWrite">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Length">
|
||||
<summary>Length of the stream and number of bytes written so far.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Position">
|
||||
<summary>Read-only position in the stream. Trying to set it will throw
|
||||
<see cref="T:System.InvalidOperationException"/>.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderStream.CanTimeout">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderStream.ReadTimeout">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderStream.WriteTimeout">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Seek(System.Int64,System.IO.SeekOrigin)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.SetLength(System.Int64)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Read(System.Byte[],System.Int32,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.ReadAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.ReadByte">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Streams.LZ4Descriptor">
|
||||
<summary>
|
||||
LZ4 frame descriptor.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4Descriptor.ContentLength">
|
||||
<summary>Content length (if available).</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4Descriptor.ContentChecksum">
|
||||
<summary>Indicates if content checksum if present.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4Descriptor.Chaining">
|
||||
<summary>Indicates if blocks are chained.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4Descriptor.BlockChecksum">
|
||||
<summary>Indicates if block checksums are present.</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4Descriptor.Dictionary">
|
||||
<summary>Dictionary id (or null).</summary>
|
||||
</member>
|
||||
<member name="P:K4os.Compression.LZ4.Streams.LZ4Descriptor.BlockSize">
|
||||
<summary>Block size.</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4Descriptor.#ctor(System.Nullable{System.Int64},System.Boolean,System.Boolean,System.Boolean,System.Nullable{System.UInt32},System.Int32)">
|
||||
<summary>Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.LZ4Descriptor"/>.</summary>
|
||||
<param name="contentLength">Content length.</param>
|
||||
<param name="contentChecksum">Content checksum flag.</param>
|
||||
<param name="chaining">Chaining flag.</param>
|
||||
<param name="blockChecksum">Block checksum flag.</param>
|
||||
<param name="dictionary">Dictionary id.</param>
|
||||
<param name="blockSize">Block size.</param>
|
||||
</member>
|
||||
<member name="T:K4os.Compression.LZ4.Streams.LZ4Stream">
|
||||
<summary>
|
||||
Utility class with factory methods to create LZ4 compression and decompression streams.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4Stream.Encode(System.IO.Stream,K4os.Compression.LZ4.Streams.LZ4EncoderSettings,System.Boolean)">
|
||||
<summary>Created compression stream on top of inner stream.</summary>
|
||||
<param name="stream">Inner stream.</param>
|
||||
<param name="settings">Compression settings.</param>
|
||||
<param name="leaveOpen">Leave inner stream open after disposing.</param>
|
||||
<returns>Compression stream.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4Stream.Encode(System.IO.Stream,K4os.Compression.LZ4.LZ4Level,System.Int32,System.Boolean)">
|
||||
<summary>Created compression stream on top of inner stream.</summary>
|
||||
<param name="stream">Inner stream.</param>
|
||||
<param name="level">Compression level.</param>
|
||||
<param name="extraMemory">Extra memory used for compression.</param>
|
||||
<param name="leaveOpen">Leave inner stream open after disposing.</param>
|
||||
<returns>Compression stream.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4Stream.Decode(System.IO.Stream,K4os.Compression.LZ4.Streams.LZ4DecoderSettings,System.Boolean)">
|
||||
<summary>Creates decompression stream on top of inner stream.</summary>
|
||||
<param name="stream">Inner stream.</param>
|
||||
<param name="settings">Decompression settings.</param>
|
||||
<param name="leaveOpen">Leave inner stream open after disposing.</param>
|
||||
<returns>Decompression stream.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Compression.LZ4.Streams.LZ4Stream.Decode(System.IO.Stream,System.Int32,System.Boolean)">
|
||||
<summary>Creates decompression stream on top of inner stream.</summary>
|
||||
<param name="stream">Inner stream.</param>
|
||||
<param name="extraMemory">Extra memory used for decompression.</param>
|
||||
<param name="leaveOpen">Leave inner stream open after disposing.</param>
|
||||
<returns>Decompression stream.</returns>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
@@ -0,0 +1,163 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>K4os.Hash.xxHash</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:K4os.Hash.xxHash.HashAlgorithmAdapter">
|
||||
<summary>
|
||||
Adapter implementing <see cref="T:System.Security.Cryptography.HashAlgorithm"/>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.HashAlgorithmAdapter.#ctor(System.Int32,System.Action,System.Action{System.Byte[],System.Int32,System.Int32},System.Func{System.Byte[]})">
|
||||
<summary>
|
||||
Creates new <see cref="T:K4os.Hash.xxHash.HashAlgorithmAdapter"/>.
|
||||
</summary>
|
||||
<param name="hashSize">Hash size (in bytes)</param>
|
||||
<param name="reset">Reset function.</param>
|
||||
<param name="update">Update function.</param>
|
||||
<param name="digest">Digest function.</param>
|
||||
</member>
|
||||
<member name="P:K4os.Hash.xxHash.HashAlgorithmAdapter.HashSize">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Hash.xxHash.HashAlgorithmAdapter.Hash">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.HashAlgorithmAdapter.HashCore(System.Byte[],System.Int32,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.HashAlgorithmAdapter.HashFinal">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.HashAlgorithmAdapter.Initialize">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:K4os.Hash.xxHash.XXH">
|
||||
<summary>
|
||||
Base class for both <see cref="T:K4os.Hash.xxHash.XXH32"/> and <see cref="T:K4os.Hash.xxHash.XXH64"/>. Do not use directly.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH.#ctor">
|
||||
<summary>Protected constructor to prevent instantiation.</summary>
|
||||
</member>
|
||||
<member name="T:K4os.Hash.xxHash.XXH32">
|
||||
<summary>
|
||||
xxHash 32-bit.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Hash.xxHash.XXH32.EmptyHash">
|
||||
<summary>Hash of empty buffer.</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH32.DigestOf(System.Void*,System.Int32)">
|
||||
<summary>Hash of provided buffer.</summary>
|
||||
<param name="bytes">Buffer.</param>
|
||||
<param name="length">Length of buffer.</param>
|
||||
<returns>Digest.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH32.DigestOf(System.ReadOnlySpan{System.Byte})">
|
||||
<summary>Hash of provided buffer.</summary>
|
||||
<param name="bytes">Buffer.</param>
|
||||
<returns>Digest.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH32.DigestOf(System.Byte[],System.Int32,System.Int32)">
|
||||
<summary>Hash of provided buffer.</summary>
|
||||
<param name="bytes">Buffer.</param>
|
||||
<param name="offset">Starting offset.</param>
|
||||
<param name="length">Length of buffer.</param>
|
||||
<returns>Digest.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH32.#ctor">
|
||||
<summary>Creates xxHash instance.</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH32.Reset">
|
||||
<summary>Resets hash calculation.</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH32.Update(System.Byte*,System.Int32)">
|
||||
<summary>Updates the has using given buffer.</summary>
|
||||
<param name="bytes">Buffer.</param>
|
||||
<param name="length">Length of buffer.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH32.Update(System.ReadOnlySpan{System.Byte})">
|
||||
<summary>Updates the has using given buffer.</summary>
|
||||
<param name="bytes">Buffer.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH32.Update(System.Byte[],System.Int32,System.Int32)">
|
||||
<summary>Updates the has using given buffer.</summary>
|
||||
<param name="bytes">Buffer.</param>
|
||||
<param name="offset">Starting offset.</param>
|
||||
<param name="length">Length of buffer.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH32.Digest">
|
||||
<summary>Hash so far.</summary>
|
||||
<returns>Hash so far.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH32.DigestBytes">
|
||||
<summary>Hash so far, as byte array.</summary>
|
||||
<returns>Hash so far.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH32.AsHashAlgorithm">
|
||||
<summary>Converts this class to <see cref="T:System.Security.Cryptography.HashAlgorithm"/></summary>
|
||||
<returns><see cref="T:System.Security.Cryptography.HashAlgorithm"/></returns>
|
||||
</member>
|
||||
<member name="T:K4os.Hash.xxHash.XXH64">
|
||||
<summary>
|
||||
xxHash 64-bit.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Hash.xxHash.XXH64.EmptyHash">
|
||||
<summary>Hash of empty buffer.</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH64.DigestOf(System.Void*,System.Int32)">
|
||||
<summary>Hash of provided buffer.</summary>
|
||||
<param name="bytes">Buffer.</param>
|
||||
<param name="length">Length of buffer.</param>
|
||||
<returns>Digest.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH64.DigestOf(System.ReadOnlySpan{System.Byte})">
|
||||
<summary>Hash of provided buffer.</summary>
|
||||
<param name="bytes">Buffer.</param>
|
||||
<returns>Digest.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH64.DigestOf(System.Byte[],System.Int32,System.Int32)">
|
||||
<summary>Hash of provided buffer.</summary>
|
||||
<param name="bytes">Buffer.</param>
|
||||
<param name="offset">Starting offset.</param>
|
||||
<param name="length">Length of buffer.</param>
|
||||
<returns>Digest.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH64.#ctor">
|
||||
<summary>Creates xxHash instance.</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH64.Reset">
|
||||
<summary>Resets hash calculation.</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH64.Update(System.Byte*,System.Int32)">
|
||||
<summary>Updates the has using given buffer.</summary>
|
||||
<param name="bytes">Buffer.</param>
|
||||
<param name="length">Length of buffer.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH64.Update(System.ReadOnlySpan{System.Byte})">
|
||||
<summary>Updates the has using given buffer.</summary>
|
||||
<param name="bytes">Buffer.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH64.Update(System.Byte[],System.Int32,System.Int32)">
|
||||
<summary>Updates the has using given buffer.</summary>
|
||||
<param name="bytes">Buffer.</param>
|
||||
<param name="offset">Starting offset.</param>
|
||||
<param name="length">Length of buffer.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH64.Digest">
|
||||
<summary>Hash so far.</summary>
|
||||
<returns>Hash so far.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH64.DigestBytes">
|
||||
<summary>Hash so far, as byte array.</summary>
|
||||
<returns>Hash so far.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH64.AsHashAlgorithm">
|
||||
<summary>Converts this class to <see cref="T:System.Security.Cryptography.HashAlgorithm"/></summary>
|
||||
<returns><see cref="T:System.Security.Cryptography.HashAlgorithm"/></returns>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1,163 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>K4os.Hash.xxHash</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:K4os.Hash.xxHash.HashAlgorithmAdapter">
|
||||
<summary>
|
||||
Adapter implementing <see cref="T:System.Security.Cryptography.HashAlgorithm"/>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.HashAlgorithmAdapter.#ctor(System.Int32,System.Action,System.Action{System.Byte[],System.Int32,System.Int32},System.Func{System.Byte[]})">
|
||||
<summary>
|
||||
Creates new <see cref="T:K4os.Hash.xxHash.HashAlgorithmAdapter"/>.
|
||||
</summary>
|
||||
<param name="hashSize">Hash size (in bytes)</param>
|
||||
<param name="reset">Reset function.</param>
|
||||
<param name="update">Update function.</param>
|
||||
<param name="digest">Digest function.</param>
|
||||
</member>
|
||||
<member name="P:K4os.Hash.xxHash.HashAlgorithmAdapter.HashSize">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Hash.xxHash.HashAlgorithmAdapter.Hash">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.HashAlgorithmAdapter.HashCore(System.Byte[],System.Int32,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.HashAlgorithmAdapter.HashFinal">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.HashAlgorithmAdapter.Initialize">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:K4os.Hash.xxHash.XXH">
|
||||
<summary>
|
||||
Base class for both <see cref="T:K4os.Hash.xxHash.XXH32"/> and <see cref="T:K4os.Hash.xxHash.XXH64"/>. Do not use directly.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH.#ctor">
|
||||
<summary>Protected constructor to prevent instantiation.</summary>
|
||||
</member>
|
||||
<member name="T:K4os.Hash.xxHash.XXH32">
|
||||
<summary>
|
||||
xxHash 32-bit.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Hash.xxHash.XXH32.EmptyHash">
|
||||
<summary>Hash of empty buffer.</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH32.DigestOf(System.Void*,System.Int32)">
|
||||
<summary>Hash of provided buffer.</summary>
|
||||
<param name="bytes">Buffer.</param>
|
||||
<param name="length">Length of buffer.</param>
|
||||
<returns>Digest.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH32.DigestOf(System.ReadOnlySpan{System.Byte})">
|
||||
<summary>Hash of provided buffer.</summary>
|
||||
<param name="bytes">Buffer.</param>
|
||||
<returns>Digest.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH32.DigestOf(System.Byte[],System.Int32,System.Int32)">
|
||||
<summary>Hash of provided buffer.</summary>
|
||||
<param name="bytes">Buffer.</param>
|
||||
<param name="offset">Starting offset.</param>
|
||||
<param name="length">Length of buffer.</param>
|
||||
<returns>Digest.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH32.#ctor">
|
||||
<summary>Creates xxHash instance.</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH32.Reset">
|
||||
<summary>Resets hash calculation.</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH32.Update(System.Byte*,System.Int32)">
|
||||
<summary>Updates the has using given buffer.</summary>
|
||||
<param name="bytes">Buffer.</param>
|
||||
<param name="length">Length of buffer.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH32.Update(System.ReadOnlySpan{System.Byte})">
|
||||
<summary>Updates the has using given buffer.</summary>
|
||||
<param name="bytes">Buffer.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH32.Update(System.Byte[],System.Int32,System.Int32)">
|
||||
<summary>Updates the has using given buffer.</summary>
|
||||
<param name="bytes">Buffer.</param>
|
||||
<param name="offset">Starting offset.</param>
|
||||
<param name="length">Length of buffer.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH32.Digest">
|
||||
<summary>Hash so far.</summary>
|
||||
<returns>Hash so far.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH32.DigestBytes">
|
||||
<summary>Hash so far, as byte array.</summary>
|
||||
<returns>Hash so far.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH32.AsHashAlgorithm">
|
||||
<summary>Converts this class to <see cref="T:System.Security.Cryptography.HashAlgorithm"/></summary>
|
||||
<returns><see cref="T:System.Security.Cryptography.HashAlgorithm"/></returns>
|
||||
</member>
|
||||
<member name="T:K4os.Hash.xxHash.XXH64">
|
||||
<summary>
|
||||
xxHash 64-bit.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Hash.xxHash.XXH64.EmptyHash">
|
||||
<summary>Hash of empty buffer.</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH64.DigestOf(System.Void*,System.Int32)">
|
||||
<summary>Hash of provided buffer.</summary>
|
||||
<param name="bytes">Buffer.</param>
|
||||
<param name="length">Length of buffer.</param>
|
||||
<returns>Digest.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH64.DigestOf(System.ReadOnlySpan{System.Byte})">
|
||||
<summary>Hash of provided buffer.</summary>
|
||||
<param name="bytes">Buffer.</param>
|
||||
<returns>Digest.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH64.DigestOf(System.Byte[],System.Int32,System.Int32)">
|
||||
<summary>Hash of provided buffer.</summary>
|
||||
<param name="bytes">Buffer.</param>
|
||||
<param name="offset">Starting offset.</param>
|
||||
<param name="length">Length of buffer.</param>
|
||||
<returns>Digest.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH64.#ctor">
|
||||
<summary>Creates xxHash instance.</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH64.Reset">
|
||||
<summary>Resets hash calculation.</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH64.Update(System.Byte*,System.Int32)">
|
||||
<summary>Updates the has using given buffer.</summary>
|
||||
<param name="bytes">Buffer.</param>
|
||||
<param name="length">Length of buffer.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH64.Update(System.ReadOnlySpan{System.Byte})">
|
||||
<summary>Updates the has using given buffer.</summary>
|
||||
<param name="bytes">Buffer.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH64.Update(System.Byte[],System.Int32,System.Int32)">
|
||||
<summary>Updates the has using given buffer.</summary>
|
||||
<param name="bytes">Buffer.</param>
|
||||
<param name="offset">Starting offset.</param>
|
||||
<param name="length">Length of buffer.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH64.Digest">
|
||||
<summary>Hash so far.</summary>
|
||||
<returns>Hash so far.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH64.DigestBytes">
|
||||
<summary>Hash so far, as byte array.</summary>
|
||||
<returns>Hash so far.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH64.AsHashAlgorithm">
|
||||
<summary>Converts this class to <see cref="T:System.Security.Cryptography.HashAlgorithm"/></summary>
|
||||
<returns><see cref="T:System.Security.Cryptography.HashAlgorithm"/></returns>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
BIN
Binary file not shown.
+163
@@ -0,0 +1,163 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>K4os.Hash.xxHash</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:K4os.Hash.xxHash.HashAlgorithmAdapter">
|
||||
<summary>
|
||||
Adapter implementing <see cref="T:System.Security.Cryptography.HashAlgorithm"/>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.HashAlgorithmAdapter.#ctor(System.Int32,System.Action,System.Action{System.Byte[],System.Int32,System.Int32},System.Func{System.Byte[]})">
|
||||
<summary>
|
||||
Creates new <see cref="T:K4os.Hash.xxHash.HashAlgorithmAdapter"/>.
|
||||
</summary>
|
||||
<param name="hashSize">Hash size (in bytes)</param>
|
||||
<param name="reset">Reset function.</param>
|
||||
<param name="update">Update function.</param>
|
||||
<param name="digest">Digest function.</param>
|
||||
</member>
|
||||
<member name="P:K4os.Hash.xxHash.HashAlgorithmAdapter.HashSize">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Hash.xxHash.HashAlgorithmAdapter.Hash">
|
||||
<summary>Current hash.</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.HashAlgorithmAdapter.HashCore(System.Byte[],System.Int32,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.HashAlgorithmAdapter.HashFinal">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.HashAlgorithmAdapter.Initialize">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:K4os.Hash.xxHash.XXH">
|
||||
<summary>
|
||||
Base class for both <see cref="T:K4os.Hash.xxHash.XXH32"/> and <see cref="T:K4os.Hash.xxHash.XXH64"/>. Do not use directly.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH.#ctor">
|
||||
<summary>Protected constructor to prevent instantiation.</summary>
|
||||
</member>
|
||||
<member name="T:K4os.Hash.xxHash.XXH32">
|
||||
<summary>
|
||||
xxHash 32-bit.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Hash.xxHash.XXH32.EmptyHash">
|
||||
<summary>Hash of empty buffer.</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH32.DigestOf(System.Void*,System.Int32)">
|
||||
<summary>Hash of provided buffer.</summary>
|
||||
<param name="bytes">Buffer.</param>
|
||||
<param name="length">Length of buffer.</param>
|
||||
<returns>Digest.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH32.DigestOf(System.ReadOnlySpan{System.Byte})">
|
||||
<summary>Hash of provided buffer.</summary>
|
||||
<param name="bytes">Buffer.</param>
|
||||
<returns>Digest.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH32.DigestOf(System.Byte[],System.Int32,System.Int32)">
|
||||
<summary>Hash of provided buffer.</summary>
|
||||
<param name="bytes">Buffer.</param>
|
||||
<param name="offset">Starting offset.</param>
|
||||
<param name="length">Length of buffer.</param>
|
||||
<returns>Digest.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH32.#ctor">
|
||||
<summary>Creates xxHash instance.</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH32.Reset">
|
||||
<summary>Resets hash calculation.</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH32.Update(System.Byte*,System.Int32)">
|
||||
<summary>Updates the has using given buffer.</summary>
|
||||
<param name="bytes">Buffer.</param>
|
||||
<param name="length">Length of buffer.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH32.Update(System.ReadOnlySpan{System.Byte})">
|
||||
<summary>Updates the has using given buffer.</summary>
|
||||
<param name="bytes">Buffer.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH32.Update(System.Byte[],System.Int32,System.Int32)">
|
||||
<summary>Updates the has using given buffer.</summary>
|
||||
<param name="bytes">Buffer.</param>
|
||||
<param name="offset">Starting offset.</param>
|
||||
<param name="length">Length of buffer.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH32.Digest">
|
||||
<summary>Hash so far.</summary>
|
||||
<returns>Hash so far.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH32.DigestBytes">
|
||||
<summary>Hash so far, as byte array.</summary>
|
||||
<returns>Hash so far.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH32.AsHashAlgorithm">
|
||||
<summary>Converts this class to <see cref="T:System.Security.Cryptography.HashAlgorithm"/></summary>
|
||||
<returns><see cref="T:System.Security.Cryptography.HashAlgorithm"/></returns>
|
||||
</member>
|
||||
<member name="T:K4os.Hash.xxHash.XXH64">
|
||||
<summary>
|
||||
xxHash 64-bit.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Hash.xxHash.XXH64.EmptyHash">
|
||||
<summary>Hash of empty buffer.</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH64.DigestOf(System.Void*,System.Int32)">
|
||||
<summary>Hash of provided buffer.</summary>
|
||||
<param name="bytes">Buffer.</param>
|
||||
<param name="length">Length of buffer.</param>
|
||||
<returns>Digest.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH64.DigestOf(System.ReadOnlySpan{System.Byte})">
|
||||
<summary>Hash of provided buffer.</summary>
|
||||
<param name="bytes">Buffer.</param>
|
||||
<returns>Digest.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH64.DigestOf(System.Byte[],System.Int32,System.Int32)">
|
||||
<summary>Hash of provided buffer.</summary>
|
||||
<param name="bytes">Buffer.</param>
|
||||
<param name="offset">Starting offset.</param>
|
||||
<param name="length">Length of buffer.</param>
|
||||
<returns>Digest.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH64.#ctor">
|
||||
<summary>Creates xxHash instance.</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH64.Reset">
|
||||
<summary>Resets hash calculation.</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH64.Update(System.Byte*,System.Int32)">
|
||||
<summary>Updates the has using given buffer.</summary>
|
||||
<param name="bytes">Buffer.</param>
|
||||
<param name="length">Length of buffer.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH64.Update(System.ReadOnlySpan{System.Byte})">
|
||||
<summary>Updates the has using given buffer.</summary>
|
||||
<param name="bytes">Buffer.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH64.Update(System.Byte[],System.Int32,System.Int32)">
|
||||
<summary>Updates the has using given buffer.</summary>
|
||||
<param name="bytes">Buffer.</param>
|
||||
<param name="offset">Starting offset.</param>
|
||||
<param name="length">Length of buffer.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH64.Digest">
|
||||
<summary>Hash so far.</summary>
|
||||
<returns>Hash so far.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH64.DigestBytes">
|
||||
<summary>Hash so far, as byte array.</summary>
|
||||
<returns>Hash so far.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH64.AsHashAlgorithm">
|
||||
<summary>Converts this class to <see cref="T:System.Security.Cryptography.HashAlgorithm"/></summary>
|
||||
<returns><see cref="T:System.Security.Cryptography.HashAlgorithm"/></returns>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
BIN
Binary file not shown.
+163
@@ -0,0 +1,163 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>K4os.Hash.xxHash</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:K4os.Hash.xxHash.HashAlgorithmAdapter">
|
||||
<summary>
|
||||
Adapter implementing <see cref="T:System.Security.Cryptography.HashAlgorithm"/>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.HashAlgorithmAdapter.#ctor(System.Int32,System.Action,System.Action{System.Byte[],System.Int32,System.Int32},System.Func{System.Byte[]})">
|
||||
<summary>
|
||||
Creates new <see cref="T:K4os.Hash.xxHash.HashAlgorithmAdapter"/>.
|
||||
</summary>
|
||||
<param name="hashSize">Hash size (in bytes)</param>
|
||||
<param name="reset">Reset function.</param>
|
||||
<param name="update">Update function.</param>
|
||||
<param name="digest">Digest function.</param>
|
||||
</member>
|
||||
<member name="P:K4os.Hash.xxHash.HashAlgorithmAdapter.HashSize">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:K4os.Hash.xxHash.HashAlgorithmAdapter.Hash">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.HashAlgorithmAdapter.HashCore(System.Byte[],System.Int32,System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.HashAlgorithmAdapter.HashFinal">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.HashAlgorithmAdapter.Initialize">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:K4os.Hash.xxHash.XXH">
|
||||
<summary>
|
||||
Base class for both <see cref="T:K4os.Hash.xxHash.XXH32"/> and <see cref="T:K4os.Hash.xxHash.XXH64"/>. Do not use directly.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH.#ctor">
|
||||
<summary>Protected constructor to prevent instantiation.</summary>
|
||||
</member>
|
||||
<member name="T:K4os.Hash.xxHash.XXH32">
|
||||
<summary>
|
||||
xxHash 32-bit.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Hash.xxHash.XXH32.EmptyHash">
|
||||
<summary>Hash of empty buffer.</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH32.DigestOf(System.Void*,System.Int32)">
|
||||
<summary>Hash of provided buffer.</summary>
|
||||
<param name="bytes">Buffer.</param>
|
||||
<param name="length">Length of buffer.</param>
|
||||
<returns>Digest.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH32.DigestOf(System.ReadOnlySpan{System.Byte})">
|
||||
<summary>Hash of provided buffer.</summary>
|
||||
<param name="bytes">Buffer.</param>
|
||||
<returns>Digest.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH32.DigestOf(System.Byte[],System.Int32,System.Int32)">
|
||||
<summary>Hash of provided buffer.</summary>
|
||||
<param name="bytes">Buffer.</param>
|
||||
<param name="offset">Starting offset.</param>
|
||||
<param name="length">Length of buffer.</param>
|
||||
<returns>Digest.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH32.#ctor">
|
||||
<summary>Creates xxHash instance.</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH32.Reset">
|
||||
<summary>Resets hash calculation.</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH32.Update(System.Byte*,System.Int32)">
|
||||
<summary>Updates the has using given buffer.</summary>
|
||||
<param name="bytes">Buffer.</param>
|
||||
<param name="length">Length of buffer.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH32.Update(System.ReadOnlySpan{System.Byte})">
|
||||
<summary>Updates the has using given buffer.</summary>
|
||||
<param name="bytes">Buffer.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH32.Update(System.Byte[],System.Int32,System.Int32)">
|
||||
<summary>Updates the has using given buffer.</summary>
|
||||
<param name="bytes">Buffer.</param>
|
||||
<param name="offset">Starting offset.</param>
|
||||
<param name="length">Length of buffer.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH32.Digest">
|
||||
<summary>Hash so far.</summary>
|
||||
<returns>Hash so far.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH32.DigestBytes">
|
||||
<summary>Hash so far, as byte array.</summary>
|
||||
<returns>Hash so far.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH32.AsHashAlgorithm">
|
||||
<summary>Converts this class to <see cref="T:System.Security.Cryptography.HashAlgorithm"/></summary>
|
||||
<returns><see cref="T:System.Security.Cryptography.HashAlgorithm"/></returns>
|
||||
</member>
|
||||
<member name="T:K4os.Hash.xxHash.XXH64">
|
||||
<summary>
|
||||
xxHash 64-bit.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:K4os.Hash.xxHash.XXH64.EmptyHash">
|
||||
<summary>Hash of empty buffer.</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH64.DigestOf(System.Void*,System.Int32)">
|
||||
<summary>Hash of provided buffer.</summary>
|
||||
<param name="bytes">Buffer.</param>
|
||||
<param name="length">Length of buffer.</param>
|
||||
<returns>Digest.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH64.DigestOf(System.ReadOnlySpan{System.Byte})">
|
||||
<summary>Hash of provided buffer.</summary>
|
||||
<param name="bytes">Buffer.</param>
|
||||
<returns>Digest.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH64.DigestOf(System.Byte[],System.Int32,System.Int32)">
|
||||
<summary>Hash of provided buffer.</summary>
|
||||
<param name="bytes">Buffer.</param>
|
||||
<param name="offset">Starting offset.</param>
|
||||
<param name="length">Length of buffer.</param>
|
||||
<returns>Digest.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH64.#ctor">
|
||||
<summary>Creates xxHash instance.</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH64.Reset">
|
||||
<summary>Resets hash calculation.</summary>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH64.Update(System.Byte*,System.Int32)">
|
||||
<summary>Updates the has using given buffer.</summary>
|
||||
<param name="bytes">Buffer.</param>
|
||||
<param name="length">Length of buffer.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH64.Update(System.ReadOnlySpan{System.Byte})">
|
||||
<summary>Updates the has using given buffer.</summary>
|
||||
<param name="bytes">Buffer.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH64.Update(System.Byte[],System.Int32,System.Int32)">
|
||||
<summary>Updates the has using given buffer.</summary>
|
||||
<param name="bytes">Buffer.</param>
|
||||
<param name="offset">Starting offset.</param>
|
||||
<param name="length">Length of buffer.</param>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH64.Digest">
|
||||
<summary>Hash so far.</summary>
|
||||
<returns>Hash so far.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH64.DigestBytes">
|
||||
<summary>Hash so far, as byte array.</summary>
|
||||
<returns>Hash so far.</returns>
|
||||
</member>
|
||||
<member name="M:K4os.Hash.xxHash.XXH64.AsHashAlgorithm">
|
||||
<summary>Converts this class to <see cref="T:System.Security.Cryptography.HashAlgorithm"/></summary>
|
||||
<returns><see cref="T:System.Security.Cryptography.HashAlgorithm"/></returns>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -1,23 +0,0 @@
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) .NET Foundation and Contributors
|
||||
|
||||
All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
Vendored
BIN
Binary file not shown.
-375
@@ -1,375 +0,0 @@
|
||||
.NET Core uses third-party libraries or other resources that may be
|
||||
distributed under licenses different than the .NET Core software.
|
||||
|
||||
In the event that we accidentally failed to list a required notice, please
|
||||
bring it to our attention. Post an issue or email us:
|
||||
|
||||
dotnet@microsoft.com
|
||||
|
||||
The attached notices are provided for information only.
|
||||
|
||||
License notice for ASP.NET
|
||||
-------------------------------
|
||||
|
||||
Copyright (c) .NET Foundation. All rights reserved.
|
||||
Licensed under the Apache License, Version 2.0.
|
||||
|
||||
Available at
|
||||
https://github.com/aspnet/AspNetCore/blob/master/LICENSE.txt
|
||||
|
||||
License notice for Slicing-by-8
|
||||
-------------------------------
|
||||
|
||||
http://sourceforge.net/projects/slicing-by-8/
|
||||
|
||||
Copyright (c) 2004-2006 Intel Corporation - All Rights Reserved
|
||||
|
||||
|
||||
This software program is licensed subject to the BSD License, available at
|
||||
http://www.opensource.org/licenses/bsd-license.html.
|
||||
|
||||
|
||||
License notice for Unicode data
|
||||
-------------------------------
|
||||
|
||||
http://www.unicode.org/copyright.html#License
|
||||
|
||||
Copyright © 1991-2017 Unicode, Inc. All rights reserved.
|
||||
Distributed under the Terms of Use in http://www.unicode.org/copyright.html.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining
|
||||
a copy of the Unicode data files and any associated documentation
|
||||
(the "Data Files") or Unicode software and any associated documentation
|
||||
(the "Software") to deal in the Data Files or Software
|
||||
without restriction, including without limitation the rights to use,
|
||||
copy, modify, merge, publish, distribute, and/or sell copies of
|
||||
the Data Files or Software, and to permit persons to whom the Data Files
|
||||
or Software are furnished to do so, provided that either
|
||||
(a) this copyright and permission notice appear with all copies
|
||||
of the Data Files or Software, or
|
||||
(b) this copyright and permission notice appear in associated
|
||||
Documentation.
|
||||
|
||||
THE DATA FILES AND SOFTWARE ARE PROVIDED "AS IS", WITHOUT WARRANTY OF
|
||||
ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
|
||||
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||
NONINFRINGEMENT OF THIRD PARTY RIGHTS.
|
||||
IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS INCLUDED IN THIS
|
||||
NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL
|
||||
DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
|
||||
DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
|
||||
TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
||||
PERFORMANCE OF THE DATA FILES OR SOFTWARE.
|
||||
|
||||
Except as contained in this notice, the name of a copyright holder
|
||||
shall not be used in advertising or otherwise to promote the sale,
|
||||
use or other dealings in these Data Files or Software without prior
|
||||
written authorization of the copyright holder.
|
||||
|
||||
License notice for Zlib
|
||||
-----------------------
|
||||
|
||||
https://github.com/madler/zlib
|
||||
http://zlib.net/zlib_license.html
|
||||
|
||||
/* zlib.h -- interface of the 'zlib' general purpose compression library
|
||||
version 1.2.11, January 15th, 2017
|
||||
|
||||
Copyright (C) 1995-2017 Jean-loup Gailly and Mark Adler
|
||||
|
||||
This software is provided 'as-is', without any express or implied
|
||||
warranty. In no event will the authors be held liable for any damages
|
||||
arising from the use of this software.
|
||||
|
||||
Permission is granted to anyone to use this software for any purpose,
|
||||
including commercial applications, and to alter it and redistribute it
|
||||
freely, subject to the following restrictions:
|
||||
|
||||
1. The origin of this software must not be misrepresented; you must not
|
||||
claim that you wrote the original software. If you use this software
|
||||
in a product, an acknowledgment in the product documentation would be
|
||||
appreciated but is not required.
|
||||
2. Altered source versions must be plainly marked as such, and must not be
|
||||
misrepresented as being the original software.
|
||||
3. This notice may not be removed or altered from any source distribution.
|
||||
|
||||
Jean-loup Gailly Mark Adler
|
||||
jloup@gzip.org madler@alumni.caltech.edu
|
||||
|
||||
*/
|
||||
|
||||
License notice for Mono
|
||||
-------------------------------
|
||||
|
||||
http://www.mono-project.com/docs/about-mono/
|
||||
|
||||
Copyright (c) .NET Foundation Contributors
|
||||
|
||||
MIT License
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the Software), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
||||
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
||||
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
||||
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
License notice for International Organization for Standardization
|
||||
-----------------------------------------------------------------
|
||||
|
||||
Portions (C) International Organization for Standardization 1986:
|
||||
Permission to copy in any form is granted for use with
|
||||
conforming SGML systems and applications as defined in
|
||||
ISO 8879, provided this notice is included in all copies.
|
||||
|
||||
License notice for Intel
|
||||
------------------------
|
||||
|
||||
"Copyright (c) 2004-2006 Intel Corporation - All Rights Reserved
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are met:
|
||||
|
||||
1. Redistributions of source code must retain the above copyright notice, this
|
||||
list of conditions and the following disclaimer.
|
||||
|
||||
2. Redistributions in binary form must reproduce the above copyright notice,
|
||||
this list of conditions and the following disclaimer in the documentation
|
||||
and/or other materials provided with the distribution.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
||||
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||||
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||||
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||||
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
License notice for Xamarin and Novell
|
||||
-------------------------------------
|
||||
|
||||
Copyright (c) 2015 Xamarin, Inc (http://www.xamarin.com)
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
|
||||
Copyright (c) 2011 Novell, Inc (http://www.novell.com)
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
|
||||
Third party notice for W3C
|
||||
--------------------------
|
||||
|
||||
"W3C SOFTWARE AND DOCUMENT NOTICE AND LICENSE
|
||||
Status: This license takes effect 13 May, 2015.
|
||||
This work is being provided by the copyright holders under the following license.
|
||||
License
|
||||
By obtaining and/or copying this work, you (the licensee) agree that you have read, understood, and will comply with the following terms and conditions.
|
||||
Permission to copy, modify, and distribute this work, with or without modification, for any purpose and without fee or royalty is hereby granted, provided that you include the following on ALL copies of the work or portions thereof, including modifications:
|
||||
The full text of this NOTICE in a location viewable to users of the redistributed or derivative work.
|
||||
Any pre-existing intellectual property disclaimers, notices, or terms and conditions. If none exist, the W3C Software and Document Short Notice should be included.
|
||||
Notice of any changes or modifications, through a copyright statement on the new code or document such as "This software or document includes material copied from or derived from [title and URI of the W3C document]. Copyright © [YEAR] W3C® (MIT, ERCIM, Keio, Beihang)."
|
||||
Disclaimers
|
||||
THIS WORK IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF THE SOFTWARE OR DOCUMENT WILL NOT INFRINGE ANY THIRD PARTY PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.
|
||||
COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENT.
|
||||
The name and trademarks of copyright holders may NOT be used in advertising or publicity pertaining to the work without specific, written prior permission. Title to copyright in this work will at all times remain with copyright holders."
|
||||
|
||||
License notice for Bit Twiddling Hacks
|
||||
--------------------------------------
|
||||
|
||||
Bit Twiddling Hacks
|
||||
|
||||
By Sean Eron Anderson
|
||||
seander@cs.stanford.edu
|
||||
|
||||
Individually, the code snippets here are in the public domain (unless otherwise
|
||||
noted) — feel free to use them however you please. The aggregate collection and
|
||||
descriptions are © 1997-2005 Sean Eron Anderson. The code and descriptions are
|
||||
distributed in the hope that they will be useful, but WITHOUT ANY WARRANTY and
|
||||
without even the implied warranty of merchantability or fitness for a particular
|
||||
purpose.
|
||||
|
||||
License notice for Brotli
|
||||
--------------------------------------
|
||||
|
||||
Copyright (c) 2009, 2010, 2013-2016 by the Brotli Authors.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
|
||||
compress_fragment.c:
|
||||
Copyright (c) 2011, Google Inc.
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are
|
||||
met:
|
||||
|
||||
* Redistributions of source code must retain the above copyright
|
||||
notice, this list of conditions and the following disclaimer.
|
||||
* Redistributions in binary form must reproduce the above
|
||||
copyright notice, this list of conditions and the following disclaimer
|
||||
in the documentation and/or other materials provided with the
|
||||
distribution.
|
||||
* Neither the name of Google Inc. nor the names of its
|
||||
contributors may be used to endorse or promote products derived from
|
||||
this software without specific prior written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
""AS IS"" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
decode_fuzzer.c:
|
||||
Copyright (c) 2015 The Chromium Authors. All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are
|
||||
met:
|
||||
|
||||
* Redistributions of source code must retain the above copyright
|
||||
notice, this list of conditions and the following disclaimer.
|
||||
* Redistributions in binary form must reproduce the above
|
||||
copyright notice, this list of conditions and the following disclaimer
|
||||
in the documentation and/or other materials provided with the
|
||||
distribution.
|
||||
* Neither the name of Google Inc. nor the names of its
|
||||
contributors may be used to endorse or promote products derived from
|
||||
this software without specific prior written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
""AS IS"" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
|
||||
|
||||
License notice for Json.NET
|
||||
-------------------------------
|
||||
|
||||
https://github.com/JamesNK/Newtonsoft.Json/blob/master/LICENSE.md
|
||||
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2007 James Newton-King
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
this software and associated documentation files (the "Software"), to deal in
|
||||
the Software without restriction, including without limitation the rights to
|
||||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
||||
the Software, and to permit persons to whom the Software is furnished to do so,
|
||||
subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
||||
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
||||
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
||||
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
License notice for vectorized base64 encoding / decoding
|
||||
--------------------------------------------------------
|
||||
|
||||
Copyright (c) 2005-2007, Nick Galbreath
|
||||
Copyright (c) 2013-2017, Alfred Klomp
|
||||
Copyright (c) 2015-2017, Wojciech Mula
|
||||
Copyright (c) 2016-2017, Matthieu Darbois
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are
|
||||
met:
|
||||
|
||||
- Redistributions of source code must retain the above copyright notice,
|
||||
this list of conditions and the following disclaimer.
|
||||
|
||||
- Redistributions in binary form must reproduce the above copyright
|
||||
notice, this list of conditions and the following disclaimer in the
|
||||
documentation and/or other materials provided with the distribution.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
|
||||
IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
|
||||
TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
|
||||
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
|
||||
TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
|
||||
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
|
||||
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
|
||||
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
||||
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
BIN
Binary file not shown.
-223
@@ -1,223 +0,0 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Bcl.AsyncInterfaces</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1">
|
||||
<summary>Provides the core logic for implementing a manual-reset <see cref="T:System.Threading.Tasks.Sources.IValueTaskSource"/> or <see cref="T:System.Threading.Tasks.Sources.IValueTaskSource`1"/>.</summary>
|
||||
<typeparam name="TResult"></typeparam>
|
||||
</member>
|
||||
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._continuation">
|
||||
<summary>
|
||||
The callback to invoke when the operation completes if <see cref="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.OnCompleted(System.Action{System.Object},System.Object,System.Int16,System.Threading.Tasks.Sources.ValueTaskSourceOnCompletedFlags)"/> was called before the operation completed,
|
||||
or <see cref="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCoreShared.s_sentinel"/> if the operation completed before a callback was supplied,
|
||||
or null if a callback hasn't yet been provided and the operation hasn't yet completed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._continuationState">
|
||||
<summary>State to pass to <see cref="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._continuation"/>.</summary>
|
||||
</member>
|
||||
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._executionContext">
|
||||
<summary><see cref="T:System.Threading.ExecutionContext"/> to flow to the callback, or null if no flowing is required.</summary>
|
||||
</member>
|
||||
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._capturedContext">
|
||||
<summary>
|
||||
A "captured" <see cref="T:System.Threading.SynchronizationContext"/> or <see cref="T:System.Threading.Tasks.TaskScheduler"/> with which to invoke the callback,
|
||||
or null if no special context is required.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._completed">
|
||||
<summary>Whether the current operation has completed.</summary>
|
||||
</member>
|
||||
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._result">
|
||||
<summary>The result with which the operation succeeded, or the default value if it hasn't yet completed or failed.</summary>
|
||||
</member>
|
||||
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._error">
|
||||
<summary>The exception with which the operation failed, or null if it hasn't yet completed or completed successfully.</summary>
|
||||
</member>
|
||||
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._version">
|
||||
<summary>The current version of this value, used to help prevent misuse.</summary>
|
||||
</member>
|
||||
<member name="P:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.RunContinuationsAsynchronously">
|
||||
<summary>Gets or sets whether to force continuations to run asynchronously.</summary>
|
||||
<remarks>Continuations may run asynchronously if this is false, but they'll never run synchronously if this is true.</remarks>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.Reset">
|
||||
<summary>Resets to prepare for the next operation.</summary>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.SetResult(`0)">
|
||||
<summary>Completes with a successful result.</summary>
|
||||
<param name="result">The result.</param>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.SetException(System.Exception)">
|
||||
<summary>Complets with an error.</summary>
|
||||
<param name="error"></param>
|
||||
</member>
|
||||
<member name="P:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.Version">
|
||||
<summary>Gets the operation version.</summary>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.GetStatus(System.Int16)">
|
||||
<summary>Gets the status of the operation.</summary>
|
||||
<param name="token">Opaque value that was provided to the <see cref="T:System.Threading.Tasks.ValueTask"/>'s constructor.</param>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.GetResult(System.Int16)">
|
||||
<summary>Gets the result of the operation.</summary>
|
||||
<param name="token">Opaque value that was provided to the <see cref="T:System.Threading.Tasks.ValueTask"/>'s constructor.</param>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.OnCompleted(System.Action{System.Object},System.Object,System.Int16,System.Threading.Tasks.Sources.ValueTaskSourceOnCompletedFlags)">
|
||||
<summary>Schedules the continuation action for this operation.</summary>
|
||||
<param name="continuation">The continuation to invoke when the operation has completed.</param>
|
||||
<param name="state">The state object to pass to <paramref name="continuation"/> when it's invoked.</param>
|
||||
<param name="token">Opaque value that was provided to the <see cref="T:System.Threading.Tasks.ValueTask"/>'s constructor.</param>
|
||||
<param name="flags">The flags describing the behavior of the continuation.</param>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.ValidateToken(System.Int16)">
|
||||
<summary>Ensures that the specified token matches the current version.</summary>
|
||||
<param name="token">The token supplied by <see cref="T:System.Threading.Tasks.ValueTask"/>.</param>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.SignalCompletion">
|
||||
<summary>Signals that the operation has completed. Invoked after the result or error has been set.</summary>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.InvokeContinuation">
|
||||
<summary>
|
||||
Invokes the continuation with the appropriate captured context / scheduler.
|
||||
This assumes that if <see cref="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._executionContext"/> is not null we're already
|
||||
running within that <see cref="T:System.Threading.ExecutionContext"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Threading.Tasks.TaskAsyncEnumerableExtensions">
|
||||
<summary>Provides a set of static methods for configuring <see cref="T:System.Threading.Tasks.Task"/>-related behaviors on asynchronous enumerables and disposables.</summary>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.TaskAsyncEnumerableExtensions.ConfigureAwait(System.IAsyncDisposable,System.Boolean)">
|
||||
<summary>Configures how awaits on the tasks returned from an async disposable will be performed.</summary>
|
||||
<param name="source">The source async disposable.</param>
|
||||
<param name="continueOnCapturedContext">Whether to capture and marshal back to the current context.</param>
|
||||
<returns>The configured async disposable.</returns>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.TaskAsyncEnumerableExtensions.ConfigureAwait``1(System.Collections.Generic.IAsyncEnumerable{``0},System.Boolean)">
|
||||
<summary>Configures how awaits on the tasks returned from an async iteration will be performed.</summary>
|
||||
<typeparam name="T">The type of the objects being iterated.</typeparam>
|
||||
<param name="source">The source enumerable being iterated.</param>
|
||||
<param name="continueOnCapturedContext">Whether to capture and marshal back to the current context.</param>
|
||||
<returns>The configured enumerable.</returns>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.TaskAsyncEnumerableExtensions.WithCancellation``1(System.Collections.Generic.IAsyncEnumerable{``0},System.Threading.CancellationToken)">
|
||||
<summary>Sets the <see cref="T:System.Threading.CancellationToken"/> to be passed to <see cref="M:System.Collections.Generic.IAsyncEnumerable`1.GetAsyncEnumerator(System.Threading.CancellationToken)"/> when iterating.</summary>
|
||||
<typeparam name="T">The type of the objects being iterated.</typeparam>
|
||||
<param name="source">The source enumerable being iterated.</param>
|
||||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to use.</param>
|
||||
<returns>The configured enumerable.</returns>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder">
|
||||
<summary>Represents a builder for asynchronous iterators.</summary>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.Create">
|
||||
<summary>Creates an instance of the <see cref="T:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder"/> struct.</summary>
|
||||
<returns>The initialized instance.</returns>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.MoveNext``1(``0@)">
|
||||
<summary>Invokes <see cref="M:System.Runtime.CompilerServices.IAsyncStateMachine.MoveNext"/> on the state machine while guarding the <see cref="T:System.Threading.ExecutionContext"/>.</summary>
|
||||
<typeparam name="TStateMachine">The type of the state machine.</typeparam>
|
||||
<param name="stateMachine">The state machine instance, passed by reference.</param>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.AwaitOnCompleted``2(``0@,``1@)">
|
||||
<summary>Schedules the state machine to proceed to the next action when the specified awaiter completes.</summary>
|
||||
<typeparam name="TAwaiter">The type of the awaiter.</typeparam>
|
||||
<typeparam name="TStateMachine">The type of the state machine.</typeparam>
|
||||
<param name="awaiter">The awaiter.</param>
|
||||
<param name="stateMachine">The state machine.</param>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.AwaitUnsafeOnCompleted``2(``0@,``1@)">
|
||||
<summary>Schedules the state machine to proceed to the next action when the specified awaiter completes.</summary>
|
||||
<typeparam name="TAwaiter">The type of the awaiter.</typeparam>
|
||||
<typeparam name="TStateMachine">The type of the state machine.</typeparam>
|
||||
<param name="awaiter">The awaiter.</param>
|
||||
<param name="stateMachine">The state machine.</param>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.Complete">
|
||||
<summary>Marks iteration as being completed, whether successfully or otherwise.</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.ObjectIdForDebugger">
|
||||
<summary>Gets an object that may be used to uniquely identify this builder to the debugger.</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.AsyncIteratorStateMachineAttribute">
|
||||
<summary>Indicates whether a method is an asynchronous iterator.</summary>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.AsyncIteratorStateMachineAttribute.#ctor(System.Type)">
|
||||
<summary>Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.AsyncIteratorStateMachineAttribute"/> class.</summary>
|
||||
<param name="stateMachineType">The type object for the underlying state machine type that's used to implement a state machine method.</param>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.ConfiguredAsyncDisposable">
|
||||
<summary>Provides a type that can be used to configure how awaits on an <see cref="T:System.IAsyncDisposable"/> are performed.</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1">
|
||||
<summary>Provides an awaitable async enumerable that enables cancelable iteration and configured awaits.</summary>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.ConfigureAwait(System.Boolean)">
|
||||
<summary>Configures how awaits on the tasks returned from an async iteration will be performed.</summary>
|
||||
<param name="continueOnCapturedContext">Whether to capture and marshal back to the current context.</param>
|
||||
<returns>The configured enumerable.</returns>
|
||||
<remarks>This will replace any previous value set by <see cref="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.ConfigureAwait(System.Boolean)"/> for this iteration.</remarks>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.WithCancellation(System.Threading.CancellationToken)">
|
||||
<summary>Sets the <see cref="T:System.Threading.CancellationToken"/> to be passed to <see cref="M:System.Collections.Generic.IAsyncEnumerable`1.GetAsyncEnumerator(System.Threading.CancellationToken)"/> when iterating.</summary>
|
||||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to use.</param>
|
||||
<returns>The configured enumerable.</returns>
|
||||
<remarks>This will replace any previous <see cref="T:System.Threading.CancellationToken"/> set by <see cref="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.WithCancellation(System.Threading.CancellationToken)"/> for this iteration.</remarks>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.Enumerator">
|
||||
<summary>Provides an awaitable async enumerator that enables cancelable iteration and configured awaits.</summary>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.Enumerator.MoveNextAsync">
|
||||
<summary>Advances the enumerator asynchronously to the next element of the collection.</summary>
|
||||
<returns>
|
||||
A <see cref="T:System.Runtime.CompilerServices.ConfiguredValueTaskAwaitable`1"/> that will complete with a result of <c>true</c>
|
||||
if the enumerator was successfully advanced to the next element, or <c>false</c> if the enumerator has
|
||||
passed the end of the collection.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="P:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.Enumerator.Current">
|
||||
<summary>Gets the element in the collection at the current position of the enumerator.</summary>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.Enumerator.DisposeAsync">
|
||||
<summary>
|
||||
Performs application-defined tasks associated with freeing, releasing, or
|
||||
resetting unmanaged resources asynchronously.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Collections.Generic.IAsyncEnumerable`1">
|
||||
<summary>Exposes an enumerator that provides asynchronous iteration over values of a specified type.</summary>
|
||||
<typeparam name="T">The type of values to enumerate.</typeparam>
|
||||
</member>
|
||||
<member name="M:System.Collections.Generic.IAsyncEnumerable`1.GetAsyncEnumerator(System.Threading.CancellationToken)">
|
||||
<summary>Returns an enumerator that iterates asynchronously through the collection.</summary>
|
||||
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> that may be used to cancel the asynchronous iteration.</param>
|
||||
<returns>An enumerator that can be used to iterate asynchronously through the collection.</returns>
|
||||
</member>
|
||||
<member name="T:System.Collections.Generic.IAsyncEnumerator`1">
|
||||
<summary>Supports a simple asynchronous iteration over a generic collection.</summary>
|
||||
<typeparam name="T">The type of objects to enumerate.</typeparam>
|
||||
</member>
|
||||
<member name="M:System.Collections.Generic.IAsyncEnumerator`1.MoveNextAsync">
|
||||
<summary>Advances the enumerator asynchronously to the next element of the collection.</summary>
|
||||
<returns>
|
||||
A <see cref="T:System.Threading.Tasks.ValueTask`1"/> that will complete with a result of <c>true</c> if the enumerator
|
||||
was successfully advanced to the next element, or <c>false</c> if the enumerator has passed the end
|
||||
of the collection.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="P:System.Collections.Generic.IAsyncEnumerator`1.Current">
|
||||
<summary>Gets the element in the collection at the current position of the enumerator.</summary>
|
||||
</member>
|
||||
<member name="T:System.IAsyncDisposable">
|
||||
<summary>Provides a mechanism for releasing unmanaged resources asynchronously.</summary>
|
||||
</member>
|
||||
<member name="M:System.IAsyncDisposable.DisposeAsync">
|
||||
<summary>
|
||||
Performs application-defined tasks associated with freeing, releasing, or
|
||||
resetting unmanaged resources asynchronously.
|
||||
</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
BIN
Binary file not shown.
-223
@@ -1,223 +0,0 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Bcl.AsyncInterfaces</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1">
|
||||
<summary>Provides the core logic for implementing a manual-reset <see cref="T:System.Threading.Tasks.Sources.IValueTaskSource"/> or <see cref="T:System.Threading.Tasks.Sources.IValueTaskSource`1"/>.</summary>
|
||||
<typeparam name="TResult"></typeparam>
|
||||
</member>
|
||||
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._continuation">
|
||||
<summary>
|
||||
The callback to invoke when the operation completes if <see cref="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.OnCompleted(System.Action{System.Object},System.Object,System.Int16,System.Threading.Tasks.Sources.ValueTaskSourceOnCompletedFlags)"/> was called before the operation completed,
|
||||
or <see cref="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCoreShared.s_sentinel"/> if the operation completed before a callback was supplied,
|
||||
or null if a callback hasn't yet been provided and the operation hasn't yet completed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._continuationState">
|
||||
<summary>State to pass to <see cref="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._continuation"/>.</summary>
|
||||
</member>
|
||||
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._executionContext">
|
||||
<summary><see cref="T:System.Threading.ExecutionContext"/> to flow to the callback, or null if no flowing is required.</summary>
|
||||
</member>
|
||||
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._capturedContext">
|
||||
<summary>
|
||||
A "captured" <see cref="T:System.Threading.SynchronizationContext"/> or <see cref="T:System.Threading.Tasks.TaskScheduler"/> with which to invoke the callback,
|
||||
or null if no special context is required.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._completed">
|
||||
<summary>Whether the current operation has completed.</summary>
|
||||
</member>
|
||||
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._result">
|
||||
<summary>The result with which the operation succeeded, or the default value if it hasn't yet completed or failed.</summary>
|
||||
</member>
|
||||
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._error">
|
||||
<summary>The exception with which the operation failed, or null if it hasn't yet completed or completed successfully.</summary>
|
||||
</member>
|
||||
<member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._version">
|
||||
<summary>The current version of this value, used to help prevent misuse.</summary>
|
||||
</member>
|
||||
<member name="P:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.RunContinuationsAsynchronously">
|
||||
<summary>Gets or sets whether to force continuations to run asynchronously.</summary>
|
||||
<remarks>Continuations may run asynchronously if this is false, but they'll never run synchronously if this is true.</remarks>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.Reset">
|
||||
<summary>Resets to prepare for the next operation.</summary>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.SetResult(`0)">
|
||||
<summary>Completes with a successful result.</summary>
|
||||
<param name="result">The result.</param>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.SetException(System.Exception)">
|
||||
<summary>Complets with an error.</summary>
|
||||
<param name="error"></param>
|
||||
</member>
|
||||
<member name="P:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.Version">
|
||||
<summary>Gets the operation version.</summary>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.GetStatus(System.Int16)">
|
||||
<summary>Gets the status of the operation.</summary>
|
||||
<param name="token">Opaque value that was provided to the <see cref="T:System.Threading.Tasks.ValueTask"/>'s constructor.</param>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.GetResult(System.Int16)">
|
||||
<summary>Gets the result of the operation.</summary>
|
||||
<param name="token">Opaque value that was provided to the <see cref="T:System.Threading.Tasks.ValueTask"/>'s constructor.</param>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.OnCompleted(System.Action{System.Object},System.Object,System.Int16,System.Threading.Tasks.Sources.ValueTaskSourceOnCompletedFlags)">
|
||||
<summary>Schedules the continuation action for this operation.</summary>
|
||||
<param name="continuation">The continuation to invoke when the operation has completed.</param>
|
||||
<param name="state">The state object to pass to <paramref name="continuation"/> when it's invoked.</param>
|
||||
<param name="token">Opaque value that was provided to the <see cref="T:System.Threading.Tasks.ValueTask"/>'s constructor.</param>
|
||||
<param name="flags">The flags describing the behavior of the continuation.</param>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.ValidateToken(System.Int16)">
|
||||
<summary>Ensures that the specified token matches the current version.</summary>
|
||||
<param name="token">The token supplied by <see cref="T:System.Threading.Tasks.ValueTask"/>.</param>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.SignalCompletion">
|
||||
<summary>Signals that the operation has completed. Invoked after the result or error has been set.</summary>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.InvokeContinuation">
|
||||
<summary>
|
||||
Invokes the continuation with the appropriate captured context / scheduler.
|
||||
This assumes that if <see cref="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._executionContext"/> is not null we're already
|
||||
running within that <see cref="T:System.Threading.ExecutionContext"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Threading.Tasks.TaskAsyncEnumerableExtensions">
|
||||
<summary>Provides a set of static methods for configuring <see cref="T:System.Threading.Tasks.Task"/>-related behaviors on asynchronous enumerables and disposables.</summary>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.TaskAsyncEnumerableExtensions.ConfigureAwait(System.IAsyncDisposable,System.Boolean)">
|
||||
<summary>Configures how awaits on the tasks returned from an async disposable will be performed.</summary>
|
||||
<param name="source">The source async disposable.</param>
|
||||
<param name="continueOnCapturedContext">Whether to capture and marshal back to the current context.</param>
|
||||
<returns>The configured async disposable.</returns>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.TaskAsyncEnumerableExtensions.ConfigureAwait``1(System.Collections.Generic.IAsyncEnumerable{``0},System.Boolean)">
|
||||
<summary>Configures how awaits on the tasks returned from an async iteration will be performed.</summary>
|
||||
<typeparam name="T">The type of the objects being iterated.</typeparam>
|
||||
<param name="source">The source enumerable being iterated.</param>
|
||||
<param name="continueOnCapturedContext">Whether to capture and marshal back to the current context.</param>
|
||||
<returns>The configured enumerable.</returns>
|
||||
</member>
|
||||
<member name="M:System.Threading.Tasks.TaskAsyncEnumerableExtensions.WithCancellation``1(System.Collections.Generic.IAsyncEnumerable{``0},System.Threading.CancellationToken)">
|
||||
<summary>Sets the <see cref="T:System.Threading.CancellationToken"/> to be passed to <see cref="M:System.Collections.Generic.IAsyncEnumerable`1.GetAsyncEnumerator(System.Threading.CancellationToken)"/> when iterating.</summary>
|
||||
<typeparam name="T">The type of the objects being iterated.</typeparam>
|
||||
<param name="source">The source enumerable being iterated.</param>
|
||||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to use.</param>
|
||||
<returns>The configured enumerable.</returns>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder">
|
||||
<summary>Represents a builder for asynchronous iterators.</summary>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.Create">
|
||||
<summary>Creates an instance of the <see cref="T:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder"/> struct.</summary>
|
||||
<returns>The initialized instance.</returns>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.MoveNext``1(``0@)">
|
||||
<summary>Invokes <see cref="M:System.Runtime.CompilerServices.IAsyncStateMachine.MoveNext"/> on the state machine while guarding the <see cref="T:System.Threading.ExecutionContext"/>.</summary>
|
||||
<typeparam name="TStateMachine">The type of the state machine.</typeparam>
|
||||
<param name="stateMachine">The state machine instance, passed by reference.</param>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.AwaitOnCompleted``2(``0@,``1@)">
|
||||
<summary>Schedules the state machine to proceed to the next action when the specified awaiter completes.</summary>
|
||||
<typeparam name="TAwaiter">The type of the awaiter.</typeparam>
|
||||
<typeparam name="TStateMachine">The type of the state machine.</typeparam>
|
||||
<param name="awaiter">The awaiter.</param>
|
||||
<param name="stateMachine">The state machine.</param>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.AwaitUnsafeOnCompleted``2(``0@,``1@)">
|
||||
<summary>Schedules the state machine to proceed to the next action when the specified awaiter completes.</summary>
|
||||
<typeparam name="TAwaiter">The type of the awaiter.</typeparam>
|
||||
<typeparam name="TStateMachine">The type of the state machine.</typeparam>
|
||||
<param name="awaiter">The awaiter.</param>
|
||||
<param name="stateMachine">The state machine.</param>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.Complete">
|
||||
<summary>Marks iteration as being completed, whether successfully or otherwise.</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.ObjectIdForDebugger">
|
||||
<summary>Gets an object that may be used to uniquely identify this builder to the debugger.</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.AsyncIteratorStateMachineAttribute">
|
||||
<summary>Indicates whether a method is an asynchronous iterator.</summary>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.AsyncIteratorStateMachineAttribute.#ctor(System.Type)">
|
||||
<summary>Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.AsyncIteratorStateMachineAttribute"/> class.</summary>
|
||||
<param name="stateMachineType">The type object for the underlying state machine type that's used to implement a state machine method.</param>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.ConfiguredAsyncDisposable">
|
||||
<summary>Provides a type that can be used to configure how awaits on an <see cref="T:System.IAsyncDisposable"/> are performed.</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1">
|
||||
<summary>Provides an awaitable async enumerable that enables cancelable iteration and configured awaits.</summary>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.ConfigureAwait(System.Boolean)">
|
||||
<summary>Configures how awaits on the tasks returned from an async iteration will be performed.</summary>
|
||||
<param name="continueOnCapturedContext">Whether to capture and marshal back to the current context.</param>
|
||||
<returns>The configured enumerable.</returns>
|
||||
<remarks>This will replace any previous value set by <see cref="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.ConfigureAwait(System.Boolean)"/> for this iteration.</remarks>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.WithCancellation(System.Threading.CancellationToken)">
|
||||
<summary>Sets the <see cref="T:System.Threading.CancellationToken"/> to be passed to <see cref="M:System.Collections.Generic.IAsyncEnumerable`1.GetAsyncEnumerator(System.Threading.CancellationToken)"/> when iterating.</summary>
|
||||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to use.</param>
|
||||
<returns>The configured enumerable.</returns>
|
||||
<remarks>This will replace any previous <see cref="T:System.Threading.CancellationToken"/> set by <see cref="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.WithCancellation(System.Threading.CancellationToken)"/> for this iteration.</remarks>
|
||||
</member>
|
||||
<member name="T:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.Enumerator">
|
||||
<summary>Provides an awaitable async enumerator that enables cancelable iteration and configured awaits.</summary>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.Enumerator.MoveNextAsync">
|
||||
<summary>Advances the enumerator asynchronously to the next element of the collection.</summary>
|
||||
<returns>
|
||||
A <see cref="T:System.Runtime.CompilerServices.ConfiguredValueTaskAwaitable`1"/> that will complete with a result of <c>true</c>
|
||||
if the enumerator was successfully advanced to the next element, or <c>false</c> if the enumerator has
|
||||
passed the end of the collection.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="P:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.Enumerator.Current">
|
||||
<summary>Gets the element in the collection at the current position of the enumerator.</summary>
|
||||
</member>
|
||||
<member name="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.Enumerator.DisposeAsync">
|
||||
<summary>
|
||||
Performs application-defined tasks associated with freeing, releasing, or
|
||||
resetting unmanaged resources asynchronously.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Collections.Generic.IAsyncEnumerable`1">
|
||||
<summary>Exposes an enumerator that provides asynchronous iteration over values of a specified type.</summary>
|
||||
<typeparam name="T">The type of values to enumerate.</typeparam>
|
||||
</member>
|
||||
<member name="M:System.Collections.Generic.IAsyncEnumerable`1.GetAsyncEnumerator(System.Threading.CancellationToken)">
|
||||
<summary>Returns an enumerator that iterates asynchronously through the collection.</summary>
|
||||
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> that may be used to cancel the asynchronous iteration.</param>
|
||||
<returns>An enumerator that can be used to iterate asynchronously through the collection.</returns>
|
||||
</member>
|
||||
<member name="T:System.Collections.Generic.IAsyncEnumerator`1">
|
||||
<summary>Supports a simple asynchronous iteration over a generic collection.</summary>
|
||||
<typeparam name="T">The type of objects to enumerate.</typeparam>
|
||||
</member>
|
||||
<member name="M:System.Collections.Generic.IAsyncEnumerator`1.MoveNextAsync">
|
||||
<summary>Advances the enumerator asynchronously to the next element of the collection.</summary>
|
||||
<returns>
|
||||
A <see cref="T:System.Threading.Tasks.ValueTask`1"/> that will complete with a result of <c>true</c> if the enumerator
|
||||
was successfully advanced to the next element, or <c>false</c> if the enumerator has passed the end
|
||||
of the collection.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="P:System.Collections.Generic.IAsyncEnumerator`1.Current">
|
||||
<summary>Gets the element in the collection at the current position of the enumerator.</summary>
|
||||
</member>
|
||||
<member name="T:System.IAsyncDisposable">
|
||||
<summary>Provides a mechanism for releasing unmanaged resources asynchronously.</summary>
|
||||
</member>
|
||||
<member name="M:System.IAsyncDisposable.DisposeAsync">
|
||||
<summary>
|
||||
Performs application-defined tasks associated with freeing, releasing, or
|
||||
resetting unmanaged resources asynchronously.
|
||||
</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
BIN
Binary file not shown.
-8
@@ -1,8 +0,0 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Bcl.AsyncInterfaces</name>
|
||||
</assembly>
|
||||
<members>
|
||||
</members>
|
||||
</doc>
|
||||
BIN
Binary file not shown.
BIN
Binary file not shown.
BIN
Binary file not shown.
@@ -1 +0,0 @@
|
||||
0f7f38c4fd323b26da10cce95f857f77f0f09b48
|
||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
BIN
Binary file not shown.
Binary file not shown.
Binary file not shown.
+558
-38
@@ -3509,6 +3509,26 @@
|
||||
Summary description for Field.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:MySql.Data.MySqlClient.CustomInstaller">
|
||||
<summary>
|
||||
We are adding a custom installer class to our assembly so our installer
|
||||
can make proper changes to the machine.config file.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MySql.Data.MySqlClient.CustomInstaller.Install(System.Collections.IDictionary)">
|
||||
<summary>
|
||||
We override Install so we can add our assembly to the proper
|
||||
machine.config files.
|
||||
</summary>
|
||||
<param name="stateSaver"></param>
|
||||
</member>
|
||||
<member name="M:MySql.Data.MySqlClient.CustomInstaller.Uninstall(System.Collections.IDictionary)">
|
||||
<summary>
|
||||
We override Uninstall so we can remove out assembly from the
|
||||
machine.config files.
|
||||
</summary>
|
||||
<param name="savedState"></param>
|
||||
</member>
|
||||
<member name="T:MySql.Data.MySqlClient.MySqlCommandBuilder">
|
||||
<summary>
|
||||
Automatically generates single-table commands used to reconcile changes made to a DataSet with the associated MySQL database. This class cannot be inherited.
|
||||
@@ -6083,6 +6103,21 @@
|
||||
Abstract class that provides common functionality for connection options that apply for all protocols.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.MySqlClient.MySqlBaseConnectionStringBuilder.Options">
|
||||
<summary>
|
||||
Readonly field containing a collection of protocol shared connection options.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.MySqlClient.MySqlBaseConnectionStringBuilder.HasProcAccess">
|
||||
<summary>
|
||||
Gets or sets a flag indicating if the object has access to procedures.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.MySqlClient.MySqlBaseConnectionStringBuilder.values">
|
||||
<summary>
|
||||
Gets or sets a dictionary representing key-value pairs for each connection option.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.MySqlClient.MySqlBaseConnectionStringBuilder.Server">
|
||||
<summary>
|
||||
Gets or sets the name of the server.
|
||||
@@ -6271,6 +6306,22 @@
|
||||
Contains connection options specific to the Classic protocol.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MySql.Data.MySqlClient.MySqlConnectionStringBuilder.#ctor">
|
||||
<summary>
|
||||
Main constructor.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MySql.Data.MySqlClient.MySqlConnectionStringBuilder.#ctor(System.String)">
|
||||
<summary>
|
||||
Constructor accepting a connection string.
|
||||
</summary>
|
||||
<param name="connectionString">The connection string.</param>
|
||||
</member>
|
||||
<member name="F:MySql.Data.MySqlClient.MySqlConnectionStringBuilder.Options">
|
||||
<summary>
|
||||
Readonly field containing a collection of classic protocol and protocol shared connection options.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.MySqlClient.MySqlConnectionStringBuilder.PipeName">
|
||||
<summary>
|
||||
Gets or sets the name of the named pipe that should be used
|
||||
@@ -6525,6 +6576,12 @@
|
||||
Gets or sets the pattern to match for the columns that should not be treated as UTF8.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.MySqlClient.MySqlConnectionStringBuilder.Item(System.String)">
|
||||
<summary>
|
||||
Gets or sets a connection option.
|
||||
</summary>
|
||||
<param name="keyword">The keyword that identifies the connection option to modify.</param>
|
||||
</member>
|
||||
<member name="T:MySql.Data.MySqlClient.ClientFlags">
|
||||
<summary>
|
||||
Summary description for ClientParam.
|
||||
@@ -6938,6 +6995,27 @@
|
||||
removing locked rows from the result set.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:MySql.Data.MySqlClient.CompressionType">
|
||||
<summary>
|
||||
Defines the type of compression used when data is exchanged between client and server.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.MySqlClient.CompressionType.Preferred">
|
||||
<summary>
|
||||
Uses compression if client and server are able to reach a concensus. Otherwise, compression
|
||||
is not used.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.MySqlClient.CompressionType.Required">
|
||||
<summary>
|
||||
Enforces the use of compression. If no concensus is reached, an error is raised.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.MySqlClient.CompressionType.Disabled">
|
||||
<summary>
|
||||
Disables compression.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:MySql.Data.MySqlClient.MySqlError">
|
||||
<summary>
|
||||
Collection of error codes that can be returned by the server
|
||||
@@ -12291,6 +12369,42 @@
|
||||
Looks up a localized string similar to Scheme '{0}' is not valid..
|
||||
</summary>
|
||||
</member>
|
||||
<!-- Badly formed XML comment ignored for member "P:MySql.Data.ResourcesX.CompressionAlgorithmNegotiationFailed" -->
|
||||
<member name="P:MySql.Data.ResourcesX.CompressionAlgorithmNotSupported">
|
||||
<summary>
|
||||
Looks up a localized string similar to Compression using {0} is not supported..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.CompressionFailedToLoadLibzstdAssembly">
|
||||
<summary>
|
||||
Looks up a localized string similar to Failed to load libzstd.dll. Removing zstd_stream from the client supported compression algorithms..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.CompressionForSpecificAlgorithmNotSupportedInNetFramework">
|
||||
<summary>
|
||||
Looks up a localized string similar to Compression using {0} is not supported in .NET Framework..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.CompressionInvalidValue">
|
||||
<summary>
|
||||
Looks up a localized string similar to The connection property 'compression' acceptable values are: 'preferred', 'required' or 'disabled'. The value '{0}' is not acceptable..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.CompressionNotEnabled">
|
||||
<summary>
|
||||
Looks up a localized string similar to Compression is not enabled..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.CompressionNotSupportedByServer">
|
||||
<summary>
|
||||
Looks up a localized string similar to Compression requested but the server does not support it..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.CompressionPendingMessagesToProcess">
|
||||
<summary>
|
||||
Looks up a localized string similar to There are still decompressed messages pending to be processed..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.DuplicateUserDefinedAttribute">
|
||||
<summary>
|
||||
Looks up a localized string similar to Duplicate key '{0}' used in "connection-attributes"..
|
||||
@@ -12301,6 +12415,11 @@
|
||||
Looks up a localized string similar to Key name in connection attribute cannot be an empty string..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.EmptyOptions">
|
||||
<summary>
|
||||
Looks up a localized string similar to At least one option must be specified..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.FeatureNotSupported">
|
||||
<summary>
|
||||
Looks up a localized string similar to This feature is currently not supported..
|
||||
@@ -12411,6 +12530,11 @@
|
||||
Looks up a localized string similar to Field '{0}' is mandatory..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.MissingSchemaOption">
|
||||
<summary>
|
||||
Looks up a localized string similar to Missed required 'schema' option..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.MoreThanOneDocumentId">
|
||||
<summary>
|
||||
Looks up a localized string similar to More than one document id was generated. Please use the DocumentIds property instead..
|
||||
@@ -12476,6 +12600,11 @@
|
||||
Looks up a localized string similar to ProgramData path is not defined..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.SchemaCreateCollectionMsg">
|
||||
<summary>
|
||||
Looks up a localized string similar to The server doesn't support the requested operation. Please update the MySQL Server and/or Client library.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.ThrowingAwayResults">
|
||||
<summary>
|
||||
Looks up a localized string similar to The process of closing the resultset and resulted in results being lost..
|
||||
@@ -12742,6 +12871,262 @@
|
||||
</summary>
|
||||
<returns>A string representation of the WKT.</returns>
|
||||
</member>
|
||||
<member name="T:MySql.Data.X.common.UnmanagedLibraryLoader">
|
||||
<summary>
|
||||
Provides functionality for loading unmanaged libraries.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.common.UnmanagedLibraryLoader.LoadUnmanagedLibraryFromEmbeddedResources(System.String,System.String)">
|
||||
<summary>
|
||||
Loads the specified unmanaged library from the embedded resources.
|
||||
</summary>
|
||||
<param name="applicationName">The application name.</param>
|
||||
<param name="libraryName">The library name.</param>
|
||||
</member>
|
||||
<member name="T:MySql.Data.X.Communication.XCompressionController">
|
||||
<summary>
|
||||
Provides support for configuring X Protocol compressed messages.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController.ALGORITHMS_SUBKEY">
|
||||
<summary>
|
||||
The capabilities sub-key used to specify the compression algorithm.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController.COMPRESSION_KEY">
|
||||
<summary>
|
||||
The capabilities key used to specify the compression capability.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController.COMPRESSION_THRESHOLD">
|
||||
<summary>
|
||||
Messages with a value lower than this threshold will not be compressed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController.DEFAULT_SERVER_COMBINE_MIXED_MESSAGES_VALUE">
|
||||
<summary>
|
||||
Default value for enabling or disabling combined compressed messages.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController.DEFAULT_SERVER_MAX_COMBINE_MESSAGES_VALUE">
|
||||
<summary>
|
||||
Default value for the maximum number of combined compressed messages contained in a compression message.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController.DEFLATE_STREAM_COMPRESSION_ALGORITHM">
|
||||
<summary>
|
||||
deflate_stream compression algorithm.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController.LZ4_MESSAGE_COMPRESSION_ALGORITHM">
|
||||
<summary>
|
||||
lz4_message compression algorithm.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController.SERVER_COMBINE_MIXED_MESSAGES_SUBKEY">
|
||||
<summary>
|
||||
The capabilities sub-key used to specify if combining compressed messages is permitted.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController.SERVER_MAX_COMBINE_MESSAGES_SUBKEY">
|
||||
<summary>
|
||||
The capabilities sub-key used to specify the maximum number of compressed messages contained in a compression message.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController.ZSTD_STREAM_COMPRESSION_ALGORITHM">
|
||||
<summary>
|
||||
zstd_stream compression algorithm.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController._buffer">
|
||||
<summary>
|
||||
Buffer used to store the data received from the server.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController._deflateCompressStream">
|
||||
<summary>
|
||||
Deflate stream used for compressing data.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController._deflateDecompressStream">
|
||||
<summary>
|
||||
Deflate stream used for decompressing data.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController._initializeForCompression">
|
||||
<summary>
|
||||
Flag indicating if the initialization is for compression or decompression.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController._lastCommunicationPacket">
|
||||
<summary>
|
||||
Stores the communication packet generated the last time ReadNextBufferedMessage method was called.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController._libzstdLoaded">
|
||||
<summary>
|
||||
Indicates if the libzstd.dll has been loaded.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController._multipleMessagesStream">
|
||||
<summary>
|
||||
Stream used to store multiple X Protocol messages.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController._zstdDecompressStream">
|
||||
<summary>
|
||||
ZStandard stream used for decompressing data.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.#cctor">
|
||||
<summary>
|
||||
Static constructor used to initialize the client supported compression algorithms.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.#ctor(System.String,System.Boolean)">
|
||||
<summary>
|
||||
Main constructor used to set the compression algorithm and initialize the list of messages to
|
||||
be compressed by the client.
|
||||
</summary>
|
||||
<param name="compressionAlgorithm">The compression algorithm to use.</param>
|
||||
<param name="initializeForCompression">Flag indicating if the initialization is for compression or decompression.</param>
|
||||
</member>
|
||||
<member name="P:MySql.Data.X.Communication.XCompressionController.ClientSupportedCompressedMessages">
|
||||
<summary>
|
||||
Gets or sets the list of messages that should be compressed by the client when compression is enabled.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.X.Communication.XCompressionController.ClientSupportedCompressionAlgorithms">
|
||||
<summary>
|
||||
Gets or sets an array containing the compression algorithms supported by the client.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.X.Communication.XCompressionController.CompressionAlgorithm">
|
||||
<summary>
|
||||
Gets or sets the compression algorithm.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.X.Communication.XCompressionController.IsCompressionEnabled">
|
||||
<summary>
|
||||
Flag indicating if compression is enabled.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.X.Communication.XCompressionController.LastMessageContainsMultipleMessages">
|
||||
<summary>
|
||||
Flag indicating if the last decompressed message contains multiple messages.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.Compress(System.Byte[])">
|
||||
<summary>
|
||||
General method used to compress data using the compression algorithm defined in the constructor.
|
||||
</summary>
|
||||
<param name="input">The data to compress.</param>
|
||||
<returns>A compressed byte array.</returns>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.CompressUsingDeflateStream(System.Byte[])">
|
||||
<summary>
|
||||
Compresses data using the deflate_stream algorithm.
|
||||
</summary>
|
||||
<param name="input">The data to compress.</param>
|
||||
<returns>A compressed byte array.</returns>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.CompressUsingLz4Message(System.Byte[])">
|
||||
<summary>
|
||||
Compresses data using the lz4_message algorithm.
|
||||
</summary>
|
||||
<param name="input">The data to compress.</param>
|
||||
<returns>A compressed byte array.</returns>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.CompressUsingZstdStream(System.Byte[])">
|
||||
<summary>
|
||||
Compresses data using the zstd_stream algorithm.
|
||||
</summary>
|
||||
<param name="input">The data to compress.</param>
|
||||
<returns>A compressed byte array.</returns>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.Decompress(System.Byte[],System.Int32)">
|
||||
<summary>
|
||||
General method used to decompress data using the compression algorithm defined in the constructor.
|
||||
</summary>
|
||||
<param name="input">The data to decompress.</param>
|
||||
<param name="length">The expected length of the decompressed data.</param>
|
||||
<returns>A decompressed byte array.</returns>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.DecompressUsingDeflateStream(System.Byte[],System.Int32)">
|
||||
<summary>
|
||||
Decompresses data using the deflate_stream compression algorithm.
|
||||
</summary>
|
||||
<param name="input">The data to decompress.</param>
|
||||
<param name="length">The expected length of the decompressed data.</param>
|
||||
<returns>A decompressed byte array.</returns>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.DecompressUsingLz4Message(System.Byte[],System.Int32)">
|
||||
<summary>
|
||||
Decompresses data using the lz4_message compression algorithm.
|
||||
</summary>
|
||||
<param name="input">The data to decompress.</param>
|
||||
<param name="length">The expected length of the decompressed data.</param>
|
||||
<returns>A decompressed byte array.</returns>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.DecompressUsingZstdStream(System.Byte[],System.Int32)">
|
||||
<summary>
|
||||
Decompresses data using the zstd_stream compression algorithm.
|
||||
</summary>
|
||||
<param name="input">The data to decompress.</param>
|
||||
<param name="length">The expected length of the decompressed data.</param>
|
||||
<returns>A decompressed byte array.</returns>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.Close">
|
||||
<summary>
|
||||
Closes and disposes of any open streams.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.ReadNextBufferedMessage">
|
||||
<summary>
|
||||
Gets the byte array representing the next X Protocol frame that is stored in cache.
|
||||
</summary>
|
||||
<returns>A byte array representing an X Protocol frame.</returns>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.ReadNextBufferedMessageAsCommunicationPacket">
|
||||
<summary>
|
||||
Gets a <see cref="T:MySqlX.Communication.CommunicationPacket"/> representing the next X Protocol frame that is stored in cache.
|
||||
</summary>
|
||||
<returns>A <see cref="T:MySqlX.Communication.CommunicationPacket"/> with the next X Protocol frame.</returns>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.LoadLibzstdLibrary">
|
||||
<summary>
|
||||
Loads the libzstd.dll assembly.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:MySql.Data.X.XDevAPI.Common.CreateCollectionOptions">
|
||||
<summary>
|
||||
This object store the required parameters to create a Collection with schema validation.
|
||||
</summary>
|
||||
<param name="ReuseExisting">If false, throws an exception if the collection exists.</param>
|
||||
<param name="Validation">Object which hold the Level and Schema parameters</param>
|
||||
<see cref="P:MySql.Data.X.XDevAPI.Common.CreateCollectionOptions.Validation"/>
|
||||
</member>
|
||||
<member name="P:MySql.Data.X.XDevAPI.Common.ModifyCollectionOptions.Validation">
|
||||
<summary>
|
||||
This object store the required parameters to Modify a Collection with schema validation.
|
||||
</summary>
|
||||
<param name="Validation">Object which hold the Level and Schema parameters</param>
|
||||
<see cref="P:MySql.Data.X.XDevAPI.Common.ModifyCollectionOptions.Validation"/>
|
||||
</member>
|
||||
<member name="P:MySql.Data.X.XDevAPI.Common.Validation.Level">
|
||||
<summary>
|
||||
This object store the required parameters to create a Collection with schema validation.
|
||||
</summary>
|
||||
<param name="Level">It can be STRICT to enable schema validation or OFF to disable <see cref="T:MySql.Data.X.XDevAPI.Common.ValidationLevel"/></param>
|
||||
<param name="Schema">The JSON which define the rules to be validated in the collection</param>
|
||||
</member>
|
||||
<member name="T:MySql.Data.X.XDevAPI.Common.ValidationLevel">
|
||||
<summary>
|
||||
The possible values for parameter Level in Validation object.
|
||||
</summary>
|
||||
<param name="STRICT">Enforce schema validation.</param>
|
||||
<param name="OFF">Schema validation disabled.</param>
|
||||
</member>
|
||||
<member name="T:MySqlX.Security.ExternalAuthenticationPlugin">
|
||||
<summary>
|
||||
Implementation of EXTERNAL authentication type.
|
||||
@@ -12773,6 +13158,44 @@
|
||||
<param name="guid2">The second <see cref="T:System.Guid"/> to compare.</param>
|
||||
<returns>An integer that indicates the lexical relationship between the two comparands, similar to <see cref="M:System.String.Compare(System.String,System.String)"/></returns>
|
||||
</member>
|
||||
<member name="M:MySqlX.Communication.XPacketReaderWriter.#ctor(System.IO.Stream)">
|
||||
<summary>
|
||||
Constructor that sets the stream used to read or write data.
|
||||
</summary>
|
||||
<param name="stream">The stream used to read or write data.</param>
|
||||
</member>
|
||||
<member name="M:MySqlX.Communication.XPacketReaderWriter.#ctor(System.IO.Stream,MySql.Data.X.Communication.XCompressionController)">
|
||||
<summary>
|
||||
Constructor that sets the stream used to read or write data and the compression controller.
|
||||
</summary>
|
||||
<param name="stream">The stream used to read or write data.</param>
|
||||
<param name="compressionController">The compression controller.</param>
|
||||
</member>
|
||||
<member name="P:MySqlX.Communication.XPacketReaderWriter.CompressionController">
|
||||
<summary>
|
||||
Gets or sets the compression controller uses to manage compression operations.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MySqlX.Communication.XPacketReaderWriter.Write(System.Int32,Google.Protobuf.IMessage)">
|
||||
<summary>
|
||||
Writes X Protocol frames to the X Plugin.
|
||||
</summary>
|
||||
<param name="id">The integer representation of the client message identifier used for the message.</param>
|
||||
<param name="message">The message to include in the X Protocol frame.</param>
|
||||
</member>
|
||||
<member name="M:MySqlX.Communication.XPacketReaderWriter.Write(MySqlX.Communication.ClientMessageId,Google.Protobuf.IMessage)">
|
||||
<summary>
|
||||
Writes X Protocol frames to the X Plugin.
|
||||
</summary>
|
||||
<param name="id">The client message identifier used for the message.</param>
|
||||
<param name="message">The message to include in the X Protocol frame.</param>
|
||||
</member>
|
||||
<member name="M:MySqlX.Communication.XPacketReaderWriter.Read">
|
||||
<summary>
|
||||
Reads X Protocol frames incoming from the X Plugin.
|
||||
</summary>
|
||||
<returns>A <see cref="T:MySqlX.Communication.CommunicationPacket"/> instance representing the X Protocol frame that was read.</returns>
|
||||
</member>
|
||||
<member name="T:MySqlX.Protocol.ProtocolBase">
|
||||
<summary>
|
||||
Abstract class for the protocol base operations in client/server communication.
|
||||
@@ -12977,6 +13400,15 @@
|
||||
<member name="M:MySqlX.Protocol.X.ExprUnparser.ExprToString(Mysqlx.Expr.Expr)">
|
||||
Serialize an expression to a string.
|
||||
</member>
|
||||
<member name="M:MySqlX.Protocol.XProtocol.SendExecuteStatementOptions(System.String,System.String,System.Collections.Generic.KeyValuePair{System.String,System.Object}[])">
|
||||
<summary>
|
||||
Build the message to be sent to MySQL Server to execute statement "Create" or "Modify" collection with schema options
|
||||
</summary>
|
||||
<param name="ns">The namespace</param>
|
||||
<param name="stmt">The name of the command to be executed on MySql Server</param>
|
||||
<param name="args">Array of KeyValuePairs with the parameters required to build the message</param>
|
||||
<returns>void.</returns>
|
||||
</member>
|
||||
<member name="M:MySqlX.Protocol.XProtocol.SendDelete(System.String,System.String,System.Boolean,MySqlX.XDevAPI.Common.FilterParams)">
|
||||
<summary>
|
||||
Sends the delete documents message
|
||||
@@ -13067,11 +13499,58 @@
|
||||
Implementation class of InternalSession to manage connections using the Xprotocol type object.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySqlX.Sessions.XInternalSession._readerCompressionController">
|
||||
<summary>
|
||||
Defines the compression controller that will be passed on the <see cref="T:MySqlX.Communication.XPacketReaderWriter"/> instance when
|
||||
compression is enabled.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySqlX.Sessions.XInternalSession._writerCompressionController">
|
||||
<summary>
|
||||
Defines the compression controller that will be passed on the <see cref="T:MySqlX.Communication.XPacketReaderWriter"/> instance when
|
||||
compression is enabled.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySqlX.Sessions.XInternalSession._sshHandler">
|
||||
<summary>
|
||||
The used client to handle SSH connections.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MySqlX.Sessions.XInternalSession.NegotiateCompression(System.String[])">
|
||||
<summary>
|
||||
Negotiates compression capabilities with the server.
|
||||
</summary>
|
||||
<param name="serverSupportedAlgorithms">An array containing the compression algorithms supported by the server.</param>
|
||||
</member>
|
||||
<member name="M:MySqlX.Sessions.XInternalSession.CreateCollection(System.String,System.String,MySql.Data.X.XDevAPI.Common.CreateCollectionOptions)">
|
||||
<summary>
|
||||
Prepare the dictionary of arguments required to create a MySQL message.
|
||||
</summary>
|
||||
<param name="schemaName">The name of the MySQL schema.</param>
|
||||
<param name="collectionName">The name of the collection.</param>
|
||||
<param name="options">This object hold the parameters required to create the collection.</param>
|
||||
<see cref="T:MySql.Data.X.XDevAPI.Common.CreateCollectionOptions"/>
|
||||
<returns>Collection referente.</returns>
|
||||
</member>
|
||||
<member name="M:MySqlX.Sessions.XInternalSession.ModifyCollection(System.String,System.String,System.Nullable{MySql.Data.X.XDevAPI.Common.ModifyCollectionOptions})">
|
||||
<summary>
|
||||
Prepare the dictionary of arguments required to Modify a MySQL message.
|
||||
</summary>
|
||||
<param name="schemaName">The name of the MySQL schema.</param>
|
||||
<param name="collectionName">The name of the collection.</param>
|
||||
<param name="options">This object hold the parameters required to Modify the collection.</param>
|
||||
<see cref="T:MySql.Data.X.XDevAPI.Common.ModifyCollectionOptions"/>
|
||||
<returns>Collection referente.</returns>
|
||||
</member>
|
||||
<member name="M:MySqlX.Sessions.XInternalSession.GetCompressionAlgorithm(System.Boolean)">
|
||||
<summary>
|
||||
Gets the compression algorithm being used to compress or decompress data.
|
||||
</summary>
|
||||
<param name="fromReaderController">Flag to indicate if the compression algorithm should be
|
||||
retrieved from the reader or writer controller.</param>
|
||||
<returns>The name of the compression algorithm being used if any.
|
||||
<c>null</c> if no compression algorithm is being used.</returns>
|
||||
</member>
|
||||
<member name="T:MySqlX.XDevAPI.BaseSession">
|
||||
<summary>
|
||||
Represents a base class for a Session.
|
||||
@@ -14268,6 +14747,22 @@
|
||||
Contains connection options specific to the X protocol.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MySqlX.XDevAPI.MySqlXConnectionStringBuilder.#ctor">
|
||||
<summary>
|
||||
Main constructor.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MySqlX.XDevAPI.MySqlXConnectionStringBuilder.#ctor(System.String,System.Boolean)">
|
||||
<summary>
|
||||
Constructor accepting a connection string.
|
||||
</summary>
|
||||
<param name="connectionString">The connection string.</param>
|
||||
</member>
|
||||
<member name="F:MySqlX.XDevAPI.MySqlXConnectionStringBuilder.Options">
|
||||
<summary>
|
||||
Readonly field containing a collection of classic protocol and protocol shared connection options.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySqlX.XDevAPI.MySqlXConnectionStringBuilder.ConnectTimeout">
|
||||
<summary>
|
||||
Gets or sets the connection timeout.
|
||||
@@ -14283,6 +14778,17 @@
|
||||
Path to a local file containing certificate revocation lists.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySqlX.XDevAPI.MySqlXConnectionStringBuilder.Compression">
|
||||
<summary>
|
||||
Gets or sets the compression type between client and server.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySqlX.XDevAPI.MySqlXConnectionStringBuilder.Item(System.String)">
|
||||
<summary>
|
||||
Gets or sets a connection option.
|
||||
</summary>
|
||||
<param name="keyword">The keyword that identifies the connection option to modify.</param>
|
||||
</member>
|
||||
<member name="T:MySqlX.XDevAPI.Relational.Column">
|
||||
<summary>
|
||||
Represents a table column.
|
||||
@@ -14719,7 +15225,24 @@
|
||||
Creates a collection.
|
||||
</summary>
|
||||
<param name="collectionName">The name of the collection to create.</param>
|
||||
<param name="ReuseExistingObject">If false, it will throw an exception if collection exists.</param>
|
||||
<param name="ReuseExisting">If false, throws an exception if the collection exists.</param>
|
||||
<returns>Collection referente.</returns>
|
||||
</member>
|
||||
<member name="M:MySqlX.XDevAPI.Schema.CreateCollection(System.String,MySql.Data.X.XDevAPI.Common.CreateCollectionOptions)">
|
||||
<summary>
|
||||
Creates a collection including a schema validation.
|
||||
</summary>
|
||||
<param name="collectionName">The name of the collection to create.</param>
|
||||
<param name="options">This object hold the parameters required to create the collection.</param>
|
||||
<see cref="T:MySql.Data.X.XDevAPI.Common.CreateCollectionOptions"/>
|
||||
<returns>Collection referente.</returns>
|
||||
</member>
|
||||
<member name="M:MySqlX.XDevAPI.Schema.ModifyCollection(System.String,System.Nullable{MySql.Data.X.XDevAPI.Common.ModifyCollectionOptions})">
|
||||
<summary>
|
||||
Modify a collection adding or removing schema validation parameters.
|
||||
</summary>
|
||||
<param name="collectionName">The name of the collection to create.</param>
|
||||
<param name="options">This object encapsulate the Validation parameters level and schema. </param>
|
||||
<returns>Collection referente.</returns>
|
||||
</member>
|
||||
<member name="M:MySqlX.XDevAPI.Schema.DropCollection(System.String)">
|
||||
@@ -14767,13 +15290,13 @@
|
||||
</member>
|
||||
<member name="T:Mysqlx.ClientMessages">
|
||||
<summary>
|
||||
IDs of messages that can be sent from client to the server
|
||||
IDs of messages that can be sent from client to the server
|
||||
|
||||
.. note::
|
||||
this message is never sent on the wire. It is only used to let ``protoc``
|
||||
.. note::
|
||||
this message is never sent on the wire. It is only used to let ``protoc``
|
||||
|
||||
* generate constants
|
||||
* check for uniqueness
|
||||
* generate constants
|
||||
* check for uniqueness
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Mysqlx.ClientMessages.Types">
|
||||
@@ -14781,13 +15304,13 @@
|
||||
</member>
|
||||
<member name="T:Mysqlx.ServerMessages">
|
||||
<summary>
|
||||
IDs of messages that can be sent from server to client
|
||||
IDs of messages that can be sent from server to client
|
||||
|
||||
.. note::
|
||||
this message is never sent on the wire. It is only used to let ``protoc``
|
||||
.. note::
|
||||
this message is never sent on the wire. It is only used to let ``protoc``
|
||||
|
||||
* generate constants
|
||||
* check for uniqueness
|
||||
* generate constants
|
||||
* check for uniqueness
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Mysqlx.ServerMessages.Types">
|
||||
@@ -14795,12 +15318,12 @@
|
||||
</member>
|
||||
<member name="F:Mysqlx.ServerMessages.Types.Type.Notice">
|
||||
<summary>
|
||||
NOTICE has to stay at 11 forever
|
||||
NOTICE has to stay at 11 forever
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Mysqlx.Ok">
|
||||
<summary>
|
||||
generic Ok message
|
||||
generic Ok message
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Mysqlx.Ok.MsgFieldNumber">
|
||||
@@ -14808,19 +15331,19 @@
|
||||
</member>
|
||||
<member name="T:Mysqlx.Error">
|
||||
<summary>
|
||||
generic Error message
|
||||
generic Error message
|
||||
|
||||
A ``severity`` of ``ERROR`` indicates the current message sequence is
|
||||
aborted for the given error and the session is ready for more.
|
||||
A ``severity`` of ``ERROR`` indicates the current message sequence is
|
||||
aborted for the given error and the session is ready for more.
|
||||
|
||||
In case of a ``FATAL`` error message the client should not expect
|
||||
the server to continue handling any further messages and should
|
||||
close the connection.
|
||||
In case of a ``FATAL`` error message the client should not expect
|
||||
the server to continue handling any further messages and should
|
||||
close the connection.
|
||||
|
||||
:param severity: severity of the error message
|
||||
:param code: error-code
|
||||
:param sql_state: SQL state
|
||||
:param msg: human readable error message
|
||||
:param severity: severity of the error message
|
||||
:param code: error-code
|
||||
:param sql_state: SQL state
|
||||
:param msg: human readable error message
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Mysqlx.Error.SeverityFieldNumber">
|
||||
@@ -14854,19 +15377,9 @@
|
||||
<member name="F:Mysqlx.Connection.Capability.NameFieldNumber">
|
||||
<summary>Field number for the "name" field.</summary>
|
||||
</member>
|
||||
<member name="P:Mysqlx.Connection.Capability.Name">
|
||||
<summary>
|
||||
required
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Mysqlx.Connection.Capability.ValueFieldNumber">
|
||||
<summary>Field number for the "value" field.</summary>
|
||||
</member>
|
||||
<member name="P:Mysqlx.Connection.Capability.Value">
|
||||
<summary>
|
||||
required
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Mysqlx.Connection.Capabilities">
|
||||
<summary>
|
||||
Capabilities
|
||||
@@ -14896,11 +15409,6 @@
|
||||
<member name="F:Mysqlx.Connection.CapabilitiesSet.CapabilitiesFieldNumber">
|
||||
<summary>Field number for the "capabilities" field.</summary>
|
||||
</member>
|
||||
<member name="P:Mysqlx.Connection.CapabilitiesSet.Capabilities">
|
||||
<summary>
|
||||
required
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Mysqlx.Connection.Close">
|
||||
<summary>
|
||||
announce to the server that the client wants to close the connection
|
||||
@@ -14910,6 +15418,18 @@
|
||||
:Returns: :protobuf:msg:`Mysqlx::Ok`
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Mysqlx.Connection.Compression.UncompressedSizeFieldNumber">
|
||||
<summary>Field number for the "uncompressed_size" field.</summary>
|
||||
</member>
|
||||
<member name="F:Mysqlx.Connection.Compression.ServerMessagesFieldNumber">
|
||||
<summary>Field number for the "server_messages" field.</summary>
|
||||
</member>
|
||||
<member name="F:Mysqlx.Connection.Compression.ClientMessagesFieldNumber">
|
||||
<summary>Field number for the "client_messages" field.</summary>
|
||||
</member>
|
||||
<member name="F:Mysqlx.Connection.Compression.PayloadFieldNumber">
|
||||
<summary>Field number for the "payload" field.</summary>
|
||||
</member>
|
||||
<member name="T:Mysqlx.Crud.MysqlxCrudReflection">
|
||||
<summary>Holder for reflection information generated from mysqlx_crud.proto</summary>
|
||||
</member>
|
||||
BIN
Binary file not shown.
Binary file not shown.
Binary file not shown.
+558
-38
@@ -3509,6 +3509,26 @@
|
||||
Summary description for Field.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:MySql.Data.MySqlClient.CustomInstaller">
|
||||
<summary>
|
||||
We are adding a custom installer class to our assembly so our installer
|
||||
can make proper changes to the machine.config file.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MySql.Data.MySqlClient.CustomInstaller.Install(System.Collections.IDictionary)">
|
||||
<summary>
|
||||
We override Install so we can add our assembly to the proper
|
||||
machine.config files.
|
||||
</summary>
|
||||
<param name="stateSaver"></param>
|
||||
</member>
|
||||
<member name="M:MySql.Data.MySqlClient.CustomInstaller.Uninstall(System.Collections.IDictionary)">
|
||||
<summary>
|
||||
We override Uninstall so we can remove out assembly from the
|
||||
machine.config files.
|
||||
</summary>
|
||||
<param name="savedState"></param>
|
||||
</member>
|
||||
<member name="T:MySql.Data.MySqlClient.MySqlCommandBuilder">
|
||||
<summary>
|
||||
Automatically generates single-table commands used to reconcile changes made to a DataSet with the associated MySQL database. This class cannot be inherited.
|
||||
@@ -6083,6 +6103,21 @@
|
||||
Abstract class that provides common functionality for connection options that apply for all protocols.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.MySqlClient.MySqlBaseConnectionStringBuilder.Options">
|
||||
<summary>
|
||||
Readonly field containing a collection of protocol shared connection options.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.MySqlClient.MySqlBaseConnectionStringBuilder.HasProcAccess">
|
||||
<summary>
|
||||
Gets or sets a flag indicating if the object has access to procedures.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.MySqlClient.MySqlBaseConnectionStringBuilder.values">
|
||||
<summary>
|
||||
Gets or sets a dictionary representing key-value pairs for each connection option.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.MySqlClient.MySqlBaseConnectionStringBuilder.Server">
|
||||
<summary>
|
||||
Gets or sets the name of the server.
|
||||
@@ -6271,6 +6306,22 @@
|
||||
Contains connection options specific to the Classic protocol.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MySql.Data.MySqlClient.MySqlConnectionStringBuilder.#ctor">
|
||||
<summary>
|
||||
Main constructor.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MySql.Data.MySqlClient.MySqlConnectionStringBuilder.#ctor(System.String)">
|
||||
<summary>
|
||||
Constructor accepting a connection string.
|
||||
</summary>
|
||||
<param name="connectionString">The connection string.</param>
|
||||
</member>
|
||||
<member name="F:MySql.Data.MySqlClient.MySqlConnectionStringBuilder.Options">
|
||||
<summary>
|
||||
Readonly field containing a collection of classic protocol and protocol shared connection options.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.MySqlClient.MySqlConnectionStringBuilder.PipeName">
|
||||
<summary>
|
||||
Gets or sets the name of the named pipe that should be used
|
||||
@@ -6525,6 +6576,12 @@
|
||||
Gets or sets the pattern to match for the columns that should not be treated as UTF8.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.MySqlClient.MySqlConnectionStringBuilder.Item(System.String)">
|
||||
<summary>
|
||||
Gets or sets a connection option.
|
||||
</summary>
|
||||
<param name="keyword">The keyword that identifies the connection option to modify.</param>
|
||||
</member>
|
||||
<member name="T:MySql.Data.MySqlClient.ClientFlags">
|
||||
<summary>
|
||||
Summary description for ClientParam.
|
||||
@@ -6938,6 +6995,27 @@
|
||||
removing locked rows from the result set.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:MySql.Data.MySqlClient.CompressionType">
|
||||
<summary>
|
||||
Defines the type of compression used when data is exchanged between client and server.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.MySqlClient.CompressionType.Preferred">
|
||||
<summary>
|
||||
Uses compression if client and server are able to reach a concensus. Otherwise, compression
|
||||
is not used.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.MySqlClient.CompressionType.Required">
|
||||
<summary>
|
||||
Enforces the use of compression. If no concensus is reached, an error is raised.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.MySqlClient.CompressionType.Disabled">
|
||||
<summary>
|
||||
Disables compression.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:MySql.Data.MySqlClient.MySqlError">
|
||||
<summary>
|
||||
Collection of error codes that can be returned by the server
|
||||
@@ -12291,6 +12369,42 @@
|
||||
Looks up a localized string similar to Scheme '{0}' is not valid..
|
||||
</summary>
|
||||
</member>
|
||||
<!-- Badly formed XML comment ignored for member "P:MySql.Data.ResourcesX.CompressionAlgorithmNegotiationFailed" -->
|
||||
<member name="P:MySql.Data.ResourcesX.CompressionAlgorithmNotSupported">
|
||||
<summary>
|
||||
Looks up a localized string similar to Compression using {0} is not supported..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.CompressionFailedToLoadLibzstdAssembly">
|
||||
<summary>
|
||||
Looks up a localized string similar to Failed to load libzstd.dll. Removing zstd_stream from the client supported compression algorithms..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.CompressionForSpecificAlgorithmNotSupportedInNetFramework">
|
||||
<summary>
|
||||
Looks up a localized string similar to Compression using {0} is not supported in .NET Framework..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.CompressionInvalidValue">
|
||||
<summary>
|
||||
Looks up a localized string similar to The connection property 'compression' acceptable values are: 'preferred', 'required' or 'disabled'. The value '{0}' is not acceptable..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.CompressionNotEnabled">
|
||||
<summary>
|
||||
Looks up a localized string similar to Compression is not enabled..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.CompressionNotSupportedByServer">
|
||||
<summary>
|
||||
Looks up a localized string similar to Compression requested but the server does not support it..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.CompressionPendingMessagesToProcess">
|
||||
<summary>
|
||||
Looks up a localized string similar to There are still decompressed messages pending to be processed..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.DuplicateUserDefinedAttribute">
|
||||
<summary>
|
||||
Looks up a localized string similar to Duplicate key '{0}' used in "connection-attributes"..
|
||||
@@ -12301,6 +12415,11 @@
|
||||
Looks up a localized string similar to Key name in connection attribute cannot be an empty string..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.EmptyOptions">
|
||||
<summary>
|
||||
Looks up a localized string similar to At least one option must be specified..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.FeatureNotSupported">
|
||||
<summary>
|
||||
Looks up a localized string similar to This feature is currently not supported..
|
||||
@@ -12411,6 +12530,11 @@
|
||||
Looks up a localized string similar to Field '{0}' is mandatory..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.MissingSchemaOption">
|
||||
<summary>
|
||||
Looks up a localized string similar to Missed required 'schema' option..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.MoreThanOneDocumentId">
|
||||
<summary>
|
||||
Looks up a localized string similar to More than one document id was generated. Please use the DocumentIds property instead..
|
||||
@@ -12476,6 +12600,11 @@
|
||||
Looks up a localized string similar to ProgramData path is not defined..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.SchemaCreateCollectionMsg">
|
||||
<summary>
|
||||
Looks up a localized string similar to The server doesn't support the requested operation. Please update the MySQL Server and/or Client library.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.ThrowingAwayResults">
|
||||
<summary>
|
||||
Looks up a localized string similar to The process of closing the resultset and resulted in results being lost..
|
||||
@@ -12742,6 +12871,262 @@
|
||||
</summary>
|
||||
<returns>A string representation of the WKT.</returns>
|
||||
</member>
|
||||
<member name="T:MySql.Data.X.common.UnmanagedLibraryLoader">
|
||||
<summary>
|
||||
Provides functionality for loading unmanaged libraries.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.common.UnmanagedLibraryLoader.LoadUnmanagedLibraryFromEmbeddedResources(System.String,System.String)">
|
||||
<summary>
|
||||
Loads the specified unmanaged library from the embedded resources.
|
||||
</summary>
|
||||
<param name="applicationName">The application name.</param>
|
||||
<param name="libraryName">The library name.</param>
|
||||
</member>
|
||||
<member name="T:MySql.Data.X.Communication.XCompressionController">
|
||||
<summary>
|
||||
Provides support for configuring X Protocol compressed messages.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController.ALGORITHMS_SUBKEY">
|
||||
<summary>
|
||||
The capabilities sub-key used to specify the compression algorithm.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController.COMPRESSION_KEY">
|
||||
<summary>
|
||||
The capabilities key used to specify the compression capability.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController.COMPRESSION_THRESHOLD">
|
||||
<summary>
|
||||
Messages with a value lower than this threshold will not be compressed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController.DEFAULT_SERVER_COMBINE_MIXED_MESSAGES_VALUE">
|
||||
<summary>
|
||||
Default value for enabling or disabling combined compressed messages.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController.DEFAULT_SERVER_MAX_COMBINE_MESSAGES_VALUE">
|
||||
<summary>
|
||||
Default value for the maximum number of combined compressed messages contained in a compression message.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController.DEFLATE_STREAM_COMPRESSION_ALGORITHM">
|
||||
<summary>
|
||||
deflate_stream compression algorithm.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController.LZ4_MESSAGE_COMPRESSION_ALGORITHM">
|
||||
<summary>
|
||||
lz4_message compression algorithm.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController.SERVER_COMBINE_MIXED_MESSAGES_SUBKEY">
|
||||
<summary>
|
||||
The capabilities sub-key used to specify if combining compressed messages is permitted.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController.SERVER_MAX_COMBINE_MESSAGES_SUBKEY">
|
||||
<summary>
|
||||
The capabilities sub-key used to specify the maximum number of compressed messages contained in a compression message.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController.ZSTD_STREAM_COMPRESSION_ALGORITHM">
|
||||
<summary>
|
||||
zstd_stream compression algorithm.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController._buffer">
|
||||
<summary>
|
||||
Buffer used to store the data received from the server.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController._deflateCompressStream">
|
||||
<summary>
|
||||
Deflate stream used for compressing data.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController._deflateDecompressStream">
|
||||
<summary>
|
||||
Deflate stream used for decompressing data.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController._initializeForCompression">
|
||||
<summary>
|
||||
Flag indicating if the initialization is for compression or decompression.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController._lastCommunicationPacket">
|
||||
<summary>
|
||||
Stores the communication packet generated the last time ReadNextBufferedMessage method was called.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController._libzstdLoaded">
|
||||
<summary>
|
||||
Indicates if the libzstd.dll has been loaded.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController._multipleMessagesStream">
|
||||
<summary>
|
||||
Stream used to store multiple X Protocol messages.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController._zstdDecompressStream">
|
||||
<summary>
|
||||
ZStandard stream used for decompressing data.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.#cctor">
|
||||
<summary>
|
||||
Static constructor used to initialize the client supported compression algorithms.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.#ctor(System.String,System.Boolean)">
|
||||
<summary>
|
||||
Main constructor used to set the compression algorithm and initialize the list of messages to
|
||||
be compressed by the client.
|
||||
</summary>
|
||||
<param name="compressionAlgorithm">The compression algorithm to use.</param>
|
||||
<param name="initializeForCompression">Flag indicating if the initialization is for compression or decompression.</param>
|
||||
</member>
|
||||
<member name="P:MySql.Data.X.Communication.XCompressionController.ClientSupportedCompressedMessages">
|
||||
<summary>
|
||||
Gets or sets the list of messages that should be compressed by the client when compression is enabled.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.X.Communication.XCompressionController.ClientSupportedCompressionAlgorithms">
|
||||
<summary>
|
||||
Gets or sets an array containing the compression algorithms supported by the client.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.X.Communication.XCompressionController.CompressionAlgorithm">
|
||||
<summary>
|
||||
Gets or sets the compression algorithm.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.X.Communication.XCompressionController.IsCompressionEnabled">
|
||||
<summary>
|
||||
Flag indicating if compression is enabled.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.X.Communication.XCompressionController.LastMessageContainsMultipleMessages">
|
||||
<summary>
|
||||
Flag indicating if the last decompressed message contains multiple messages.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.Compress(System.Byte[])">
|
||||
<summary>
|
||||
General method used to compress data using the compression algorithm defined in the constructor.
|
||||
</summary>
|
||||
<param name="input">The data to compress.</param>
|
||||
<returns>A compressed byte array.</returns>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.CompressUsingDeflateStream(System.Byte[])">
|
||||
<summary>
|
||||
Compresses data using the deflate_stream algorithm.
|
||||
</summary>
|
||||
<param name="input">The data to compress.</param>
|
||||
<returns>A compressed byte array.</returns>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.CompressUsingLz4Message(System.Byte[])">
|
||||
<summary>
|
||||
Compresses data using the lz4_message algorithm.
|
||||
</summary>
|
||||
<param name="input">The data to compress.</param>
|
||||
<returns>A compressed byte array.</returns>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.CompressUsingZstdStream(System.Byte[])">
|
||||
<summary>
|
||||
Compresses data using the zstd_stream algorithm.
|
||||
</summary>
|
||||
<param name="input">The data to compress.</param>
|
||||
<returns>A compressed byte array.</returns>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.Decompress(System.Byte[],System.Int32)">
|
||||
<summary>
|
||||
General method used to decompress data using the compression algorithm defined in the constructor.
|
||||
</summary>
|
||||
<param name="input">The data to decompress.</param>
|
||||
<param name="length">The expected length of the decompressed data.</param>
|
||||
<returns>A decompressed byte array.</returns>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.DecompressUsingDeflateStream(System.Byte[],System.Int32)">
|
||||
<summary>
|
||||
Decompresses data using the deflate_stream compression algorithm.
|
||||
</summary>
|
||||
<param name="input">The data to decompress.</param>
|
||||
<param name="length">The expected length of the decompressed data.</param>
|
||||
<returns>A decompressed byte array.</returns>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.DecompressUsingLz4Message(System.Byte[],System.Int32)">
|
||||
<summary>
|
||||
Decompresses data using the lz4_message compression algorithm.
|
||||
</summary>
|
||||
<param name="input">The data to decompress.</param>
|
||||
<param name="length">The expected length of the decompressed data.</param>
|
||||
<returns>A decompressed byte array.</returns>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.DecompressUsingZstdStream(System.Byte[],System.Int32)">
|
||||
<summary>
|
||||
Decompresses data using the zstd_stream compression algorithm.
|
||||
</summary>
|
||||
<param name="input">The data to decompress.</param>
|
||||
<param name="length">The expected length of the decompressed data.</param>
|
||||
<returns>A decompressed byte array.</returns>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.Close">
|
||||
<summary>
|
||||
Closes and disposes of any open streams.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.ReadNextBufferedMessage">
|
||||
<summary>
|
||||
Gets the byte array representing the next X Protocol frame that is stored in cache.
|
||||
</summary>
|
||||
<returns>A byte array representing an X Protocol frame.</returns>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.ReadNextBufferedMessageAsCommunicationPacket">
|
||||
<summary>
|
||||
Gets a <see cref="T:MySqlX.Communication.CommunicationPacket"/> representing the next X Protocol frame that is stored in cache.
|
||||
</summary>
|
||||
<returns>A <see cref="T:MySqlX.Communication.CommunicationPacket"/> with the next X Protocol frame.</returns>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.LoadLibzstdLibrary">
|
||||
<summary>
|
||||
Loads the libzstd.dll assembly.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:MySql.Data.X.XDevAPI.Common.CreateCollectionOptions">
|
||||
<summary>
|
||||
This object store the required parameters to create a Collection with schema validation.
|
||||
</summary>
|
||||
<param name="ReuseExisting">If false, throws an exception if the collection exists.</param>
|
||||
<param name="Validation">Object which hold the Level and Schema parameters</param>
|
||||
<see cref="P:MySql.Data.X.XDevAPI.Common.CreateCollectionOptions.Validation"/>
|
||||
</member>
|
||||
<member name="P:MySql.Data.X.XDevAPI.Common.ModifyCollectionOptions.Validation">
|
||||
<summary>
|
||||
This object store the required parameters to Modify a Collection with schema validation.
|
||||
</summary>
|
||||
<param name="Validation">Object which hold the Level and Schema parameters</param>
|
||||
<see cref="P:MySql.Data.X.XDevAPI.Common.ModifyCollectionOptions.Validation"/>
|
||||
</member>
|
||||
<member name="P:MySql.Data.X.XDevAPI.Common.Validation.Level">
|
||||
<summary>
|
||||
This object store the required parameters to create a Collection with schema validation.
|
||||
</summary>
|
||||
<param name="Level">It can be STRICT to enable schema validation or OFF to disable <see cref="T:MySql.Data.X.XDevAPI.Common.ValidationLevel"/></param>
|
||||
<param name="Schema">The JSON which define the rules to be validated in the collection</param>
|
||||
</member>
|
||||
<member name="T:MySql.Data.X.XDevAPI.Common.ValidationLevel">
|
||||
<summary>
|
||||
The possible values for parameter Level in Validation object.
|
||||
</summary>
|
||||
<param name="STRICT">Enforce schema validation.</param>
|
||||
<param name="OFF">Schema validation disabled.</param>
|
||||
</member>
|
||||
<member name="T:MySqlX.Security.ExternalAuthenticationPlugin">
|
||||
<summary>
|
||||
Implementation of EXTERNAL authentication type.
|
||||
@@ -12773,6 +13158,44 @@
|
||||
<param name="guid2">The second <see cref="T:System.Guid"/> to compare.</param>
|
||||
<returns>An integer that indicates the lexical relationship between the two comparands, similar to <see cref="M:System.String.Compare(System.String,System.String)"/></returns>
|
||||
</member>
|
||||
<member name="M:MySqlX.Communication.XPacketReaderWriter.#ctor(System.IO.Stream)">
|
||||
<summary>
|
||||
Constructor that sets the stream used to read or write data.
|
||||
</summary>
|
||||
<param name="stream">The stream used to read or write data.</param>
|
||||
</member>
|
||||
<member name="M:MySqlX.Communication.XPacketReaderWriter.#ctor(System.IO.Stream,MySql.Data.X.Communication.XCompressionController)">
|
||||
<summary>
|
||||
Constructor that sets the stream used to read or write data and the compression controller.
|
||||
</summary>
|
||||
<param name="stream">The stream used to read or write data.</param>
|
||||
<param name="compressionController">The compression controller.</param>
|
||||
</member>
|
||||
<member name="P:MySqlX.Communication.XPacketReaderWriter.CompressionController">
|
||||
<summary>
|
||||
Gets or sets the compression controller uses to manage compression operations.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MySqlX.Communication.XPacketReaderWriter.Write(System.Int32,Google.Protobuf.IMessage)">
|
||||
<summary>
|
||||
Writes X Protocol frames to the X Plugin.
|
||||
</summary>
|
||||
<param name="id">The integer representation of the client message identifier used for the message.</param>
|
||||
<param name="message">The message to include in the X Protocol frame.</param>
|
||||
</member>
|
||||
<member name="M:MySqlX.Communication.XPacketReaderWriter.Write(MySqlX.Communication.ClientMessageId,Google.Protobuf.IMessage)">
|
||||
<summary>
|
||||
Writes X Protocol frames to the X Plugin.
|
||||
</summary>
|
||||
<param name="id">The client message identifier used for the message.</param>
|
||||
<param name="message">The message to include in the X Protocol frame.</param>
|
||||
</member>
|
||||
<member name="M:MySqlX.Communication.XPacketReaderWriter.Read">
|
||||
<summary>
|
||||
Reads X Protocol frames incoming from the X Plugin.
|
||||
</summary>
|
||||
<returns>A <see cref="T:MySqlX.Communication.CommunicationPacket"/> instance representing the X Protocol frame that was read.</returns>
|
||||
</member>
|
||||
<member name="T:MySqlX.Protocol.ProtocolBase">
|
||||
<summary>
|
||||
Abstract class for the protocol base operations in client/server communication.
|
||||
@@ -12977,6 +13400,15 @@
|
||||
<member name="M:MySqlX.Protocol.X.ExprUnparser.ExprToString(Mysqlx.Expr.Expr)">
|
||||
Serialize an expression to a string.
|
||||
</member>
|
||||
<member name="M:MySqlX.Protocol.XProtocol.SendExecuteStatementOptions(System.String,System.String,System.Collections.Generic.KeyValuePair{System.String,System.Object}[])">
|
||||
<summary>
|
||||
Build the message to be sent to MySQL Server to execute statement "Create" or "Modify" collection with schema options
|
||||
</summary>
|
||||
<param name="ns">The namespace</param>
|
||||
<param name="stmt">The name of the command to be executed on MySql Server</param>
|
||||
<param name="args">Array of KeyValuePairs with the parameters required to build the message</param>
|
||||
<returns>void.</returns>
|
||||
</member>
|
||||
<member name="M:MySqlX.Protocol.XProtocol.SendDelete(System.String,System.String,System.Boolean,MySqlX.XDevAPI.Common.FilterParams)">
|
||||
<summary>
|
||||
Sends the delete documents message
|
||||
@@ -13067,11 +13499,58 @@
|
||||
Implementation class of InternalSession to manage connections using the Xprotocol type object.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySqlX.Sessions.XInternalSession._readerCompressionController">
|
||||
<summary>
|
||||
Defines the compression controller that will be passed on the <see cref="T:MySqlX.Communication.XPacketReaderWriter"/> instance when
|
||||
compression is enabled.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySqlX.Sessions.XInternalSession._writerCompressionController">
|
||||
<summary>
|
||||
Defines the compression controller that will be passed on the <see cref="T:MySqlX.Communication.XPacketReaderWriter"/> instance when
|
||||
compression is enabled.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySqlX.Sessions.XInternalSession._sshHandler">
|
||||
<summary>
|
||||
The used client to handle SSH connections.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MySqlX.Sessions.XInternalSession.NegotiateCompression(System.String[])">
|
||||
<summary>
|
||||
Negotiates compression capabilities with the server.
|
||||
</summary>
|
||||
<param name="serverSupportedAlgorithms">An array containing the compression algorithms supported by the server.</param>
|
||||
</member>
|
||||
<member name="M:MySqlX.Sessions.XInternalSession.CreateCollection(System.String,System.String,MySql.Data.X.XDevAPI.Common.CreateCollectionOptions)">
|
||||
<summary>
|
||||
Prepare the dictionary of arguments required to create a MySQL message.
|
||||
</summary>
|
||||
<param name="schemaName">The name of the MySQL schema.</param>
|
||||
<param name="collectionName">The name of the collection.</param>
|
||||
<param name="options">This object hold the parameters required to create the collection.</param>
|
||||
<see cref="T:MySql.Data.X.XDevAPI.Common.CreateCollectionOptions"/>
|
||||
<returns>Collection referente.</returns>
|
||||
</member>
|
||||
<member name="M:MySqlX.Sessions.XInternalSession.ModifyCollection(System.String,System.String,System.Nullable{MySql.Data.X.XDevAPI.Common.ModifyCollectionOptions})">
|
||||
<summary>
|
||||
Prepare the dictionary of arguments required to Modify a MySQL message.
|
||||
</summary>
|
||||
<param name="schemaName">The name of the MySQL schema.</param>
|
||||
<param name="collectionName">The name of the collection.</param>
|
||||
<param name="options">This object hold the parameters required to Modify the collection.</param>
|
||||
<see cref="T:MySql.Data.X.XDevAPI.Common.ModifyCollectionOptions"/>
|
||||
<returns>Collection referente.</returns>
|
||||
</member>
|
||||
<member name="M:MySqlX.Sessions.XInternalSession.GetCompressionAlgorithm(System.Boolean)">
|
||||
<summary>
|
||||
Gets the compression algorithm being used to compress or decompress data.
|
||||
</summary>
|
||||
<param name="fromReaderController">Flag to indicate if the compression algorithm should be
|
||||
retrieved from the reader or writer controller.</param>
|
||||
<returns>The name of the compression algorithm being used if any.
|
||||
<c>null</c> if no compression algorithm is being used.</returns>
|
||||
</member>
|
||||
<member name="T:MySqlX.XDevAPI.BaseSession">
|
||||
<summary>
|
||||
Represents a base class for a Session.
|
||||
@@ -14268,6 +14747,22 @@
|
||||
Contains connection options specific to the X protocol.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MySqlX.XDevAPI.MySqlXConnectionStringBuilder.#ctor">
|
||||
<summary>
|
||||
Main constructor.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MySqlX.XDevAPI.MySqlXConnectionStringBuilder.#ctor(System.String,System.Boolean)">
|
||||
<summary>
|
||||
Constructor accepting a connection string.
|
||||
</summary>
|
||||
<param name="connectionString">The connection string.</param>
|
||||
</member>
|
||||
<member name="F:MySqlX.XDevAPI.MySqlXConnectionStringBuilder.Options">
|
||||
<summary>
|
||||
Readonly field containing a collection of classic protocol and protocol shared connection options.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySqlX.XDevAPI.MySqlXConnectionStringBuilder.ConnectTimeout">
|
||||
<summary>
|
||||
Gets or sets the connection timeout.
|
||||
@@ -14283,6 +14778,17 @@
|
||||
Path to a local file containing certificate revocation lists.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySqlX.XDevAPI.MySqlXConnectionStringBuilder.Compression">
|
||||
<summary>
|
||||
Gets or sets the compression type between client and server.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySqlX.XDevAPI.MySqlXConnectionStringBuilder.Item(System.String)">
|
||||
<summary>
|
||||
Gets or sets a connection option.
|
||||
</summary>
|
||||
<param name="keyword">The keyword that identifies the connection option to modify.</param>
|
||||
</member>
|
||||
<member name="T:MySqlX.XDevAPI.Relational.Column">
|
||||
<summary>
|
||||
Represents a table column.
|
||||
@@ -14719,7 +15225,24 @@
|
||||
Creates a collection.
|
||||
</summary>
|
||||
<param name="collectionName">The name of the collection to create.</param>
|
||||
<param name="ReuseExistingObject">If false, it will throw an exception if collection exists.</param>
|
||||
<param name="ReuseExisting">If false, throws an exception if the collection exists.</param>
|
||||
<returns>Collection referente.</returns>
|
||||
</member>
|
||||
<member name="M:MySqlX.XDevAPI.Schema.CreateCollection(System.String,MySql.Data.X.XDevAPI.Common.CreateCollectionOptions)">
|
||||
<summary>
|
||||
Creates a collection including a schema validation.
|
||||
</summary>
|
||||
<param name="collectionName">The name of the collection to create.</param>
|
||||
<param name="options">This object hold the parameters required to create the collection.</param>
|
||||
<see cref="T:MySql.Data.X.XDevAPI.Common.CreateCollectionOptions"/>
|
||||
<returns>Collection referente.</returns>
|
||||
</member>
|
||||
<member name="M:MySqlX.XDevAPI.Schema.ModifyCollection(System.String,System.Nullable{MySql.Data.X.XDevAPI.Common.ModifyCollectionOptions})">
|
||||
<summary>
|
||||
Modify a collection adding or removing schema validation parameters.
|
||||
</summary>
|
||||
<param name="collectionName">The name of the collection to create.</param>
|
||||
<param name="options">This object encapsulate the Validation parameters level and schema. </param>
|
||||
<returns>Collection referente.</returns>
|
||||
</member>
|
||||
<member name="M:MySqlX.XDevAPI.Schema.DropCollection(System.String)">
|
||||
@@ -14767,13 +15290,13 @@
|
||||
</member>
|
||||
<member name="T:Mysqlx.ClientMessages">
|
||||
<summary>
|
||||
IDs of messages that can be sent from client to the server
|
||||
IDs of messages that can be sent from client to the server
|
||||
|
||||
.. note::
|
||||
this message is never sent on the wire. It is only used to let ``protoc``
|
||||
.. note::
|
||||
this message is never sent on the wire. It is only used to let ``protoc``
|
||||
|
||||
* generate constants
|
||||
* check for uniqueness
|
||||
* generate constants
|
||||
* check for uniqueness
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Mysqlx.ClientMessages.Types">
|
||||
@@ -14781,13 +15304,13 @@
|
||||
</member>
|
||||
<member name="T:Mysqlx.ServerMessages">
|
||||
<summary>
|
||||
IDs of messages that can be sent from server to client
|
||||
IDs of messages that can be sent from server to client
|
||||
|
||||
.. note::
|
||||
this message is never sent on the wire. It is only used to let ``protoc``
|
||||
.. note::
|
||||
this message is never sent on the wire. It is only used to let ``protoc``
|
||||
|
||||
* generate constants
|
||||
* check for uniqueness
|
||||
* generate constants
|
||||
* check for uniqueness
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Mysqlx.ServerMessages.Types">
|
||||
@@ -14795,12 +15318,12 @@
|
||||
</member>
|
||||
<member name="F:Mysqlx.ServerMessages.Types.Type.Notice">
|
||||
<summary>
|
||||
NOTICE has to stay at 11 forever
|
||||
NOTICE has to stay at 11 forever
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Mysqlx.Ok">
|
||||
<summary>
|
||||
generic Ok message
|
||||
generic Ok message
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Mysqlx.Ok.MsgFieldNumber">
|
||||
@@ -14808,19 +15331,19 @@
|
||||
</member>
|
||||
<member name="T:Mysqlx.Error">
|
||||
<summary>
|
||||
generic Error message
|
||||
generic Error message
|
||||
|
||||
A ``severity`` of ``ERROR`` indicates the current message sequence is
|
||||
aborted for the given error and the session is ready for more.
|
||||
A ``severity`` of ``ERROR`` indicates the current message sequence is
|
||||
aborted for the given error and the session is ready for more.
|
||||
|
||||
In case of a ``FATAL`` error message the client should not expect
|
||||
the server to continue handling any further messages and should
|
||||
close the connection.
|
||||
In case of a ``FATAL`` error message the client should not expect
|
||||
the server to continue handling any further messages and should
|
||||
close the connection.
|
||||
|
||||
:param severity: severity of the error message
|
||||
:param code: error-code
|
||||
:param sql_state: SQL state
|
||||
:param msg: human readable error message
|
||||
:param severity: severity of the error message
|
||||
:param code: error-code
|
||||
:param sql_state: SQL state
|
||||
:param msg: human readable error message
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Mysqlx.Error.SeverityFieldNumber">
|
||||
@@ -14854,19 +15377,9 @@
|
||||
<member name="F:Mysqlx.Connection.Capability.NameFieldNumber">
|
||||
<summary>Field number for the "name" field.</summary>
|
||||
</member>
|
||||
<member name="P:Mysqlx.Connection.Capability.Name">
|
||||
<summary>
|
||||
required
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Mysqlx.Connection.Capability.ValueFieldNumber">
|
||||
<summary>Field number for the "value" field.</summary>
|
||||
</member>
|
||||
<member name="P:Mysqlx.Connection.Capability.Value">
|
||||
<summary>
|
||||
required
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Mysqlx.Connection.Capabilities">
|
||||
<summary>
|
||||
Capabilities
|
||||
@@ -14896,11 +15409,6 @@
|
||||
<member name="F:Mysqlx.Connection.CapabilitiesSet.CapabilitiesFieldNumber">
|
||||
<summary>Field number for the "capabilities" field.</summary>
|
||||
</member>
|
||||
<member name="P:Mysqlx.Connection.CapabilitiesSet.Capabilities">
|
||||
<summary>
|
||||
required
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Mysqlx.Connection.Close">
|
||||
<summary>
|
||||
announce to the server that the client wants to close the connection
|
||||
@@ -14910,6 +15418,18 @@
|
||||
:Returns: :protobuf:msg:`Mysqlx::Ok`
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Mysqlx.Connection.Compression.UncompressedSizeFieldNumber">
|
||||
<summary>Field number for the "uncompressed_size" field.</summary>
|
||||
</member>
|
||||
<member name="F:Mysqlx.Connection.Compression.ServerMessagesFieldNumber">
|
||||
<summary>Field number for the "server_messages" field.</summary>
|
||||
</member>
|
||||
<member name="F:Mysqlx.Connection.Compression.ClientMessagesFieldNumber">
|
||||
<summary>Field number for the "client_messages" field.</summary>
|
||||
</member>
|
||||
<member name="F:Mysqlx.Connection.Compression.PayloadFieldNumber">
|
||||
<summary>Field number for the "payload" field.</summary>
|
||||
</member>
|
||||
<member name="T:Mysqlx.Crud.MysqlxCrudReflection">
|
||||
<summary>Holder for reflection information generated from mysqlx_crud.proto</summary>
|
||||
</member>
|
||||
BIN
Binary file not shown.
Binary file not shown.
Binary file not shown.
+538
-58
@@ -3509,26 +3509,6 @@
|
||||
Summary description for Field.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:MySql.Data.MySqlClient.CustomInstaller">
|
||||
<summary>
|
||||
We are adding a custom installer class to our assembly so our installer
|
||||
can make proper changes to the machine.config file.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MySql.Data.MySqlClient.CustomInstaller.Install(System.Collections.IDictionary)">
|
||||
<summary>
|
||||
We override Install so we can add our assembly to the proper
|
||||
machine.config files.
|
||||
</summary>
|
||||
<param name="stateSaver"></param>
|
||||
</member>
|
||||
<member name="M:MySql.Data.MySqlClient.CustomInstaller.Uninstall(System.Collections.IDictionary)">
|
||||
<summary>
|
||||
We override Uninstall so we can remove out assembly from the
|
||||
machine.config files.
|
||||
</summary>
|
||||
<param name="savedState"></param>
|
||||
</member>
|
||||
<member name="T:MySql.Data.MySqlClient.MySqlCommandBuilder">
|
||||
<summary>
|
||||
Automatically generates single-table commands used to reconcile changes made to a DataSet with the associated MySQL database. This class cannot be inherited.
|
||||
@@ -6103,6 +6083,21 @@
|
||||
Abstract class that provides common functionality for connection options that apply for all protocols.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.MySqlClient.MySqlBaseConnectionStringBuilder.Options">
|
||||
<summary>
|
||||
Readonly field containing a collection of protocol shared connection options.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.MySqlClient.MySqlBaseConnectionStringBuilder.HasProcAccess">
|
||||
<summary>
|
||||
Gets or sets a flag indicating if the object has access to procedures.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.MySqlClient.MySqlBaseConnectionStringBuilder.values">
|
||||
<summary>
|
||||
Gets or sets a dictionary representing key-value pairs for each connection option.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.MySqlClient.MySqlBaseConnectionStringBuilder.Server">
|
||||
<summary>
|
||||
Gets or sets the name of the server.
|
||||
@@ -6291,6 +6286,22 @@
|
||||
Contains connection options specific to the Classic protocol.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MySql.Data.MySqlClient.MySqlConnectionStringBuilder.#ctor">
|
||||
<summary>
|
||||
Main constructor.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MySql.Data.MySqlClient.MySqlConnectionStringBuilder.#ctor(System.String)">
|
||||
<summary>
|
||||
Constructor accepting a connection string.
|
||||
</summary>
|
||||
<param name="connectionString">The connection string.</param>
|
||||
</member>
|
||||
<member name="F:MySql.Data.MySqlClient.MySqlConnectionStringBuilder.Options">
|
||||
<summary>
|
||||
Readonly field containing a collection of classic protocol and protocol shared connection options.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.MySqlClient.MySqlConnectionStringBuilder.PipeName">
|
||||
<summary>
|
||||
Gets or sets the name of the named pipe that should be used
|
||||
@@ -6545,6 +6556,12 @@
|
||||
Gets or sets the pattern to match for the columns that should not be treated as UTF8.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.MySqlClient.MySqlConnectionStringBuilder.Item(System.String)">
|
||||
<summary>
|
||||
Gets or sets a connection option.
|
||||
</summary>
|
||||
<param name="keyword">The keyword that identifies the connection option to modify.</param>
|
||||
</member>
|
||||
<member name="T:MySql.Data.MySqlClient.ClientFlags">
|
||||
<summary>
|
||||
Summary description for ClientParam.
|
||||
@@ -6958,6 +6975,27 @@
|
||||
removing locked rows from the result set.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:MySql.Data.MySqlClient.CompressionType">
|
||||
<summary>
|
||||
Defines the type of compression used when data is exchanged between client and server.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.MySqlClient.CompressionType.Preferred">
|
||||
<summary>
|
||||
Uses compression if client and server are able to reach a concensus. Otherwise, compression
|
||||
is not used.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.MySqlClient.CompressionType.Required">
|
||||
<summary>
|
||||
Enforces the use of compression. If no concensus is reached, an error is raised.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.MySqlClient.CompressionType.Disabled">
|
||||
<summary>
|
||||
Disables compression.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:MySql.Data.MySqlClient.MySqlError">
|
||||
<summary>
|
||||
Collection of error codes that can be returned by the server
|
||||
@@ -12311,6 +12349,42 @@
|
||||
Looks up a localized string similar to Scheme '{0}' is not valid..
|
||||
</summary>
|
||||
</member>
|
||||
<!-- Badly formed XML comment ignored for member "P:MySql.Data.ResourcesX.CompressionAlgorithmNegotiationFailed" -->
|
||||
<member name="P:MySql.Data.ResourcesX.CompressionAlgorithmNotSupported">
|
||||
<summary>
|
||||
Looks up a localized string similar to Compression using {0} is not supported..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.CompressionFailedToLoadLibzstdAssembly">
|
||||
<summary>
|
||||
Looks up a localized string similar to Failed to load libzstd.dll. Removing zstd_stream from the client supported compression algorithms..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.CompressionForSpecificAlgorithmNotSupportedInNetFramework">
|
||||
<summary>
|
||||
Looks up a localized string similar to Compression using {0} is not supported in .NET Framework..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.CompressionInvalidValue">
|
||||
<summary>
|
||||
Looks up a localized string similar to The connection property 'compression' acceptable values are: 'preferred', 'required' or 'disabled'. The value '{0}' is not acceptable..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.CompressionNotEnabled">
|
||||
<summary>
|
||||
Looks up a localized string similar to Compression is not enabled..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.CompressionNotSupportedByServer">
|
||||
<summary>
|
||||
Looks up a localized string similar to Compression requested but the server does not support it..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.CompressionPendingMessagesToProcess">
|
||||
<summary>
|
||||
Looks up a localized string similar to There are still decompressed messages pending to be processed..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.DuplicateUserDefinedAttribute">
|
||||
<summary>
|
||||
Looks up a localized string similar to Duplicate key '{0}' used in "connection-attributes"..
|
||||
@@ -12321,6 +12395,11 @@
|
||||
Looks up a localized string similar to Key name in connection attribute cannot be an empty string..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.EmptyOptions">
|
||||
<summary>
|
||||
Looks up a localized string similar to At least one option must be specified..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.FeatureNotSupported">
|
||||
<summary>
|
||||
Looks up a localized string similar to This feature is currently not supported..
|
||||
@@ -12431,6 +12510,11 @@
|
||||
Looks up a localized string similar to Field '{0}' is mandatory..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.MissingSchemaOption">
|
||||
<summary>
|
||||
Looks up a localized string similar to Missed required 'schema' option..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.MoreThanOneDocumentId">
|
||||
<summary>
|
||||
Looks up a localized string similar to More than one document id was generated. Please use the DocumentIds property instead..
|
||||
@@ -12496,6 +12580,11 @@
|
||||
Looks up a localized string similar to ProgramData path is not defined..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.SchemaCreateCollectionMsg">
|
||||
<summary>
|
||||
Looks up a localized string similar to The server doesn't support the requested operation. Please update the MySQL Server and/or Client library.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.ThrowingAwayResults">
|
||||
<summary>
|
||||
Looks up a localized string similar to The process of closing the resultset and resulted in results being lost..
|
||||
@@ -12762,6 +12851,262 @@
|
||||
</summary>
|
||||
<returns>A string representation of the WKT.</returns>
|
||||
</member>
|
||||
<member name="T:MySql.Data.X.common.UnmanagedLibraryLoader">
|
||||
<summary>
|
||||
Provides functionality for loading unmanaged libraries.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.common.UnmanagedLibraryLoader.LoadUnmanagedLibraryFromEmbeddedResources(System.String,System.String)">
|
||||
<summary>
|
||||
Loads the specified unmanaged library from the embedded resources.
|
||||
</summary>
|
||||
<param name="applicationName">The application name.</param>
|
||||
<param name="libraryName">The library name.</param>
|
||||
</member>
|
||||
<member name="T:MySql.Data.X.Communication.XCompressionController">
|
||||
<summary>
|
||||
Provides support for configuring X Protocol compressed messages.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController.ALGORITHMS_SUBKEY">
|
||||
<summary>
|
||||
The capabilities sub-key used to specify the compression algorithm.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController.COMPRESSION_KEY">
|
||||
<summary>
|
||||
The capabilities key used to specify the compression capability.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController.COMPRESSION_THRESHOLD">
|
||||
<summary>
|
||||
Messages with a value lower than this threshold will not be compressed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController.DEFAULT_SERVER_COMBINE_MIXED_MESSAGES_VALUE">
|
||||
<summary>
|
||||
Default value for enabling or disabling combined compressed messages.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController.DEFAULT_SERVER_MAX_COMBINE_MESSAGES_VALUE">
|
||||
<summary>
|
||||
Default value for the maximum number of combined compressed messages contained in a compression message.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController.DEFLATE_STREAM_COMPRESSION_ALGORITHM">
|
||||
<summary>
|
||||
deflate_stream compression algorithm.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController.LZ4_MESSAGE_COMPRESSION_ALGORITHM">
|
||||
<summary>
|
||||
lz4_message compression algorithm.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController.SERVER_COMBINE_MIXED_MESSAGES_SUBKEY">
|
||||
<summary>
|
||||
The capabilities sub-key used to specify if combining compressed messages is permitted.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController.SERVER_MAX_COMBINE_MESSAGES_SUBKEY">
|
||||
<summary>
|
||||
The capabilities sub-key used to specify the maximum number of compressed messages contained in a compression message.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController.ZSTD_STREAM_COMPRESSION_ALGORITHM">
|
||||
<summary>
|
||||
zstd_stream compression algorithm.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController._buffer">
|
||||
<summary>
|
||||
Buffer used to store the data received from the server.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController._deflateCompressStream">
|
||||
<summary>
|
||||
Deflate stream used for compressing data.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController._deflateDecompressStream">
|
||||
<summary>
|
||||
Deflate stream used for decompressing data.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController._initializeForCompression">
|
||||
<summary>
|
||||
Flag indicating if the initialization is for compression or decompression.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController._lastCommunicationPacket">
|
||||
<summary>
|
||||
Stores the communication packet generated the last time ReadNextBufferedMessage method was called.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController._libzstdLoaded">
|
||||
<summary>
|
||||
Indicates if the libzstd.dll has been loaded.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController._multipleMessagesStream">
|
||||
<summary>
|
||||
Stream used to store multiple X Protocol messages.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController._zstdDecompressStream">
|
||||
<summary>
|
||||
ZStandard stream used for decompressing data.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.#cctor">
|
||||
<summary>
|
||||
Static constructor used to initialize the client supported compression algorithms.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.#ctor(System.String,System.Boolean)">
|
||||
<summary>
|
||||
Main constructor used to set the compression algorithm and initialize the list of messages to
|
||||
be compressed by the client.
|
||||
</summary>
|
||||
<param name="compressionAlgorithm">The compression algorithm to use.</param>
|
||||
<param name="initializeForCompression">Flag indicating if the initialization is for compression or decompression.</param>
|
||||
</member>
|
||||
<member name="P:MySql.Data.X.Communication.XCompressionController.ClientSupportedCompressedMessages">
|
||||
<summary>
|
||||
Gets or sets the list of messages that should be compressed by the client when compression is enabled.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.X.Communication.XCompressionController.ClientSupportedCompressionAlgorithms">
|
||||
<summary>
|
||||
Gets or sets an array containing the compression algorithms supported by the client.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.X.Communication.XCompressionController.CompressionAlgorithm">
|
||||
<summary>
|
||||
Gets or sets the compression algorithm.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.X.Communication.XCompressionController.IsCompressionEnabled">
|
||||
<summary>
|
||||
Flag indicating if compression is enabled.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.X.Communication.XCompressionController.LastMessageContainsMultipleMessages">
|
||||
<summary>
|
||||
Flag indicating if the last decompressed message contains multiple messages.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.Compress(System.Byte[])">
|
||||
<summary>
|
||||
General method used to compress data using the compression algorithm defined in the constructor.
|
||||
</summary>
|
||||
<param name="input">The data to compress.</param>
|
||||
<returns>A compressed byte array.</returns>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.CompressUsingDeflateStream(System.Byte[])">
|
||||
<summary>
|
||||
Compresses data using the deflate_stream algorithm.
|
||||
</summary>
|
||||
<param name="input">The data to compress.</param>
|
||||
<returns>A compressed byte array.</returns>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.CompressUsingLz4Message(System.Byte[])">
|
||||
<summary>
|
||||
Compresses data using the lz4_message algorithm.
|
||||
</summary>
|
||||
<param name="input">The data to compress.</param>
|
||||
<returns>A compressed byte array.</returns>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.CompressUsingZstdStream(System.Byte[])">
|
||||
<summary>
|
||||
Compresses data using the zstd_stream algorithm.
|
||||
</summary>
|
||||
<param name="input">The data to compress.</param>
|
||||
<returns>A compressed byte array.</returns>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.Decompress(System.Byte[],System.Int32)">
|
||||
<summary>
|
||||
General method used to decompress data using the compression algorithm defined in the constructor.
|
||||
</summary>
|
||||
<param name="input">The data to decompress.</param>
|
||||
<param name="length">The expected length of the decompressed data.</param>
|
||||
<returns>A decompressed byte array.</returns>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.DecompressUsingDeflateStream(System.Byte[],System.Int32)">
|
||||
<summary>
|
||||
Decompresses data using the deflate_stream compression algorithm.
|
||||
</summary>
|
||||
<param name="input">The data to decompress.</param>
|
||||
<param name="length">The expected length of the decompressed data.</param>
|
||||
<returns>A decompressed byte array.</returns>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.DecompressUsingLz4Message(System.Byte[],System.Int32)">
|
||||
<summary>
|
||||
Decompresses data using the lz4_message compression algorithm.
|
||||
</summary>
|
||||
<param name="input">The data to decompress.</param>
|
||||
<param name="length">The expected length of the decompressed data.</param>
|
||||
<returns>A decompressed byte array.</returns>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.DecompressUsingZstdStream(System.Byte[],System.Int32)">
|
||||
<summary>
|
||||
Decompresses data using the zstd_stream compression algorithm.
|
||||
</summary>
|
||||
<param name="input">The data to decompress.</param>
|
||||
<param name="length">The expected length of the decompressed data.</param>
|
||||
<returns>A decompressed byte array.</returns>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.Close">
|
||||
<summary>
|
||||
Closes and disposes of any open streams.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.ReadNextBufferedMessage">
|
||||
<summary>
|
||||
Gets the byte array representing the next X Protocol frame that is stored in cache.
|
||||
</summary>
|
||||
<returns>A byte array representing an X Protocol frame.</returns>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.ReadNextBufferedMessageAsCommunicationPacket">
|
||||
<summary>
|
||||
Gets a <see cref="T:MySqlX.Communication.CommunicationPacket"/> representing the next X Protocol frame that is stored in cache.
|
||||
</summary>
|
||||
<returns>A <see cref="T:MySqlX.Communication.CommunicationPacket"/> with the next X Protocol frame.</returns>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.LoadLibzstdLibrary">
|
||||
<summary>
|
||||
Loads the libzstd.dll assembly.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:MySql.Data.X.XDevAPI.Common.CreateCollectionOptions">
|
||||
<summary>
|
||||
This object store the required parameters to create a Collection with schema validation.
|
||||
</summary>
|
||||
<param name="ReuseExisting">If false, throws an exception if the collection exists.</param>
|
||||
<param name="Validation">Object which hold the Level and Schema parameters</param>
|
||||
<see cref="P:MySql.Data.X.XDevAPI.Common.CreateCollectionOptions.Validation"/>
|
||||
</member>
|
||||
<member name="P:MySql.Data.X.XDevAPI.Common.ModifyCollectionOptions.Validation">
|
||||
<summary>
|
||||
This object store the required parameters to Modify a Collection with schema validation.
|
||||
</summary>
|
||||
<param name="Validation">Object which hold the Level and Schema parameters</param>
|
||||
<see cref="P:MySql.Data.X.XDevAPI.Common.ModifyCollectionOptions.Validation"/>
|
||||
</member>
|
||||
<member name="P:MySql.Data.X.XDevAPI.Common.Validation.Level">
|
||||
<summary>
|
||||
This object store the required parameters to create a Collection with schema validation.
|
||||
</summary>
|
||||
<param name="Level">It can be STRICT to enable schema validation or OFF to disable <see cref="T:MySql.Data.X.XDevAPI.Common.ValidationLevel"/></param>
|
||||
<param name="Schema">The JSON which define the rules to be validated in the collection</param>
|
||||
</member>
|
||||
<member name="T:MySql.Data.X.XDevAPI.Common.ValidationLevel">
|
||||
<summary>
|
||||
The possible values for parameter Level in Validation object.
|
||||
</summary>
|
||||
<param name="STRICT">Enforce schema validation.</param>
|
||||
<param name="OFF">Schema validation disabled.</param>
|
||||
</member>
|
||||
<member name="T:MySqlX.Security.ExternalAuthenticationPlugin">
|
||||
<summary>
|
||||
Implementation of EXTERNAL authentication type.
|
||||
@@ -12793,6 +13138,44 @@
|
||||
<param name="guid2">The second <see cref="T:System.Guid"/> to compare.</param>
|
||||
<returns>An integer that indicates the lexical relationship between the two comparands, similar to <see cref="M:System.String.Compare(System.String,System.String)"/></returns>
|
||||
</member>
|
||||
<member name="M:MySqlX.Communication.XPacketReaderWriter.#ctor(System.IO.Stream)">
|
||||
<summary>
|
||||
Constructor that sets the stream used to read or write data.
|
||||
</summary>
|
||||
<param name="stream">The stream used to read or write data.</param>
|
||||
</member>
|
||||
<member name="M:MySqlX.Communication.XPacketReaderWriter.#ctor(System.IO.Stream,MySql.Data.X.Communication.XCompressionController)">
|
||||
<summary>
|
||||
Constructor that sets the stream used to read or write data and the compression controller.
|
||||
</summary>
|
||||
<param name="stream">The stream used to read or write data.</param>
|
||||
<param name="compressionController">The compression controller.</param>
|
||||
</member>
|
||||
<member name="P:MySqlX.Communication.XPacketReaderWriter.CompressionController">
|
||||
<summary>
|
||||
Gets or sets the compression controller uses to manage compression operations.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MySqlX.Communication.XPacketReaderWriter.Write(System.Int32,Google.Protobuf.IMessage)">
|
||||
<summary>
|
||||
Writes X Protocol frames to the X Plugin.
|
||||
</summary>
|
||||
<param name="id">The integer representation of the client message identifier used for the message.</param>
|
||||
<param name="message">The message to include in the X Protocol frame.</param>
|
||||
</member>
|
||||
<member name="M:MySqlX.Communication.XPacketReaderWriter.Write(MySqlX.Communication.ClientMessageId,Google.Protobuf.IMessage)">
|
||||
<summary>
|
||||
Writes X Protocol frames to the X Plugin.
|
||||
</summary>
|
||||
<param name="id">The client message identifier used for the message.</param>
|
||||
<param name="message">The message to include in the X Protocol frame.</param>
|
||||
</member>
|
||||
<member name="M:MySqlX.Communication.XPacketReaderWriter.Read">
|
||||
<summary>
|
||||
Reads X Protocol frames incoming from the X Plugin.
|
||||
</summary>
|
||||
<returns>A <see cref="T:MySqlX.Communication.CommunicationPacket"/> instance representing the X Protocol frame that was read.</returns>
|
||||
</member>
|
||||
<member name="T:MySqlX.Protocol.ProtocolBase">
|
||||
<summary>
|
||||
Abstract class for the protocol base operations in client/server communication.
|
||||
@@ -12997,6 +13380,15 @@
|
||||
<member name="M:MySqlX.Protocol.X.ExprUnparser.ExprToString(Mysqlx.Expr.Expr)">
|
||||
Serialize an expression to a string.
|
||||
</member>
|
||||
<member name="M:MySqlX.Protocol.XProtocol.SendExecuteStatementOptions(System.String,System.String,System.Collections.Generic.KeyValuePair{System.String,System.Object}[])">
|
||||
<summary>
|
||||
Build the message to be sent to MySQL Server to execute statement "Create" or "Modify" collection with schema options
|
||||
</summary>
|
||||
<param name="ns">The namespace</param>
|
||||
<param name="stmt">The name of the command to be executed on MySql Server</param>
|
||||
<param name="args">Array of KeyValuePairs with the parameters required to build the message</param>
|
||||
<returns>void.</returns>
|
||||
</member>
|
||||
<member name="M:MySqlX.Protocol.XProtocol.SendDelete(System.String,System.String,System.Boolean,MySqlX.XDevAPI.Common.FilterParams)">
|
||||
<summary>
|
||||
Sends the delete documents message
|
||||
@@ -13087,11 +13479,58 @@
|
||||
Implementation class of InternalSession to manage connections using the Xprotocol type object.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySqlX.Sessions.XInternalSession._readerCompressionController">
|
||||
<summary>
|
||||
Defines the compression controller that will be passed on the <see cref="T:MySqlX.Communication.XPacketReaderWriter"/> instance when
|
||||
compression is enabled.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySqlX.Sessions.XInternalSession._writerCompressionController">
|
||||
<summary>
|
||||
Defines the compression controller that will be passed on the <see cref="T:MySqlX.Communication.XPacketReaderWriter"/> instance when
|
||||
compression is enabled.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySqlX.Sessions.XInternalSession._sshHandler">
|
||||
<summary>
|
||||
The used client to handle SSH connections.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MySqlX.Sessions.XInternalSession.NegotiateCompression(System.String[])">
|
||||
<summary>
|
||||
Negotiates compression capabilities with the server.
|
||||
</summary>
|
||||
<param name="serverSupportedAlgorithms">An array containing the compression algorithms supported by the server.</param>
|
||||
</member>
|
||||
<member name="M:MySqlX.Sessions.XInternalSession.CreateCollection(System.String,System.String,MySql.Data.X.XDevAPI.Common.CreateCollectionOptions)">
|
||||
<summary>
|
||||
Prepare the dictionary of arguments required to create a MySQL message.
|
||||
</summary>
|
||||
<param name="schemaName">The name of the MySQL schema.</param>
|
||||
<param name="collectionName">The name of the collection.</param>
|
||||
<param name="options">This object hold the parameters required to create the collection.</param>
|
||||
<see cref="T:MySql.Data.X.XDevAPI.Common.CreateCollectionOptions"/>
|
||||
<returns>Collection referente.</returns>
|
||||
</member>
|
||||
<member name="M:MySqlX.Sessions.XInternalSession.ModifyCollection(System.String,System.String,System.Nullable{MySql.Data.X.XDevAPI.Common.ModifyCollectionOptions})">
|
||||
<summary>
|
||||
Prepare the dictionary of arguments required to Modify a MySQL message.
|
||||
</summary>
|
||||
<param name="schemaName">The name of the MySQL schema.</param>
|
||||
<param name="collectionName">The name of the collection.</param>
|
||||
<param name="options">This object hold the parameters required to Modify the collection.</param>
|
||||
<see cref="T:MySql.Data.X.XDevAPI.Common.ModifyCollectionOptions"/>
|
||||
<returns>Collection referente.</returns>
|
||||
</member>
|
||||
<member name="M:MySqlX.Sessions.XInternalSession.GetCompressionAlgorithm(System.Boolean)">
|
||||
<summary>
|
||||
Gets the compression algorithm being used to compress or decompress data.
|
||||
</summary>
|
||||
<param name="fromReaderController">Flag to indicate if the compression algorithm should be
|
||||
retrieved from the reader or writer controller.</param>
|
||||
<returns>The name of the compression algorithm being used if any.
|
||||
<c>null</c> if no compression algorithm is being used.</returns>
|
||||
</member>
|
||||
<member name="T:MySqlX.XDevAPI.BaseSession">
|
||||
<summary>
|
||||
Represents a base class for a Session.
|
||||
@@ -14288,6 +14727,22 @@
|
||||
Contains connection options specific to the X protocol.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MySqlX.XDevAPI.MySqlXConnectionStringBuilder.#ctor">
|
||||
<summary>
|
||||
Main constructor.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MySqlX.XDevAPI.MySqlXConnectionStringBuilder.#ctor(System.String,System.Boolean)">
|
||||
<summary>
|
||||
Constructor accepting a connection string.
|
||||
</summary>
|
||||
<param name="connectionString">The connection string.</param>
|
||||
</member>
|
||||
<member name="F:MySqlX.XDevAPI.MySqlXConnectionStringBuilder.Options">
|
||||
<summary>
|
||||
Readonly field containing a collection of classic protocol and protocol shared connection options.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySqlX.XDevAPI.MySqlXConnectionStringBuilder.ConnectTimeout">
|
||||
<summary>
|
||||
Gets or sets the connection timeout.
|
||||
@@ -14303,6 +14758,17 @@
|
||||
Path to a local file containing certificate revocation lists.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySqlX.XDevAPI.MySqlXConnectionStringBuilder.Compression">
|
||||
<summary>
|
||||
Gets or sets the compression type between client and server.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySqlX.XDevAPI.MySqlXConnectionStringBuilder.Item(System.String)">
|
||||
<summary>
|
||||
Gets or sets a connection option.
|
||||
</summary>
|
||||
<param name="keyword">The keyword that identifies the connection option to modify.</param>
|
||||
</member>
|
||||
<member name="T:MySqlX.XDevAPI.Relational.Column">
|
||||
<summary>
|
||||
Represents a table column.
|
||||
@@ -14739,7 +15205,24 @@
|
||||
Creates a collection.
|
||||
</summary>
|
||||
<param name="collectionName">The name of the collection to create.</param>
|
||||
<param name="ReuseExistingObject">If false, it will throw an exception if collection exists.</param>
|
||||
<param name="ReuseExisting">If false, throws an exception if the collection exists.</param>
|
||||
<returns>Collection referente.</returns>
|
||||
</member>
|
||||
<member name="M:MySqlX.XDevAPI.Schema.CreateCollection(System.String,MySql.Data.X.XDevAPI.Common.CreateCollectionOptions)">
|
||||
<summary>
|
||||
Creates a collection including a schema validation.
|
||||
</summary>
|
||||
<param name="collectionName">The name of the collection to create.</param>
|
||||
<param name="options">This object hold the parameters required to create the collection.</param>
|
||||
<see cref="T:MySql.Data.X.XDevAPI.Common.CreateCollectionOptions"/>
|
||||
<returns>Collection referente.</returns>
|
||||
</member>
|
||||
<member name="M:MySqlX.XDevAPI.Schema.ModifyCollection(System.String,System.Nullable{MySql.Data.X.XDevAPI.Common.ModifyCollectionOptions})">
|
||||
<summary>
|
||||
Modify a collection adding or removing schema validation parameters.
|
||||
</summary>
|
||||
<param name="collectionName">The name of the collection to create.</param>
|
||||
<param name="options">This object encapsulate the Validation parameters level and schema. </param>
|
||||
<returns>Collection referente.</returns>
|
||||
</member>
|
||||
<member name="M:MySqlX.XDevAPI.Schema.DropCollection(System.String)">
|
||||
@@ -14787,13 +15270,13 @@
|
||||
</member>
|
||||
<member name="T:Mysqlx.ClientMessages">
|
||||
<summary>
|
||||
IDs of messages that can be sent from client to the server
|
||||
IDs of messages that can be sent from client to the server
|
||||
|
||||
.. note::
|
||||
this message is never sent on the wire. It is only used to let ``protoc``
|
||||
.. note::
|
||||
this message is never sent on the wire. It is only used to let ``protoc``
|
||||
|
||||
* generate constants
|
||||
* check for uniqueness
|
||||
* generate constants
|
||||
* check for uniqueness
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Mysqlx.ClientMessages.Types">
|
||||
@@ -14801,13 +15284,13 @@
|
||||
</member>
|
||||
<member name="T:Mysqlx.ServerMessages">
|
||||
<summary>
|
||||
IDs of messages that can be sent from server to client
|
||||
IDs of messages that can be sent from server to client
|
||||
|
||||
.. note::
|
||||
this message is never sent on the wire. It is only used to let ``protoc``
|
||||
.. note::
|
||||
this message is never sent on the wire. It is only used to let ``protoc``
|
||||
|
||||
* generate constants
|
||||
* check for uniqueness
|
||||
* generate constants
|
||||
* check for uniqueness
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Mysqlx.ServerMessages.Types">
|
||||
@@ -14815,12 +15298,12 @@
|
||||
</member>
|
||||
<member name="F:Mysqlx.ServerMessages.Types.Type.Notice">
|
||||
<summary>
|
||||
NOTICE has to stay at 11 forever
|
||||
NOTICE has to stay at 11 forever
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Mysqlx.Ok">
|
||||
<summary>
|
||||
generic Ok message
|
||||
generic Ok message
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Mysqlx.Ok.MsgFieldNumber">
|
||||
@@ -14828,19 +15311,19 @@
|
||||
</member>
|
||||
<member name="T:Mysqlx.Error">
|
||||
<summary>
|
||||
generic Error message
|
||||
generic Error message
|
||||
|
||||
A ``severity`` of ``ERROR`` indicates the current message sequence is
|
||||
aborted for the given error and the session is ready for more.
|
||||
A ``severity`` of ``ERROR`` indicates the current message sequence is
|
||||
aborted for the given error and the session is ready for more.
|
||||
|
||||
In case of a ``FATAL`` error message the client should not expect
|
||||
the server to continue handling any further messages and should
|
||||
close the connection.
|
||||
In case of a ``FATAL`` error message the client should not expect
|
||||
the server to continue handling any further messages and should
|
||||
close the connection.
|
||||
|
||||
:param severity: severity of the error message
|
||||
:param code: error-code
|
||||
:param sql_state: SQL state
|
||||
:param msg: human readable error message
|
||||
:param severity: severity of the error message
|
||||
:param code: error-code
|
||||
:param sql_state: SQL state
|
||||
:param msg: human readable error message
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Mysqlx.Error.SeverityFieldNumber">
|
||||
@@ -14874,19 +15357,9 @@
|
||||
<member name="F:Mysqlx.Connection.Capability.NameFieldNumber">
|
||||
<summary>Field number for the "name" field.</summary>
|
||||
</member>
|
||||
<member name="P:Mysqlx.Connection.Capability.Name">
|
||||
<summary>
|
||||
required
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Mysqlx.Connection.Capability.ValueFieldNumber">
|
||||
<summary>Field number for the "value" field.</summary>
|
||||
</member>
|
||||
<member name="P:Mysqlx.Connection.Capability.Value">
|
||||
<summary>
|
||||
required
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Mysqlx.Connection.Capabilities">
|
||||
<summary>
|
||||
Capabilities
|
||||
@@ -14916,11 +15389,6 @@
|
||||
<member name="F:Mysqlx.Connection.CapabilitiesSet.CapabilitiesFieldNumber">
|
||||
<summary>Field number for the "capabilities" field.</summary>
|
||||
</member>
|
||||
<member name="P:Mysqlx.Connection.CapabilitiesSet.Capabilities">
|
||||
<summary>
|
||||
required
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Mysqlx.Connection.Close">
|
||||
<summary>
|
||||
announce to the server that the client wants to close the connection
|
||||
@@ -14930,6 +15398,18 @@
|
||||
:Returns: :protobuf:msg:`Mysqlx::Ok`
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Mysqlx.Connection.Compression.UncompressedSizeFieldNumber">
|
||||
<summary>Field number for the "uncompressed_size" field.</summary>
|
||||
</member>
|
||||
<member name="F:Mysqlx.Connection.Compression.ServerMessagesFieldNumber">
|
||||
<summary>Field number for the "server_messages" field.</summary>
|
||||
</member>
|
||||
<member name="F:Mysqlx.Connection.Compression.ClientMessagesFieldNumber">
|
||||
<summary>Field number for the "client_messages" field.</summary>
|
||||
</member>
|
||||
<member name="F:Mysqlx.Connection.Compression.PayloadFieldNumber">
|
||||
<summary>Field number for the "payload" field.</summary>
|
||||
</member>
|
||||
<member name="T:Mysqlx.Crud.MysqlxCrudReflection">
|
||||
<summary>Holder for reflection information generated from mysqlx_crud.proto</summary>
|
||||
</member>
|
||||
BIN
Binary file not shown.
Binary file not shown.
Binary file not shown.
+538
-58
@@ -3509,26 +3509,6 @@
|
||||
Summary description for Field.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:MySql.Data.MySqlClient.CustomInstaller">
|
||||
<summary>
|
||||
We are adding a custom installer class to our assembly so our installer
|
||||
can make proper changes to the machine.config file.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MySql.Data.MySqlClient.CustomInstaller.Install(System.Collections.IDictionary)">
|
||||
<summary>
|
||||
We override Install so we can add our assembly to the proper
|
||||
machine.config files.
|
||||
</summary>
|
||||
<param name="stateSaver"></param>
|
||||
</member>
|
||||
<member name="M:MySql.Data.MySqlClient.CustomInstaller.Uninstall(System.Collections.IDictionary)">
|
||||
<summary>
|
||||
We override Uninstall so we can remove out assembly from the
|
||||
machine.config files.
|
||||
</summary>
|
||||
<param name="savedState"></param>
|
||||
</member>
|
||||
<member name="T:MySql.Data.MySqlClient.MySqlCommandBuilder">
|
||||
<summary>
|
||||
Automatically generates single-table commands used to reconcile changes made to a DataSet with the associated MySQL database. This class cannot be inherited.
|
||||
@@ -6103,6 +6083,21 @@
|
||||
Abstract class that provides common functionality for connection options that apply for all protocols.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.MySqlClient.MySqlBaseConnectionStringBuilder.Options">
|
||||
<summary>
|
||||
Readonly field containing a collection of protocol shared connection options.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.MySqlClient.MySqlBaseConnectionStringBuilder.HasProcAccess">
|
||||
<summary>
|
||||
Gets or sets a flag indicating if the object has access to procedures.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.MySqlClient.MySqlBaseConnectionStringBuilder.values">
|
||||
<summary>
|
||||
Gets or sets a dictionary representing key-value pairs for each connection option.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.MySqlClient.MySqlBaseConnectionStringBuilder.Server">
|
||||
<summary>
|
||||
Gets or sets the name of the server.
|
||||
@@ -6291,6 +6286,22 @@
|
||||
Contains connection options specific to the Classic protocol.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MySql.Data.MySqlClient.MySqlConnectionStringBuilder.#ctor">
|
||||
<summary>
|
||||
Main constructor.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MySql.Data.MySqlClient.MySqlConnectionStringBuilder.#ctor(System.String)">
|
||||
<summary>
|
||||
Constructor accepting a connection string.
|
||||
</summary>
|
||||
<param name="connectionString">The connection string.</param>
|
||||
</member>
|
||||
<member name="F:MySql.Data.MySqlClient.MySqlConnectionStringBuilder.Options">
|
||||
<summary>
|
||||
Readonly field containing a collection of classic protocol and protocol shared connection options.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.MySqlClient.MySqlConnectionStringBuilder.PipeName">
|
||||
<summary>
|
||||
Gets or sets the name of the named pipe that should be used
|
||||
@@ -6545,6 +6556,12 @@
|
||||
Gets or sets the pattern to match for the columns that should not be treated as UTF8.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.MySqlClient.MySqlConnectionStringBuilder.Item(System.String)">
|
||||
<summary>
|
||||
Gets or sets a connection option.
|
||||
</summary>
|
||||
<param name="keyword">The keyword that identifies the connection option to modify.</param>
|
||||
</member>
|
||||
<member name="T:MySql.Data.MySqlClient.ClientFlags">
|
||||
<summary>
|
||||
Summary description for ClientParam.
|
||||
@@ -6958,6 +6975,27 @@
|
||||
removing locked rows from the result set.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:MySql.Data.MySqlClient.CompressionType">
|
||||
<summary>
|
||||
Defines the type of compression used when data is exchanged between client and server.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.MySqlClient.CompressionType.Preferred">
|
||||
<summary>
|
||||
Uses compression if client and server are able to reach a concensus. Otherwise, compression
|
||||
is not used.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.MySqlClient.CompressionType.Required">
|
||||
<summary>
|
||||
Enforces the use of compression. If no concensus is reached, an error is raised.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.MySqlClient.CompressionType.Disabled">
|
||||
<summary>
|
||||
Disables compression.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:MySql.Data.MySqlClient.MySqlError">
|
||||
<summary>
|
||||
Collection of error codes that can be returned by the server
|
||||
@@ -12311,6 +12349,42 @@
|
||||
Looks up a localized string similar to Scheme '{0}' is not valid..
|
||||
</summary>
|
||||
</member>
|
||||
<!-- Badly formed XML comment ignored for member "P:MySql.Data.ResourcesX.CompressionAlgorithmNegotiationFailed" -->
|
||||
<member name="P:MySql.Data.ResourcesX.CompressionAlgorithmNotSupported">
|
||||
<summary>
|
||||
Looks up a localized string similar to Compression using {0} is not supported..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.CompressionFailedToLoadLibzstdAssembly">
|
||||
<summary>
|
||||
Looks up a localized string similar to Failed to load libzstd.dll. Removing zstd_stream from the client supported compression algorithms..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.CompressionForSpecificAlgorithmNotSupportedInNetFramework">
|
||||
<summary>
|
||||
Looks up a localized string similar to Compression using {0} is not supported in .NET Framework..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.CompressionInvalidValue">
|
||||
<summary>
|
||||
Looks up a localized string similar to The connection property 'compression' acceptable values are: 'preferred', 'required' or 'disabled'. The value '{0}' is not acceptable..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.CompressionNotEnabled">
|
||||
<summary>
|
||||
Looks up a localized string similar to Compression is not enabled..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.CompressionNotSupportedByServer">
|
||||
<summary>
|
||||
Looks up a localized string similar to Compression requested but the server does not support it..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.CompressionPendingMessagesToProcess">
|
||||
<summary>
|
||||
Looks up a localized string similar to There are still decompressed messages pending to be processed..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.DuplicateUserDefinedAttribute">
|
||||
<summary>
|
||||
Looks up a localized string similar to Duplicate key '{0}' used in "connection-attributes"..
|
||||
@@ -12321,6 +12395,11 @@
|
||||
Looks up a localized string similar to Key name in connection attribute cannot be an empty string..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.EmptyOptions">
|
||||
<summary>
|
||||
Looks up a localized string similar to At least one option must be specified..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.FeatureNotSupported">
|
||||
<summary>
|
||||
Looks up a localized string similar to This feature is currently not supported..
|
||||
@@ -12431,6 +12510,11 @@
|
||||
Looks up a localized string similar to Field '{0}' is mandatory..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.MissingSchemaOption">
|
||||
<summary>
|
||||
Looks up a localized string similar to Missed required 'schema' option..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.MoreThanOneDocumentId">
|
||||
<summary>
|
||||
Looks up a localized string similar to More than one document id was generated. Please use the DocumentIds property instead..
|
||||
@@ -12496,6 +12580,11 @@
|
||||
Looks up a localized string similar to ProgramData path is not defined..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.SchemaCreateCollectionMsg">
|
||||
<summary>
|
||||
Looks up a localized string similar to The server doesn't support the requested operation. Please update the MySQL Server and/or Client library.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.ResourcesX.ThrowingAwayResults">
|
||||
<summary>
|
||||
Looks up a localized string similar to The process of closing the resultset and resulted in results being lost..
|
||||
@@ -12762,6 +12851,262 @@
|
||||
</summary>
|
||||
<returns>A string representation of the WKT.</returns>
|
||||
</member>
|
||||
<member name="T:MySql.Data.X.common.UnmanagedLibraryLoader">
|
||||
<summary>
|
||||
Provides functionality for loading unmanaged libraries.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.common.UnmanagedLibraryLoader.LoadUnmanagedLibraryFromEmbeddedResources(System.String,System.String)">
|
||||
<summary>
|
||||
Loads the specified unmanaged library from the embedded resources.
|
||||
</summary>
|
||||
<param name="applicationName">The application name.</param>
|
||||
<param name="libraryName">The library name.</param>
|
||||
</member>
|
||||
<member name="T:MySql.Data.X.Communication.XCompressionController">
|
||||
<summary>
|
||||
Provides support for configuring X Protocol compressed messages.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController.ALGORITHMS_SUBKEY">
|
||||
<summary>
|
||||
The capabilities sub-key used to specify the compression algorithm.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController.COMPRESSION_KEY">
|
||||
<summary>
|
||||
The capabilities key used to specify the compression capability.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController.COMPRESSION_THRESHOLD">
|
||||
<summary>
|
||||
Messages with a value lower than this threshold will not be compressed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController.DEFAULT_SERVER_COMBINE_MIXED_MESSAGES_VALUE">
|
||||
<summary>
|
||||
Default value for enabling or disabling combined compressed messages.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController.DEFAULT_SERVER_MAX_COMBINE_MESSAGES_VALUE">
|
||||
<summary>
|
||||
Default value for the maximum number of combined compressed messages contained in a compression message.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController.DEFLATE_STREAM_COMPRESSION_ALGORITHM">
|
||||
<summary>
|
||||
deflate_stream compression algorithm.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController.LZ4_MESSAGE_COMPRESSION_ALGORITHM">
|
||||
<summary>
|
||||
lz4_message compression algorithm.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController.SERVER_COMBINE_MIXED_MESSAGES_SUBKEY">
|
||||
<summary>
|
||||
The capabilities sub-key used to specify if combining compressed messages is permitted.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController.SERVER_MAX_COMBINE_MESSAGES_SUBKEY">
|
||||
<summary>
|
||||
The capabilities sub-key used to specify the maximum number of compressed messages contained in a compression message.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController.ZSTD_STREAM_COMPRESSION_ALGORITHM">
|
||||
<summary>
|
||||
zstd_stream compression algorithm.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController._buffer">
|
||||
<summary>
|
||||
Buffer used to store the data received from the server.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController._deflateCompressStream">
|
||||
<summary>
|
||||
Deflate stream used for compressing data.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController._deflateDecompressStream">
|
||||
<summary>
|
||||
Deflate stream used for decompressing data.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController._initializeForCompression">
|
||||
<summary>
|
||||
Flag indicating if the initialization is for compression or decompression.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController._lastCommunicationPacket">
|
||||
<summary>
|
||||
Stores the communication packet generated the last time ReadNextBufferedMessage method was called.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController._libzstdLoaded">
|
||||
<summary>
|
||||
Indicates if the libzstd.dll has been loaded.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController._multipleMessagesStream">
|
||||
<summary>
|
||||
Stream used to store multiple X Protocol messages.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySql.Data.X.Communication.XCompressionController._zstdDecompressStream">
|
||||
<summary>
|
||||
ZStandard stream used for decompressing data.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.#cctor">
|
||||
<summary>
|
||||
Static constructor used to initialize the client supported compression algorithms.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.#ctor(System.String,System.Boolean)">
|
||||
<summary>
|
||||
Main constructor used to set the compression algorithm and initialize the list of messages to
|
||||
be compressed by the client.
|
||||
</summary>
|
||||
<param name="compressionAlgorithm">The compression algorithm to use.</param>
|
||||
<param name="initializeForCompression">Flag indicating if the initialization is for compression or decompression.</param>
|
||||
</member>
|
||||
<member name="P:MySql.Data.X.Communication.XCompressionController.ClientSupportedCompressedMessages">
|
||||
<summary>
|
||||
Gets or sets the list of messages that should be compressed by the client when compression is enabled.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.X.Communication.XCompressionController.ClientSupportedCompressionAlgorithms">
|
||||
<summary>
|
||||
Gets or sets an array containing the compression algorithms supported by the client.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.X.Communication.XCompressionController.CompressionAlgorithm">
|
||||
<summary>
|
||||
Gets or sets the compression algorithm.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.X.Communication.XCompressionController.IsCompressionEnabled">
|
||||
<summary>
|
||||
Flag indicating if compression is enabled.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySql.Data.X.Communication.XCompressionController.LastMessageContainsMultipleMessages">
|
||||
<summary>
|
||||
Flag indicating if the last decompressed message contains multiple messages.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.Compress(System.Byte[])">
|
||||
<summary>
|
||||
General method used to compress data using the compression algorithm defined in the constructor.
|
||||
</summary>
|
||||
<param name="input">The data to compress.</param>
|
||||
<returns>A compressed byte array.</returns>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.CompressUsingDeflateStream(System.Byte[])">
|
||||
<summary>
|
||||
Compresses data using the deflate_stream algorithm.
|
||||
</summary>
|
||||
<param name="input">The data to compress.</param>
|
||||
<returns>A compressed byte array.</returns>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.CompressUsingLz4Message(System.Byte[])">
|
||||
<summary>
|
||||
Compresses data using the lz4_message algorithm.
|
||||
</summary>
|
||||
<param name="input">The data to compress.</param>
|
||||
<returns>A compressed byte array.</returns>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.CompressUsingZstdStream(System.Byte[])">
|
||||
<summary>
|
||||
Compresses data using the zstd_stream algorithm.
|
||||
</summary>
|
||||
<param name="input">The data to compress.</param>
|
||||
<returns>A compressed byte array.</returns>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.Decompress(System.Byte[],System.Int32)">
|
||||
<summary>
|
||||
General method used to decompress data using the compression algorithm defined in the constructor.
|
||||
</summary>
|
||||
<param name="input">The data to decompress.</param>
|
||||
<param name="length">The expected length of the decompressed data.</param>
|
||||
<returns>A decompressed byte array.</returns>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.DecompressUsingDeflateStream(System.Byte[],System.Int32)">
|
||||
<summary>
|
||||
Decompresses data using the deflate_stream compression algorithm.
|
||||
</summary>
|
||||
<param name="input">The data to decompress.</param>
|
||||
<param name="length">The expected length of the decompressed data.</param>
|
||||
<returns>A decompressed byte array.</returns>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.DecompressUsingLz4Message(System.Byte[],System.Int32)">
|
||||
<summary>
|
||||
Decompresses data using the lz4_message compression algorithm.
|
||||
</summary>
|
||||
<param name="input">The data to decompress.</param>
|
||||
<param name="length">The expected length of the decompressed data.</param>
|
||||
<returns>A decompressed byte array.</returns>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.DecompressUsingZstdStream(System.Byte[],System.Int32)">
|
||||
<summary>
|
||||
Decompresses data using the zstd_stream compression algorithm.
|
||||
</summary>
|
||||
<param name="input">The data to decompress.</param>
|
||||
<param name="length">The expected length of the decompressed data.</param>
|
||||
<returns>A decompressed byte array.</returns>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.Close">
|
||||
<summary>
|
||||
Closes and disposes of any open streams.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.ReadNextBufferedMessage">
|
||||
<summary>
|
||||
Gets the byte array representing the next X Protocol frame that is stored in cache.
|
||||
</summary>
|
||||
<returns>A byte array representing an X Protocol frame.</returns>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.ReadNextBufferedMessageAsCommunicationPacket">
|
||||
<summary>
|
||||
Gets a <see cref="T:MySqlX.Communication.CommunicationPacket"/> representing the next X Protocol frame that is stored in cache.
|
||||
</summary>
|
||||
<returns>A <see cref="T:MySqlX.Communication.CommunicationPacket"/> with the next X Protocol frame.</returns>
|
||||
</member>
|
||||
<member name="M:MySql.Data.X.Communication.XCompressionController.LoadLibzstdLibrary">
|
||||
<summary>
|
||||
Loads the libzstd.dll assembly.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:MySql.Data.X.XDevAPI.Common.CreateCollectionOptions">
|
||||
<summary>
|
||||
This object store the required parameters to create a Collection with schema validation.
|
||||
</summary>
|
||||
<param name="ReuseExisting">If false, throws an exception if the collection exists.</param>
|
||||
<param name="Validation">Object which hold the Level and Schema parameters</param>
|
||||
<see cref="P:MySql.Data.X.XDevAPI.Common.CreateCollectionOptions.Validation"/>
|
||||
</member>
|
||||
<member name="P:MySql.Data.X.XDevAPI.Common.ModifyCollectionOptions.Validation">
|
||||
<summary>
|
||||
This object store the required parameters to Modify a Collection with schema validation.
|
||||
</summary>
|
||||
<param name="Validation">Object which hold the Level and Schema parameters</param>
|
||||
<see cref="P:MySql.Data.X.XDevAPI.Common.ModifyCollectionOptions.Validation"/>
|
||||
</member>
|
||||
<member name="P:MySql.Data.X.XDevAPI.Common.Validation.Level">
|
||||
<summary>
|
||||
This object store the required parameters to create a Collection with schema validation.
|
||||
</summary>
|
||||
<param name="Level">It can be STRICT to enable schema validation or OFF to disable <see cref="T:MySql.Data.X.XDevAPI.Common.ValidationLevel"/></param>
|
||||
<param name="Schema">The JSON which define the rules to be validated in the collection</param>
|
||||
</member>
|
||||
<member name="T:MySql.Data.X.XDevAPI.Common.ValidationLevel">
|
||||
<summary>
|
||||
The possible values for parameter Level in Validation object.
|
||||
</summary>
|
||||
<param name="STRICT">Enforce schema validation.</param>
|
||||
<param name="OFF">Schema validation disabled.</param>
|
||||
</member>
|
||||
<member name="T:MySqlX.Security.ExternalAuthenticationPlugin">
|
||||
<summary>
|
||||
Implementation of EXTERNAL authentication type.
|
||||
@@ -12793,6 +13138,44 @@
|
||||
<param name="guid2">The second <see cref="T:System.Guid"/> to compare.</param>
|
||||
<returns>An integer that indicates the lexical relationship between the two comparands, similar to <see cref="M:System.String.Compare(System.String,System.String)"/></returns>
|
||||
</member>
|
||||
<member name="M:MySqlX.Communication.XPacketReaderWriter.#ctor(System.IO.Stream)">
|
||||
<summary>
|
||||
Constructor that sets the stream used to read or write data.
|
||||
</summary>
|
||||
<param name="stream">The stream used to read or write data.</param>
|
||||
</member>
|
||||
<member name="M:MySqlX.Communication.XPacketReaderWriter.#ctor(System.IO.Stream,MySql.Data.X.Communication.XCompressionController)">
|
||||
<summary>
|
||||
Constructor that sets the stream used to read or write data and the compression controller.
|
||||
</summary>
|
||||
<param name="stream">The stream used to read or write data.</param>
|
||||
<param name="compressionController">The compression controller.</param>
|
||||
</member>
|
||||
<member name="P:MySqlX.Communication.XPacketReaderWriter.CompressionController">
|
||||
<summary>
|
||||
Gets or sets the compression controller uses to manage compression operations.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MySqlX.Communication.XPacketReaderWriter.Write(System.Int32,Google.Protobuf.IMessage)">
|
||||
<summary>
|
||||
Writes X Protocol frames to the X Plugin.
|
||||
</summary>
|
||||
<param name="id">The integer representation of the client message identifier used for the message.</param>
|
||||
<param name="message">The message to include in the X Protocol frame.</param>
|
||||
</member>
|
||||
<member name="M:MySqlX.Communication.XPacketReaderWriter.Write(MySqlX.Communication.ClientMessageId,Google.Protobuf.IMessage)">
|
||||
<summary>
|
||||
Writes X Protocol frames to the X Plugin.
|
||||
</summary>
|
||||
<param name="id">The client message identifier used for the message.</param>
|
||||
<param name="message">The message to include in the X Protocol frame.</param>
|
||||
</member>
|
||||
<member name="M:MySqlX.Communication.XPacketReaderWriter.Read">
|
||||
<summary>
|
||||
Reads X Protocol frames incoming from the X Plugin.
|
||||
</summary>
|
||||
<returns>A <see cref="T:MySqlX.Communication.CommunicationPacket"/> instance representing the X Protocol frame that was read.</returns>
|
||||
</member>
|
||||
<member name="T:MySqlX.Protocol.ProtocolBase">
|
||||
<summary>
|
||||
Abstract class for the protocol base operations in client/server communication.
|
||||
@@ -12997,6 +13380,15 @@
|
||||
<member name="M:MySqlX.Protocol.X.ExprUnparser.ExprToString(Mysqlx.Expr.Expr)">
|
||||
Serialize an expression to a string.
|
||||
</member>
|
||||
<member name="M:MySqlX.Protocol.XProtocol.SendExecuteStatementOptions(System.String,System.String,System.Collections.Generic.KeyValuePair{System.String,System.Object}[])">
|
||||
<summary>
|
||||
Build the message to be sent to MySQL Server to execute statement "Create" or "Modify" collection with schema options
|
||||
</summary>
|
||||
<param name="ns">The namespace</param>
|
||||
<param name="stmt">The name of the command to be executed on MySql Server</param>
|
||||
<param name="args">Array of KeyValuePairs with the parameters required to build the message</param>
|
||||
<returns>void.</returns>
|
||||
</member>
|
||||
<member name="M:MySqlX.Protocol.XProtocol.SendDelete(System.String,System.String,System.Boolean,MySqlX.XDevAPI.Common.FilterParams)">
|
||||
<summary>
|
||||
Sends the delete documents message
|
||||
@@ -13087,11 +13479,58 @@
|
||||
Implementation class of InternalSession to manage connections using the Xprotocol type object.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySqlX.Sessions.XInternalSession._readerCompressionController">
|
||||
<summary>
|
||||
Defines the compression controller that will be passed on the <see cref="T:MySqlX.Communication.XPacketReaderWriter"/> instance when
|
||||
compression is enabled.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySqlX.Sessions.XInternalSession._writerCompressionController">
|
||||
<summary>
|
||||
Defines the compression controller that will be passed on the <see cref="T:MySqlX.Communication.XPacketReaderWriter"/> instance when
|
||||
compression is enabled.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:MySqlX.Sessions.XInternalSession._sshHandler">
|
||||
<summary>
|
||||
The used client to handle SSH connections.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MySqlX.Sessions.XInternalSession.NegotiateCompression(System.String[])">
|
||||
<summary>
|
||||
Negotiates compression capabilities with the server.
|
||||
</summary>
|
||||
<param name="serverSupportedAlgorithms">An array containing the compression algorithms supported by the server.</param>
|
||||
</member>
|
||||
<member name="M:MySqlX.Sessions.XInternalSession.CreateCollection(System.String,System.String,MySql.Data.X.XDevAPI.Common.CreateCollectionOptions)">
|
||||
<summary>
|
||||
Prepare the dictionary of arguments required to create a MySQL message.
|
||||
</summary>
|
||||
<param name="schemaName">The name of the MySQL schema.</param>
|
||||
<param name="collectionName">The name of the collection.</param>
|
||||
<param name="options">This object hold the parameters required to create the collection.</param>
|
||||
<see cref="T:MySql.Data.X.XDevAPI.Common.CreateCollectionOptions"/>
|
||||
<returns>Collection referente.</returns>
|
||||
</member>
|
||||
<member name="M:MySqlX.Sessions.XInternalSession.ModifyCollection(System.String,System.String,System.Nullable{MySql.Data.X.XDevAPI.Common.ModifyCollectionOptions})">
|
||||
<summary>
|
||||
Prepare the dictionary of arguments required to Modify a MySQL message.
|
||||
</summary>
|
||||
<param name="schemaName">The name of the MySQL schema.</param>
|
||||
<param name="collectionName">The name of the collection.</param>
|
||||
<param name="options">This object hold the parameters required to Modify the collection.</param>
|
||||
<see cref="T:MySql.Data.X.XDevAPI.Common.ModifyCollectionOptions"/>
|
||||
<returns>Collection referente.</returns>
|
||||
</member>
|
||||
<member name="M:MySqlX.Sessions.XInternalSession.GetCompressionAlgorithm(System.Boolean)">
|
||||
<summary>
|
||||
Gets the compression algorithm being used to compress or decompress data.
|
||||
</summary>
|
||||
<param name="fromReaderController">Flag to indicate if the compression algorithm should be
|
||||
retrieved from the reader or writer controller.</param>
|
||||
<returns>The name of the compression algorithm being used if any.
|
||||
<c>null</c> if no compression algorithm is being used.</returns>
|
||||
</member>
|
||||
<member name="T:MySqlX.XDevAPI.BaseSession">
|
||||
<summary>
|
||||
Represents a base class for a Session.
|
||||
@@ -14288,6 +14727,22 @@
|
||||
Contains connection options specific to the X protocol.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MySqlX.XDevAPI.MySqlXConnectionStringBuilder.#ctor">
|
||||
<summary>
|
||||
Main constructor.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:MySqlX.XDevAPI.MySqlXConnectionStringBuilder.#ctor(System.String,System.Boolean)">
|
||||
<summary>
|
||||
Constructor accepting a connection string.
|
||||
</summary>
|
||||
<param name="connectionString">The connection string.</param>
|
||||
</member>
|
||||
<member name="F:MySqlX.XDevAPI.MySqlXConnectionStringBuilder.Options">
|
||||
<summary>
|
||||
Readonly field containing a collection of classic protocol and protocol shared connection options.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySqlX.XDevAPI.MySqlXConnectionStringBuilder.ConnectTimeout">
|
||||
<summary>
|
||||
Gets or sets the connection timeout.
|
||||
@@ -14303,6 +14758,17 @@
|
||||
Path to a local file containing certificate revocation lists.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySqlX.XDevAPI.MySqlXConnectionStringBuilder.Compression">
|
||||
<summary>
|
||||
Gets or sets the compression type between client and server.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:MySqlX.XDevAPI.MySqlXConnectionStringBuilder.Item(System.String)">
|
||||
<summary>
|
||||
Gets or sets a connection option.
|
||||
</summary>
|
||||
<param name="keyword">The keyword that identifies the connection option to modify.</param>
|
||||
</member>
|
||||
<member name="T:MySqlX.XDevAPI.Relational.Column">
|
||||
<summary>
|
||||
Represents a table column.
|
||||
@@ -14739,7 +15205,24 @@
|
||||
Creates a collection.
|
||||
</summary>
|
||||
<param name="collectionName">The name of the collection to create.</param>
|
||||
<param name="ReuseExistingObject">If false, it will throw an exception if collection exists.</param>
|
||||
<param name="ReuseExisting">If false, throws an exception if the collection exists.</param>
|
||||
<returns>Collection referente.</returns>
|
||||
</member>
|
||||
<member name="M:MySqlX.XDevAPI.Schema.CreateCollection(System.String,MySql.Data.X.XDevAPI.Common.CreateCollectionOptions)">
|
||||
<summary>
|
||||
Creates a collection including a schema validation.
|
||||
</summary>
|
||||
<param name="collectionName">The name of the collection to create.</param>
|
||||
<param name="options">This object hold the parameters required to create the collection.</param>
|
||||
<see cref="T:MySql.Data.X.XDevAPI.Common.CreateCollectionOptions"/>
|
||||
<returns>Collection referente.</returns>
|
||||
</member>
|
||||
<member name="M:MySqlX.XDevAPI.Schema.ModifyCollection(System.String,System.Nullable{MySql.Data.X.XDevAPI.Common.ModifyCollectionOptions})">
|
||||
<summary>
|
||||
Modify a collection adding or removing schema validation parameters.
|
||||
</summary>
|
||||
<param name="collectionName">The name of the collection to create.</param>
|
||||
<param name="options">This object encapsulate the Validation parameters level and schema. </param>
|
||||
<returns>Collection referente.</returns>
|
||||
</member>
|
||||
<member name="M:MySqlX.XDevAPI.Schema.DropCollection(System.String)">
|
||||
@@ -14787,13 +15270,13 @@
|
||||
</member>
|
||||
<member name="T:Mysqlx.ClientMessages">
|
||||
<summary>
|
||||
IDs of messages that can be sent from client to the server
|
||||
IDs of messages that can be sent from client to the server
|
||||
|
||||
.. note::
|
||||
this message is never sent on the wire. It is only used to let ``protoc``
|
||||
.. note::
|
||||
this message is never sent on the wire. It is only used to let ``protoc``
|
||||
|
||||
* generate constants
|
||||
* check for uniqueness
|
||||
* generate constants
|
||||
* check for uniqueness
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Mysqlx.ClientMessages.Types">
|
||||
@@ -14801,13 +15284,13 @@
|
||||
</member>
|
||||
<member name="T:Mysqlx.ServerMessages">
|
||||
<summary>
|
||||
IDs of messages that can be sent from server to client
|
||||
IDs of messages that can be sent from server to client
|
||||
|
||||
.. note::
|
||||
this message is never sent on the wire. It is only used to let ``protoc``
|
||||
.. note::
|
||||
this message is never sent on the wire. It is only used to let ``protoc``
|
||||
|
||||
* generate constants
|
||||
* check for uniqueness
|
||||
* generate constants
|
||||
* check for uniqueness
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Mysqlx.ServerMessages.Types">
|
||||
@@ -14815,12 +15298,12 @@
|
||||
</member>
|
||||
<member name="F:Mysqlx.ServerMessages.Types.Type.Notice">
|
||||
<summary>
|
||||
NOTICE has to stay at 11 forever
|
||||
NOTICE has to stay at 11 forever
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Mysqlx.Ok">
|
||||
<summary>
|
||||
generic Ok message
|
||||
generic Ok message
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Mysqlx.Ok.MsgFieldNumber">
|
||||
@@ -14828,19 +15311,19 @@
|
||||
</member>
|
||||
<member name="T:Mysqlx.Error">
|
||||
<summary>
|
||||
generic Error message
|
||||
generic Error message
|
||||
|
||||
A ``severity`` of ``ERROR`` indicates the current message sequence is
|
||||
aborted for the given error and the session is ready for more.
|
||||
A ``severity`` of ``ERROR`` indicates the current message sequence is
|
||||
aborted for the given error and the session is ready for more.
|
||||
|
||||
In case of a ``FATAL`` error message the client should not expect
|
||||
the server to continue handling any further messages and should
|
||||
close the connection.
|
||||
In case of a ``FATAL`` error message the client should not expect
|
||||
the server to continue handling any further messages and should
|
||||
close the connection.
|
||||
|
||||
:param severity: severity of the error message
|
||||
:param code: error-code
|
||||
:param sql_state: SQL state
|
||||
:param msg: human readable error message
|
||||
:param severity: severity of the error message
|
||||
:param code: error-code
|
||||
:param sql_state: SQL state
|
||||
:param msg: human readable error message
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Mysqlx.Error.SeverityFieldNumber">
|
||||
@@ -14874,19 +15357,9 @@
|
||||
<member name="F:Mysqlx.Connection.Capability.NameFieldNumber">
|
||||
<summary>Field number for the "name" field.</summary>
|
||||
</member>
|
||||
<member name="P:Mysqlx.Connection.Capability.Name">
|
||||
<summary>
|
||||
required
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Mysqlx.Connection.Capability.ValueFieldNumber">
|
||||
<summary>Field number for the "value" field.</summary>
|
||||
</member>
|
||||
<member name="P:Mysqlx.Connection.Capability.Value">
|
||||
<summary>
|
||||
required
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Mysqlx.Connection.Capabilities">
|
||||
<summary>
|
||||
Capabilities
|
||||
@@ -14916,11 +15389,6 @@
|
||||
<member name="F:Mysqlx.Connection.CapabilitiesSet.CapabilitiesFieldNumber">
|
||||
<summary>Field number for the "capabilities" field.</summary>
|
||||
</member>
|
||||
<member name="P:Mysqlx.Connection.CapabilitiesSet.Capabilities">
|
||||
<summary>
|
||||
required
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Mysqlx.Connection.Close">
|
||||
<summary>
|
||||
announce to the server that the client wants to close the connection
|
||||
@@ -14930,6 +15398,18 @@
|
||||
:Returns: :protobuf:msg:`Mysqlx::Ok`
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Mysqlx.Connection.Compression.UncompressedSizeFieldNumber">
|
||||
<summary>Field number for the "uncompressed_size" field.</summary>
|
||||
</member>
|
||||
<member name="F:Mysqlx.Connection.Compression.ServerMessagesFieldNumber">
|
||||
<summary>Field number for the "server_messages" field.</summary>
|
||||
</member>
|
||||
<member name="F:Mysqlx.Connection.Compression.ClientMessagesFieldNumber">
|
||||
<summary>Field number for the "client_messages" field.</summary>
|
||||
</member>
|
||||
<member name="F:Mysqlx.Connection.Compression.PayloadFieldNumber">
|
||||
<summary>Field number for the "payload" field.</summary>
|
||||
</member>
|
||||
<member name="T:Mysqlx.Crud.MysqlxCrudReflection">
|
||||
<summary>Holder for reflection information generated from mysqlx_crud.proto</summary>
|
||||
</member>
|
||||
BIN
Binary file not shown.
Binary file not shown.
Vendored
BIN
Binary file not shown.
Vendored
BIN
Binary file not shown.
Vendored
-2072
File diff suppressed because it is too large
Load Diff
Vendored
BIN
Binary file not shown.
Vendored
-2072
File diff suppressed because it is too large
Load Diff
BIN
Binary file not shown.
-2104
File diff suppressed because it is too large
Load Diff
BIN
Binary file not shown.
-2115
File diff suppressed because it is too large
Load Diff
BIN
Binary file not shown.
-2072
File diff suppressed because it is too large
Load Diff
BIN
Binary file not shown.
-2115
File diff suppressed because it is too large
Load Diff
Binary file not shown.
Binary file not shown.
|
Before Width: | Height: | Size: 1.3 KiB |
@@ -1,23 +0,0 @@
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) .NET Foundation and Contributors
|
||||
|
||||
All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
BIN
Binary file not shown.
@@ -1,375 +0,0 @@
|
||||
.NET Core uses third-party libraries or other resources that may be
|
||||
distributed under licenses different than the .NET Core software.
|
||||
|
||||
In the event that we accidentally failed to list a required notice, please
|
||||
bring it to our attention. Post an issue or email us:
|
||||
|
||||
dotnet@microsoft.com
|
||||
|
||||
The attached notices are provided for information only.
|
||||
|
||||
License notice for ASP.NET
|
||||
-------------------------------
|
||||
|
||||
Copyright (c) .NET Foundation. All rights reserved.
|
||||
Licensed under the Apache License, Version 2.0.
|
||||
|
||||
Available at
|
||||
https://github.com/aspnet/AspNetCore/blob/master/LICENSE.txt
|
||||
|
||||
License notice for Slicing-by-8
|
||||
-------------------------------
|
||||
|
||||
http://sourceforge.net/projects/slicing-by-8/
|
||||
|
||||
Copyright (c) 2004-2006 Intel Corporation - All Rights Reserved
|
||||
|
||||
|
||||
This software program is licensed subject to the BSD License, available at
|
||||
http://www.opensource.org/licenses/bsd-license.html.
|
||||
|
||||
|
||||
License notice for Unicode data
|
||||
-------------------------------
|
||||
|
||||
http://www.unicode.org/copyright.html#License
|
||||
|
||||
Copyright © 1991-2017 Unicode, Inc. All rights reserved.
|
||||
Distributed under the Terms of Use in http://www.unicode.org/copyright.html.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining
|
||||
a copy of the Unicode data files and any associated documentation
|
||||
(the "Data Files") or Unicode software and any associated documentation
|
||||
(the "Software") to deal in the Data Files or Software
|
||||
without restriction, including without limitation the rights to use,
|
||||
copy, modify, merge, publish, distribute, and/or sell copies of
|
||||
the Data Files or Software, and to permit persons to whom the Data Files
|
||||
or Software are furnished to do so, provided that either
|
||||
(a) this copyright and permission notice appear with all copies
|
||||
of the Data Files or Software, or
|
||||
(b) this copyright and permission notice appear in associated
|
||||
Documentation.
|
||||
|
||||
THE DATA FILES AND SOFTWARE ARE PROVIDED "AS IS", WITHOUT WARRANTY OF
|
||||
ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
|
||||
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||
NONINFRINGEMENT OF THIRD PARTY RIGHTS.
|
||||
IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS INCLUDED IN THIS
|
||||
NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL
|
||||
DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
|
||||
DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
|
||||
TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
||||
PERFORMANCE OF THE DATA FILES OR SOFTWARE.
|
||||
|
||||
Except as contained in this notice, the name of a copyright holder
|
||||
shall not be used in advertising or otherwise to promote the sale,
|
||||
use or other dealings in these Data Files or Software without prior
|
||||
written authorization of the copyright holder.
|
||||
|
||||
License notice for Zlib
|
||||
-----------------------
|
||||
|
||||
https://github.com/madler/zlib
|
||||
http://zlib.net/zlib_license.html
|
||||
|
||||
/* zlib.h -- interface of the 'zlib' general purpose compression library
|
||||
version 1.2.11, January 15th, 2017
|
||||
|
||||
Copyright (C) 1995-2017 Jean-loup Gailly and Mark Adler
|
||||
|
||||
This software is provided 'as-is', without any express or implied
|
||||
warranty. In no event will the authors be held liable for any damages
|
||||
arising from the use of this software.
|
||||
|
||||
Permission is granted to anyone to use this software for any purpose,
|
||||
including commercial applications, and to alter it and redistribute it
|
||||
freely, subject to the following restrictions:
|
||||
|
||||
1. The origin of this software must not be misrepresented; you must not
|
||||
claim that you wrote the original software. If you use this software
|
||||
in a product, an acknowledgment in the product documentation would be
|
||||
appreciated but is not required.
|
||||
2. Altered source versions must be plainly marked as such, and must not be
|
||||
misrepresented as being the original software.
|
||||
3. This notice may not be removed or altered from any source distribution.
|
||||
|
||||
Jean-loup Gailly Mark Adler
|
||||
jloup@gzip.org madler@alumni.caltech.edu
|
||||
|
||||
*/
|
||||
|
||||
License notice for Mono
|
||||
-------------------------------
|
||||
|
||||
http://www.mono-project.com/docs/about-mono/
|
||||
|
||||
Copyright (c) .NET Foundation Contributors
|
||||
|
||||
MIT License
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the Software), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
||||
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
||||
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
||||
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
License notice for International Organization for Standardization
|
||||
-----------------------------------------------------------------
|
||||
|
||||
Portions (C) International Organization for Standardization 1986:
|
||||
Permission to copy in any form is granted for use with
|
||||
conforming SGML systems and applications as defined in
|
||||
ISO 8879, provided this notice is included in all copies.
|
||||
|
||||
License notice for Intel
|
||||
------------------------
|
||||
|
||||
"Copyright (c) 2004-2006 Intel Corporation - All Rights Reserved
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are met:
|
||||
|
||||
1. Redistributions of source code must retain the above copyright notice, this
|
||||
list of conditions and the following disclaimer.
|
||||
|
||||
2. Redistributions in binary form must reproduce the above copyright notice,
|
||||
this list of conditions and the following disclaimer in the documentation
|
||||
and/or other materials provided with the distribution.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
||||
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||||
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||||
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||||
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
License notice for Xamarin and Novell
|
||||
-------------------------------------
|
||||
|
||||
Copyright (c) 2015 Xamarin, Inc (http://www.xamarin.com)
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
|
||||
Copyright (c) 2011 Novell, Inc (http://www.novell.com)
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
|
||||
Third party notice for W3C
|
||||
--------------------------
|
||||
|
||||
"W3C SOFTWARE AND DOCUMENT NOTICE AND LICENSE
|
||||
Status: This license takes effect 13 May, 2015.
|
||||
This work is being provided by the copyright holders under the following license.
|
||||
License
|
||||
By obtaining and/or copying this work, you (the licensee) agree that you have read, understood, and will comply with the following terms and conditions.
|
||||
Permission to copy, modify, and distribute this work, with or without modification, for any purpose and without fee or royalty is hereby granted, provided that you include the following on ALL copies of the work or portions thereof, including modifications:
|
||||
The full text of this NOTICE in a location viewable to users of the redistributed or derivative work.
|
||||
Any pre-existing intellectual property disclaimers, notices, or terms and conditions. If none exist, the W3C Software and Document Short Notice should be included.
|
||||
Notice of any changes or modifications, through a copyright statement on the new code or document such as "This software or document includes material copied from or derived from [title and URI of the W3C document]. Copyright © [YEAR] W3C® (MIT, ERCIM, Keio, Beihang)."
|
||||
Disclaimers
|
||||
THIS WORK IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF THE SOFTWARE OR DOCUMENT WILL NOT INFRINGE ANY THIRD PARTY PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.
|
||||
COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENT.
|
||||
The name and trademarks of copyright holders may NOT be used in advertising or publicity pertaining to the work without specific, written prior permission. Title to copyright in this work will at all times remain with copyright holders."
|
||||
|
||||
License notice for Bit Twiddling Hacks
|
||||
--------------------------------------
|
||||
|
||||
Bit Twiddling Hacks
|
||||
|
||||
By Sean Eron Anderson
|
||||
seander@cs.stanford.edu
|
||||
|
||||
Individually, the code snippets here are in the public domain (unless otherwise
|
||||
noted) — feel free to use them however you please. The aggregate collection and
|
||||
descriptions are © 1997-2005 Sean Eron Anderson. The code and descriptions are
|
||||
distributed in the hope that they will be useful, but WITHOUT ANY WARRANTY and
|
||||
without even the implied warranty of merchantability or fitness for a particular
|
||||
purpose.
|
||||
|
||||
License notice for Brotli
|
||||
--------------------------------------
|
||||
|
||||
Copyright (c) 2009, 2010, 2013-2016 by the Brotli Authors.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
|
||||
compress_fragment.c:
|
||||
Copyright (c) 2011, Google Inc.
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are
|
||||
met:
|
||||
|
||||
* Redistributions of source code must retain the above copyright
|
||||
notice, this list of conditions and the following disclaimer.
|
||||
* Redistributions in binary form must reproduce the above
|
||||
copyright notice, this list of conditions and the following disclaimer
|
||||
in the documentation and/or other materials provided with the
|
||||
distribution.
|
||||
* Neither the name of Google Inc. nor the names of its
|
||||
contributors may be used to endorse or promote products derived from
|
||||
this software without specific prior written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
""AS IS"" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
decode_fuzzer.c:
|
||||
Copyright (c) 2015 The Chromium Authors. All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are
|
||||
met:
|
||||
|
||||
* Redistributions of source code must retain the above copyright
|
||||
notice, this list of conditions and the following disclaimer.
|
||||
* Redistributions in binary form must reproduce the above
|
||||
copyright notice, this list of conditions and the following disclaimer
|
||||
in the documentation and/or other materials provided with the
|
||||
distribution.
|
||||
* Neither the name of Google Inc. nor the names of its
|
||||
contributors may be used to endorse or promote products derived from
|
||||
this software without specific prior written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
""AS IS"" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
|
||||
|
||||
License notice for Json.NET
|
||||
-------------------------------
|
||||
|
||||
https://github.com/JamesNK/Newtonsoft.Json/blob/master/LICENSE.md
|
||||
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2007 James Newton-King
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
this software and associated documentation files (the "Software"), to deal in
|
||||
the Software without restriction, including without limitation the rights to
|
||||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
||||
the Software, and to permit persons to whom the Software is furnished to do so,
|
||||
subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
||||
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
||||
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
||||
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
License notice for vectorized base64 encoding / decoding
|
||||
--------------------------------------------------------
|
||||
|
||||
Copyright (c) 2005-2007, Nick Galbreath
|
||||
Copyright (c) 2013-2017, Alfred Klomp
|
||||
Copyright (c) 2015-2017, Wojciech Mula
|
||||
Copyright (c) 2016-2017, Matthieu Darbois
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are
|
||||
met:
|
||||
|
||||
- Redistributions of source code must retain the above copyright notice,
|
||||
this list of conditions and the following disclaimer.
|
||||
|
||||
- Redistributions in binary form must reproduce the above copyright
|
||||
notice, this list of conditions and the following disclaimer in the
|
||||
documentation and/or other materials provided with the distribution.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
|
||||
IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
|
||||
TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
|
||||
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
|
||||
TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
|
||||
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
|
||||
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
|
||||
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
||||
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
BIN
Binary file not shown.
-318
@@ -1,318 +0,0 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>System.IO.Pipelines</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:System.IO.Pipelines.FlushResult">
|
||||
<summary>Result returned by <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> call.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.FlushResult.#ctor(System.Boolean,System.Boolean)">
|
||||
<summary>Creates a new instance of <see cref="T:System.IO.Pipelines.FlushResult" /> setting <see cref="P:System.IO.Pipelines.FlushResult.IsCanceled" /> and <see cref="P:System.IO.Pipelines.FlushResult.IsCompleted" /> flags.</summary>
|
||||
<param name="isCanceled" />
|
||||
<param name="isCompleted" />
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.FlushResult.IsCanceled">
|
||||
<summary>
|
||||
<see langword="true" /> if the current <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> operation was canceled; otherwise, <see langword="false" />.</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.FlushResult.IsCompleted">
|
||||
<summary>
|
||||
<see langword="true" /> if the <see cref="T:System.IO.Pipelines.PipeWriter" /> is complete; otherwise, <see langword="false" />.</summary>
|
||||
</member>
|
||||
<member name="T:System.IO.Pipelines.IDuplexPipe">
|
||||
<summary>Defines a class that provides a duplex pipe from which data can be read from and written to.</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.IDuplexPipe.Input">
|
||||
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeReader" /> half of the duplex pipe.</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.IDuplexPipe.Output">
|
||||
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeWriter" /> half of the duplex pipe.</summary>
|
||||
</member>
|
||||
<member name="T:System.IO.Pipelines.Pipe">
|
||||
<summary>Default <see cref="T:System.IO.Pipelines.PipeWriter" /> and <see cref="T:System.IO.Pipelines.PipeReader" /> implementation.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.Pipe.#ctor">
|
||||
<summary>Initializes the <see cref="T:System.IO.Pipelines.Pipe" /> using <see cref="P:System.IO.Pipelines.PipeOptions.Default" /> as options.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.Pipe.#ctor(System.IO.Pipelines.PipeOptions)">
|
||||
<summary>Initializes the <see cref="T:System.IO.Pipelines.Pipe" /> with the specified <see cref="T:System.IO.Pipelines.PipeOptions" />.</summary>
|
||||
<param name="options" />
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.Pipe.Reader">
|
||||
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeReader" /> for this pipe.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.Pipe.Reset">
|
||||
<summary>Resets the pipe.</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.Pipe.Writer">
|
||||
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeWriter" /> for this pipe.</summary>
|
||||
</member>
|
||||
<member name="T:System.IO.Pipelines.PipeOptions">
|
||||
<summary>Represents a set of <see cref="T:System.IO.Pipelines.Pipe" /> options.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeOptions.#ctor(System.Buffers.MemoryPool{System.Byte},System.IO.Pipelines.PipeScheduler,System.IO.Pipelines.PipeScheduler,System.Int64,System.Int64,System.Int32,System.Boolean)">
|
||||
<summary>Creates a new instance of <see cref="T:System.IO.Pipelines.PipeOptions" />.</summary>
|
||||
<param name="pool" />
|
||||
<param name="readerScheduler" />
|
||||
<param name="writerScheduler" />
|
||||
<param name="pauseWriterThreshold" />
|
||||
<param name="resumeWriterThreshold" />
|
||||
<param name="minimumSegmentSize" />
|
||||
<param name="useSynchronizationContext" />
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.PipeOptions.Default">
|
||||
<summary>Gets the default instance of <see cref="T:System.IO.Pipelines.PipeOptions" />.</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.PipeOptions.MinimumSegmentSize">
|
||||
<summary>Gets the minimum size of the segment requested from <see cref="P:System.IO.Pipelines.PipeOptions.Pool" />.</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.PipeOptions.PauseWriterThreshold">
|
||||
<summary>Gets the amount of bytes in <see cref="T:System.IO.Pipelines.Pipe" /> when <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> starts blocking.</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.PipeOptions.Pool">
|
||||
<summary>Gets the <see cref="T:System.Buffers.MemoryPool`1" /> instances used for buffer management.</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.PipeOptions.ReaderScheduler">
|
||||
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeScheduler" /> used to execute <see cref="T:System.IO.Pipelines.PipeReader" /> callbacks.</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.PipeOptions.ResumeWriterThreshold">
|
||||
<summary>Gets amount of bytes in <see cref="T:System.IO.Pipelines.Pipe" /> when <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> stops blocking.</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.PipeOptions.UseSynchronizationContext">
|
||||
<summary>Gets a value that determines if asynchronous callbacks should be executed on the <see cref="T:System.Threading.SynchronizationContext" /> they were captured on. This takes precedence over the schedulers specified in <see cref="P:System.IO.Pipelines.PipeOptions.ReaderScheduler" /> and <see cref="P:System.IO.Pipelines.PipeOptions.WriterScheduler" />.</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.PipeOptions.WriterScheduler">
|
||||
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeScheduler" /> used to execute <see cref="T:System.IO.Pipelines.PipeWriter" /> callbacks.</summary>
|
||||
</member>
|
||||
<member name="T:System.IO.Pipelines.PipeReader">
|
||||
<summary>Defines a class that provides access to a read side of pipe.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.#ctor">
|
||||
<summary>Initializes a new instance of the <see cref="T:System.IO.Pipelines.PipeReader" /> class.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.AdvanceTo(System.SequencePosition)">
|
||||
<summary>Moves forward the pipeline's read cursor to after the consumed data.</summary>
|
||||
<param name="consumed">Marks the extent of the data that has been successfully processed.</param>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.AdvanceTo(System.SequencePosition,System.SequencePosition)">
|
||||
<summary>Moves forward the pipeline's read cursor to after the consumed data.</summary>
|
||||
<param name="consumed">Marks the extent of the data that has been successfully processed.</param>
|
||||
<param name="examined">Marks the extent of the data that has been read and examined.</param>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.AsStream(System.Boolean)">
|
||||
<summary>Returns the underlying <see cref="T:System.IO.Stream" /> wrapped by the <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
|
||||
<param name="leaveOpen">An optional flag that indicates whether disposing the returned <see cref="T:System.IO.Stream" /> leaves <see cref="T:System.IO.Pipelines.PipeReader" /> open (<see langword="true" />) or completes <see cref="T:System.IO.Pipelines.PipeReader" /> (<see langword="false" />).</param>
|
||||
<returns>The underlying stream.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.CancelPendingRead">
|
||||
<summary>Cancels to currently pending or if none is pending next call to <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" />, without completing the <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.Complete(System.Exception)">
|
||||
<summary>Signals to the producer that the consumer is done reading.</summary>
|
||||
<param name="exception">Optional <see cref="T:System.Exception" /> indicating a failure that's causing the pipeline to complete.</param>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.CompleteAsync(System.Exception)">
|
||||
<summary>Marks the current pipe reader instance as being complete, meaning no more data will be read from it.</summary>
|
||||
<param name="exception">An optional exception that indicates the failure that caused the reader to complete.</param>
|
||||
<returns>A value task that represents the asynchronous complete operation.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.CopyToAsync(System.IO.Pipelines.PipeWriter,System.Threading.CancellationToken)">
|
||||
<summary>Asynchronously reads the bytes from the <see cref="T:System.IO.Pipelines.PipeReader" /> and writes them to the specified <see cref="T:System.IO.Pipelines.PipeWriter" />, using a specified buffer size and cancellation token.</summary>
|
||||
<param name="destination">The pipe writer to which the contents of the current stream will be copied.</param>
|
||||
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
|
||||
<returns>A task that represents the asynchronous copy operation.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.CopyToAsync(System.IO.Stream,System.Threading.CancellationToken)">
|
||||
<summary>Asynchronously reads the bytes from the <see cref="T:System.IO.Pipelines.PipeReader" /> and writes them to the specified stream, using a specified cancellation token.</summary>
|
||||
<param name="destination">The stream to which the contents of the current stream will be copied.</param>
|
||||
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
|
||||
<returns>A task that represents the asynchronous copy operation.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.Create(System.IO.Stream,System.IO.Pipelines.StreamPipeReaderOptions)">
|
||||
<summary>Creates a <see cref="T:System.IO.Pipelines.PipeReader" /> wrapping the specified <see cref="T:System.IO.Stream" />.</summary>
|
||||
<param name="stream">The stream that the pipe reader will wrap.</param>
|
||||
<param name="readerOptions">The options to configure the pipe reader.</param>
|
||||
<returns>A <see cref="T:System.IO.Pipelines.PipeReader" /> that wraps the <see cref="T:System.IO.Stream" />.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.OnWriterCompleted(System.Action{System.Exception,System.Object},System.Object)">
|
||||
<summary>Registers a callback that executes when the <see cref="T:System.IO.Pipelines.PipeWriter" /> side of the pipe is completed.</summary>
|
||||
<param name="callback">The callback to register.</param>
|
||||
<param name="state">The state object to pass to <paramref name="callback" /> when it's invoked.</param>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)">
|
||||
<summary>Asynchronously reads a sequence of bytes from the current <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
|
||||
<param name="cancellationToken" />
|
||||
<returns>A <see cref="T:System.Threading.Tasks.ValueTask`1" /> representing the asynchronous read operation.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.TryRead(System.IO.Pipelines.ReadResult@)">
|
||||
<summary>Attempts to synchronously read data the <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
|
||||
<param name="result">The <see cref="T:System.IO.Pipelines.ReadResult" /></param>
|
||||
<returns>
|
||||
<see langword="true" /> if data was available, or if the call was canceled or the writer was completed; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="T:System.IO.Pipelines.PipeScheduler">
|
||||
<summary>Abstraction for running <see cref="T:System.IO.Pipelines.PipeReader" /> and <see cref="T:System.IO.Pipelines.PipeWriter" /> callbacks and continuations.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeScheduler.#ctor" />
|
||||
<member name="P:System.IO.Pipelines.PipeScheduler.Inline">
|
||||
<summary>The <see cref="T:System.IO.Pipelines.PipeScheduler" /> implementation that runs callbacks inline.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeScheduler.Schedule(System.Action{System.Object},System.Object)">
|
||||
<summary>Requests <paramref name="action" /> to be run on scheduler with <paramref name="state" /> being passed in.</summary>
|
||||
<param name="action" />
|
||||
<param name="state" />
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.PipeScheduler.ThreadPool">
|
||||
<summary>The <see cref="T:System.IO.Pipelines.PipeScheduler" /> implementation that queues callbacks to thread pool.</summary>
|
||||
</member>
|
||||
<member name="T:System.IO.Pipelines.PipeWriter">
|
||||
<summary>Defines a class that provides a pipeline to which data can be written.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.#ctor">
|
||||
<summary>Initializes a new instance of the class.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.Advance(System.Int32)">
|
||||
<summary>Notifies the <see cref="T:System.IO.Pipelines.PipeWriter" /> that <paramref name="bytes" /> bytes were written to the output <see cref="T:System.Span`1" /> or <see cref="T:System.Memory`1" />. You must request a new buffer after calling <see cref="M:System.IO.Pipelines.PipeWriter.Advance(System.Int32)" /> to continue writing more data; you cannot write to a previously acquired buffer.</summary>
|
||||
<param name="bytes">The number of bytes written to the <see cref="T:System.Span`1" /> or <see cref="T:System.Memory`1" />.</param>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.AsStream(System.Boolean)">
|
||||
<summary>Returns the underlying <see cref="T:System.IO.Stream" /> wrapped by the <see cref="T:System.IO.Pipelines.PipeWriter" />.</summary>
|
||||
<param name="leaveOpen">An optional flag that indicates whether disposing the returned <see cref="T:System.IO.Stream" /> leaves <see cref="T:System.IO.Pipelines.PipeReader" /> open (<see langword="true" />) or completes <see cref="T:System.IO.Pipelines.PipeReader" /> (<see langword="false" />).</param>
|
||||
<returns>The underlying stream.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.CancelPendingFlush">
|
||||
<summary>Cancels the pending <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> operation. If there is none, cancels next <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> operation, without completing the <see cref="T:System.IO.Pipelines.PipeWriter" />.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.Complete(System.Exception)">
|
||||
<summary>Marks the <see cref="T:System.IO.Pipelines.PipeWriter" /> as being complete, meaning no more items will be written to it.</summary>
|
||||
<param name="exception">Optional <see cref="T:System.Exception" /> indicating a failure that's causing the pipeline to complete.</param>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.CompleteAsync(System.Exception)">
|
||||
<summary>Marks the current pipe writer instance as being complete, meaning no more data will be written to it.</summary>
|
||||
<param name="exception">An optional exception that indicates the failure that caused the pipeline to complete.</param>
|
||||
<returns>A value task that represents the asynchronous complete operation.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.CopyFromAsync(System.IO.Stream,System.Threading.CancellationToken)">
|
||||
<summary>Asynchronously reads the bytes from the specified stream and writes them to the <see cref="T:System.IO.Pipelines.PipeWriter" />.</summary>
|
||||
<param name="source">The stream from which the contents will be copied.</param>
|
||||
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
|
||||
<returns>A task that represents the asynchronous copy operation.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.Create(System.IO.Stream,System.IO.Pipelines.StreamPipeWriterOptions)">
|
||||
<summary>Creates a <see cref="T:System.IO.Pipelines.PipeWriter" /> wrapping the specified <see cref="T:System.IO.Stream" />.</summary>
|
||||
<param name="stream">The stream that the pipe writer will wrap.</param>
|
||||
<param name="writerOptions">The options to configure the pipe writer.</param>
|
||||
<returns>A <see cref="T:System.IO.Pipelines.PipeWriter" /> that wraps the <see cref="T:System.IO.Stream" />.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)">
|
||||
<summary>Makes bytes written available to <see cref="T:System.IO.Pipelines.PipeReader" /> and runs <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> continuation.</summary>
|
||||
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
|
||||
<returns>A task that represents and wraps the asynchronous flush operation.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.GetMemory(System.Int32)">
|
||||
<summary>Returns a <see cref="T:System.Memory`1" /> to write to that is at least the requested size, as specified by the <paramref name="sizeHint" /> parameter.</summary>
|
||||
<param name="sizeHint">The minimum length of the returned <see cref="T:System.Memory`1" />. If 0, a non-empty memory buffer of arbitrary size is returned.</param>
|
||||
<returns>A memory buffer of at least <paramref name="sizeHint" /> bytes. If <paramref name="sizeHint" /> is 0, returns a non-empty buffer of arbitrary size.</returns>
|
||||
<exception cref="T:System.OutOfMemoryException">The requested buffer size is not available.</exception>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.GetSpan(System.Int32)">
|
||||
<summary>Returns a <see cref="T:System.Span`1" /> to write to that is at least the requested size, as specified by the <paramref name="sizeHint" /> parameter.</summary>
|
||||
<param name="sizeHint">The minimum length of the returned <see cref="T:System.Span`1" />. If 0, a non-empty buffer of arbitrary size is returned.</param>
|
||||
<returns>A buffer of at least <paramref name="sizeHint" /> bytes. If <paramref name="sizeHint" /> is 0, returns a non-empty buffer of arbitrary size.</returns>
|
||||
<exception cref="T:System.OutOfMemoryException">The requested buffer size is not available.</exception>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.OnReaderCompleted(System.Action{System.Exception,System.Object},System.Object)">
|
||||
<summary>Registers a callback that executes when the <see cref="T:System.IO.Pipelines.PipeReader" /> side of the pipe is completed.</summary>
|
||||
<param name="callback">The callback to register.</param>
|
||||
<param name="state">The state object to pass to <paramref name="callback" /> when it's invoked.</param>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.WriteAsync(System.ReadOnlyMemory{System.Byte},System.Threading.CancellationToken)">
|
||||
<summary>Writes the specified byte memory range to the pipe and makes data accessible to the <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
|
||||
<param name="source">The read-only byte memory region to write.</param>
|
||||
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
|
||||
<returns>A task that represents the asynchronous write operation, and wraps the flush asynchronous operation.</returns>
|
||||
</member>
|
||||
<member name="T:System.IO.Pipelines.ReadResult">
|
||||
<summary>The result of a <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> call.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.ReadResult.#ctor(System.Buffers.ReadOnlySequence{System.Byte},System.Boolean,System.Boolean)">
|
||||
<summary>Creates a new instance of <see cref="T:System.IO.Pipelines.ReadResult" /> setting <see cref="P:System.IO.Pipelines.ReadResult.IsCanceled" /> and <see cref="P:System.IO.Pipelines.ReadResult.IsCompleted" /> flags.</summary>
|
||||
<param name="buffer" />
|
||||
<param name="isCanceled" />
|
||||
<param name="isCompleted" />
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.ReadResult.Buffer">
|
||||
<summary>Gets the <see cref="T:System.Buffers.ReadOnlySequence`1" /> that was read.</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.ReadResult.IsCanceled">
|
||||
<summary>
|
||||
<see langword="true" /> if the current <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> operation was canceled; otherwise, <see langword="false" />.</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.ReadResult.IsCompleted">
|
||||
<summary>
|
||||
<see langword="true" /> if the <see cref="T:System.IO.Pipelines.PipeReader" /> is complete; otherwise, <see langword="false" />.</summary>
|
||||
</member>
|
||||
<member name="T:System.IO.Pipelines.StreamPipeExtensions">
|
||||
<summary>Provides extension methods for <see cref="T:System.IO.Stream" /> that support read and write operations directly into pipes.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.StreamPipeExtensions.CopyToAsync(System.IO.Stream,System.IO.Pipelines.PipeWriter,System.Threading.CancellationToken)">
|
||||
<summary>Asynchronously reads the bytes from the <see cref="T:System.IO.Stream" /> and writes them to the specified <see cref="T:System.IO.Pipelines.PipeWriter" />, using a cancellation token.</summary>
|
||||
<param name="source">The stream from which the contents of the current stream will be copied.</param>
|
||||
<param name="destination">The writer to which the contents of the source stream will be copied.</param>
|
||||
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
|
||||
<returns>A task that represents the asynchronous copy operation.</returns>
|
||||
</member>
|
||||
<member name="T:System.IO.Pipelines.StreamPipeReaderOptions">
|
||||
<summary>Represents a set of options for controlling the creation of the <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.StreamPipeReaderOptions.#ctor(System.Buffers.MemoryPool{System.Byte},System.Int32,System.Int32,System.Boolean)">
|
||||
<summary>Initializes a <see cref="T:System.IO.Pipelines.StreamPipeReaderOptions" /> instance, optionally specifying a memory pool, a minimum buffer size, a minimum read size, and whether the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeReader" /> completes.</summary>
|
||||
<param name="pool">The memory pool to use when allocating memory. The default value is <see langword="null" />.</param>
|
||||
<param name="bufferSize">The minimum buffer size to use when renting memory from the <paramref name="pool" />. The default value is 4096.</param>
|
||||
<param name="minimumReadSize">The threshold of remaining bytes in the buffer before a new buffer is allocated. The default value is 1024.</param>
|
||||
<param name="leaveOpen">
|
||||
<see langword="true" /> to leave the underlying stream open after the <see cref="T:System.IO.Pipelines.PipeReader" /> completes; <see langword="false" /> to close it. The default is <see langword="false" />.</param>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.StreamPipeReaderOptions.BufferSize">
|
||||
<summary>Gets the minimum buffer size to use when renting memory from the <see cref="P:System.IO.Pipelines.StreamPipeReaderOptions.Pool" />.</summary>
|
||||
<returns>The buffer size.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.StreamPipeReaderOptions.LeaveOpen">
|
||||
<summary>Gets the value that indicates if the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeReader" /> completes.</summary>
|
||||
<returns>
|
||||
<see langword="true" /> if the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeReader" /> completes; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.StreamPipeReaderOptions.MinimumReadSize">
|
||||
<summary>Gets the threshold of remaining bytes in the buffer before a new buffer is allocated.</summary>
|
||||
<returns>The minimum read size.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.StreamPipeReaderOptions.Pool">
|
||||
<summary>Gets the <see cref="T:System.Buffers.MemoryPool`1" /> to use when allocating memory.</summary>
|
||||
<returns>A memory pool instance.</returns>
|
||||
</member>
|
||||
<member name="T:System.IO.Pipelines.StreamPipeWriterOptions">
|
||||
<summary>Represents a set of options for controlling the creation of the <see cref="T:System.IO.Pipelines.PipeWriter" />.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.StreamPipeWriterOptions.#ctor(System.Buffers.MemoryPool{System.Byte},System.Int32,System.Boolean)">
|
||||
<summary>Initializes a <see cref="T:System.IO.Pipelines.StreamPipeWriterOptions" /> instance, optionally specifying a memory pool, a minimum buffer size, and whether the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeWriter" /> completes.</summary>
|
||||
<param name="pool">The memory pool to use when allocating memory. The default value is <see langword="null" />.</param>
|
||||
<param name="minimumBufferSize">The minimum buffer size to use when renting memory from the <paramref name="pool" />. The default value is 4096.</param>
|
||||
<param name="leaveOpen">
|
||||
<see langword="true" /> to leave the underlying stream open after the <see cref="T:System.IO.Pipelines.PipeWriter" /> completes; <see langword="false" /> to close it. The default is <see langword="false" />.</param>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.StreamPipeWriterOptions.LeaveOpen">
|
||||
<summary>Gets the value that indicates if the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeWriter" /> completes.</summary>
|
||||
<returns>
|
||||
<see langword="true" /> if the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeWriter" /> completes; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.StreamPipeWriterOptions.MinimumBufferSize">
|
||||
<summary>Gets the minimum buffer size to use when renting memory from the <see cref="P:System.IO.Pipelines.StreamPipeWriterOptions.Pool" />.</summary>
|
||||
<returns>An integer representing the minimum buffer size.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.StreamPipeWriterOptions.Pool">
|
||||
<summary>Gets the <see cref="T:System.Buffers.MemoryPool`1" /> to use when allocating memory.</summary>
|
||||
<returns>A memory pool instance.</returns>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
BIN
Binary file not shown.
-304
@@ -1,304 +0,0 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>System.IO.Pipelines</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="P:System.IO.Pipelines.BufferSegment.Start">
|
||||
<summary>
|
||||
The Start represents the offset into AvailableMemory where the range of "active" bytes begins. At the point when the block is leased
|
||||
the Start is guaranteed to be equal to 0. The value of Start may be assigned anywhere between 0 and
|
||||
AvailableMemory.Length, and must be equal to or less than End.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.BufferSegment.End">
|
||||
<summary>
|
||||
The End represents the offset into AvailableMemory where the range of "active" bytes ends. At the point when the block is leased
|
||||
the End is guaranteed to be equal to Start. The value of Start may be assigned anywhere between 0 and
|
||||
Buffer.Length, and must be equal to or less than End.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.BufferSegment.NextSegment">
|
||||
<summary>
|
||||
Reference to the next block of data when the overall "active" bytes spans multiple blocks. At the point when the block is
|
||||
leased Next is guaranteed to be null. Start, End, and Next are used together in order to create a linked-list of discontiguous
|
||||
working memory. The "active" memory is grown when bytes are copied in, End is increased, and Next is assigned. The "active"
|
||||
memory is shrunk when bytes are consumed, Start is increased, and blocks are returned to the pool.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.BufferSegment.ReadOnly">
|
||||
<summary>
|
||||
If true, data should not be written into the backing block after the End offset. Data between start and end should never be modified
|
||||
since this would break cloning.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.BufferSegment.WritableBytes">
|
||||
<summary>
|
||||
The amount of writable bytes in this segment. It is the amount of bytes between Length and End
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.IO.Pipelines.FlushResult">
|
||||
<summary>
|
||||
Result returned by <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)"/> call
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.FlushResult.#ctor(System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
Creates a new instance of <see cref="T:System.IO.Pipelines.FlushResult"/> setting <see cref="P:System.IO.Pipelines.FlushResult.IsCanceled"/> and <see cref="P:System.IO.Pipelines.FlushResult.IsCompleted"/> flags
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.FlushResult.IsCanceled">
|
||||
<summary>
|
||||
True if the current <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)"/> operation was canceled, otherwise false.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.FlushResult.IsCompleted">
|
||||
<summary>
|
||||
True if the <see cref="T:System.IO.Pipelines.PipeWriter"/> is complete otherwise false
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.IO.Pipelines.IDuplexPipe">
|
||||
<summary>
|
||||
Defines a class that provides a duplex pipe from which data can be read from and written to.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.IDuplexPipe.Input">
|
||||
<summary>
|
||||
Gets the <see cref="T:System.IO.Pipelines.PipeReader"/> half of the duplex pipe.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.IDuplexPipe.Output">
|
||||
<summary>
|
||||
Gets the <see cref="T:System.IO.Pipelines.PipeWriter"/> half of the duplex pipe.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.IO.Pipelines.Pipe">
|
||||
<summary>
|
||||
Default <see cref="T:System.IO.Pipelines.PipeWriter"/> and <see cref="T:System.IO.Pipelines.PipeReader"/> implementation.
|
||||
</summary>
|
||||
<summary>
|
||||
Default <see cref="T:System.IO.Pipelines.PipeWriter"/> and <see cref="T:System.IO.Pipelines.PipeReader"/> implementation.
|
||||
</summary>
|
||||
<summary>
|
||||
Default <see cref="T:System.IO.Pipelines.PipeWriter"/> and <see cref="T:System.IO.Pipelines.PipeReader"/> implementation.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.Pipe.#ctor">
|
||||
<summary>
|
||||
Initializes the <see cref="T:System.IO.Pipelines.Pipe"/> using <see cref="P:System.IO.Pipelines.PipeOptions.Default"/> as options.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.Pipe.#ctor(System.IO.Pipelines.PipeOptions)">
|
||||
<summary>
|
||||
Initializes the <see cref="T:System.IO.Pipelines.Pipe"/> with the specified <see cref="T:System.IO.Pipelines.PipeOptions"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.Pipe.Reader">
|
||||
<summary>
|
||||
Gets the <see cref="T:System.IO.Pipelines.PipeReader"/> for this pipe.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.Pipe.Writer">
|
||||
<summary>
|
||||
Gets the <see cref="T:System.IO.Pipelines.PipeWriter"/> for this pipe.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.Pipe.Reset">
|
||||
<summary>
|
||||
Resets the pipe
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.IO.Pipelines.PipeOptions">
|
||||
<summary>
|
||||
Represents a set of <see cref="T:System.IO.Pipelines.Pipe"/> options
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.PipeOptions.Default">
|
||||
<summary>
|
||||
Default instance of <see cref="T:System.IO.Pipelines.PipeOptions"/>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeOptions.#ctor(System.Buffers.MemoryPool{System.Byte},System.IO.Pipelines.PipeScheduler,System.IO.Pipelines.PipeScheduler,System.Int64,System.Int64,System.Int32,System.Boolean)">
|
||||
<summary>
|
||||
Creates a new instance of <see cref="T:System.IO.Pipelines.PipeOptions"/>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.PipeOptions.UseSynchronizationContext">
|
||||
<summary>
|
||||
Gets a value that determines if asynchronous callbacks should be executed on the <see cref="T:System.Threading.SynchronizationContext" /> they were captured on.
|
||||
This takes precedence over the schedulers specified in <see cref="P:System.IO.Pipelines.PipeOptions.ReaderScheduler"/> and <see cref="P:System.IO.Pipelines.PipeOptions.WriterScheduler"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.PipeOptions.PauseWriterThreshold">
|
||||
<summary>
|
||||
Gets amount of bytes in <see cref="T:System.IO.Pipelines.Pipe"/> when <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)"/> starts blocking
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.PipeOptions.ResumeWriterThreshold">
|
||||
<summary>
|
||||
Gets amount of bytes in <see cref="T:System.IO.Pipelines.Pipe"/> when <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)"/> stops blocking
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.PipeOptions.MinimumSegmentSize">
|
||||
<summary>
|
||||
Gets minimum size of segment requested from <see cref="P:System.IO.Pipelines.PipeOptions.Pool"/>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.PipeOptions.WriterScheduler">
|
||||
<summary>
|
||||
Gets the <see cref="T:System.IO.Pipelines.PipeScheduler"/> used to execute <see cref="T:System.IO.Pipelines.PipeWriter"/> callbacks
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.PipeOptions.ReaderScheduler">
|
||||
<summary>
|
||||
Gets the <see cref="T:System.IO.Pipelines.PipeScheduler"/> used to execute <see cref="T:System.IO.Pipelines.PipeReader"/> callbacks
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.PipeOptions.Pool">
|
||||
<summary>
|
||||
Gets the <see cref="T:System.Buffers.MemoryPool`1"/> instances used for buffer management
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.IO.Pipelines.PipeReader">
|
||||
<summary>
|
||||
Defines a class that provides access to a read side of pipe.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.TryRead(System.IO.Pipelines.ReadResult@)">
|
||||
<summary>
|
||||
Attempt to synchronously read data the <see cref="T:System.IO.Pipelines.PipeReader"/>.
|
||||
</summary>
|
||||
<param name="result">The <see cref="T:System.IO.Pipelines.ReadResult"/></param>
|
||||
<returns>True if data was available, or if the call was canceled or the writer was completed.</returns>
|
||||
<remarks>If the pipe returns false, there's no need to call <see cref="M:System.IO.Pipelines.PipeReader.AdvanceTo(System.SequencePosition,System.SequencePosition)"/>.</remarks>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Asynchronously reads a sequence of bytes from the current <see cref="T:System.IO.Pipelines.PipeReader"/>.
|
||||
</summary>
|
||||
<returns>A <see cref="T:System.Threading.Tasks.ValueTask`1"/> representing the asynchronous read operation.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.AdvanceTo(System.SequencePosition)">
|
||||
<summary>
|
||||
Moves forward the pipeline's read cursor to after the consumed data.
|
||||
</summary>
|
||||
<param name="consumed">Marks the extent of the data that has been successfully processed.</param>
|
||||
<remarks>
|
||||
The memory for the consumed data will be released and no longer available.
|
||||
The examined data communicates to the pipeline when it should signal more data is available.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.AdvanceTo(System.SequencePosition,System.SequencePosition)">
|
||||
<summary>
|
||||
Moves forward the pipeline's read cursor to after the consumed data.
|
||||
</summary>
|
||||
<param name="consumed">Marks the extent of the data that has been successfully processed.</param>
|
||||
<param name="examined">Marks the extent of the data that has been read and examined.</param>
|
||||
<remarks>
|
||||
The memory for the consumed data will be released and no longer available.
|
||||
The examined data communicates to the pipeline when it should signal more data is available.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.CancelPendingRead">
|
||||
<summary>
|
||||
Cancel to currently pending or if none is pending next call to <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)"/>, without completing the <see cref="T:System.IO.Pipelines.PipeReader"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.Complete(System.Exception)">
|
||||
<summary>
|
||||
Signal to the producer that the consumer is done reading.
|
||||
</summary>
|
||||
<param name="exception">Optional <see cref="T:System.Exception"/> indicating a failure that's causing the pipeline to complete.</param>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.OnWriterCompleted(System.Action{System.Exception,System.Object},System.Object)">
|
||||
<summary>
|
||||
Cancel the pending <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)"/> operation. If there is none, cancels next <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)"/> operation, without completing the <see cref="T:System.IO.Pipelines.PipeWriter"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.IO.Pipelines.PipeScheduler">
|
||||
<summary>
|
||||
Abstraction for running <see cref="T:System.IO.Pipelines.PipeReader"/> and <see cref="T:System.IO.Pipelines.PipeWriter"/> callbacks and continuations
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.PipeScheduler.ThreadPool">
|
||||
<summary>
|
||||
The <see cref="T:System.IO.Pipelines.PipeScheduler"/> implementation that queues callbacks to thread pool
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.PipeScheduler.Inline">
|
||||
<summary>
|
||||
The <see cref="T:System.IO.Pipelines.PipeScheduler"/> implementation that runs callbacks inline
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeScheduler.Schedule(System.Action{System.Object},System.Object)">
|
||||
<summary>
|
||||
Requests <paramref name="action"/> to be run on scheduler with <paramref name="state"/> being passed in
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.IO.Pipelines.PipeWriter">
|
||||
<summary>
|
||||
Defines a class that provides a pipeline to which data can be written.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.Complete(System.Exception)">
|
||||
<summary>
|
||||
Marks the <see cref="T:System.IO.Pipelines.PipeWriter"/> as being complete, meaning no more items will be written to it.
|
||||
</summary>
|
||||
<param name="exception">Optional <see cref="T:System.Exception"/> indicating a failure that's causing the pipeline to complete.</param>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.CancelPendingFlush">
|
||||
<summary>
|
||||
Cancel the pending <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)"/> operation. If there is none, cancels next <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)"/> operation, without completing the <see cref="T:System.IO.Pipelines.PipeWriter"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.OnReaderCompleted(System.Action{System.Exception,System.Object},System.Object)">
|
||||
<summary>
|
||||
Registers a callback that gets executed when the <see cref="T:System.IO.Pipelines.PipeReader"/> side of the pipe is completed
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Makes bytes written available to <see cref="T:System.IO.Pipelines.PipeReader"/> and runs <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)"/> continuation.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.Advance(System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.GetMemory(System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.GetSpan(System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.WriteAsync(System.ReadOnlyMemory{System.Byte},System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Writes <paramref name="source"/> to the pipe and makes data accessible to <see cref="T:System.IO.Pipelines.PipeReader"/>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.IO.Pipelines.ReadResult">
|
||||
<summary>
|
||||
The result of a <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)"/> call.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.ReadResult.#ctor(System.Buffers.ReadOnlySequence{System.Byte},System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
Creates a new instance of <see cref="T:System.IO.Pipelines.ReadResult"/> setting <see cref="P:System.IO.Pipelines.ReadResult.IsCanceled"/> and <see cref="P:System.IO.Pipelines.ReadResult.IsCompleted"/> flags
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.ReadResult.Buffer">
|
||||
<summary>
|
||||
The <see cref="T:System.Buffers.ReadOnlySequence`1"/> that was read
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.ReadResult.IsCanceled">
|
||||
<summary>
|
||||
True if the current <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)"/> operation was canceled, otherwise false.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.ReadResult.IsCompleted">
|
||||
<summary>
|
||||
True if the <see cref="T:System.IO.Pipelines.PipeReader"/> is complete
|
||||
</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
BIN
Binary file not shown.
-318
@@ -1,318 +0,0 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>System.IO.Pipelines</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:System.IO.Pipelines.FlushResult">
|
||||
<summary>Result returned by <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> call.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.FlushResult.#ctor(System.Boolean,System.Boolean)">
|
||||
<summary>Creates a new instance of <see cref="T:System.IO.Pipelines.FlushResult" /> setting <see cref="P:System.IO.Pipelines.FlushResult.IsCanceled" /> and <see cref="P:System.IO.Pipelines.FlushResult.IsCompleted" /> flags.</summary>
|
||||
<param name="isCanceled" />
|
||||
<param name="isCompleted" />
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.FlushResult.IsCanceled">
|
||||
<summary>
|
||||
<see langword="true" /> if the current <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> operation was canceled; otherwise, <see langword="false" />.</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.FlushResult.IsCompleted">
|
||||
<summary>
|
||||
<see langword="true" /> if the <see cref="T:System.IO.Pipelines.PipeWriter" /> is complete; otherwise, <see langword="false" />.</summary>
|
||||
</member>
|
||||
<member name="T:System.IO.Pipelines.IDuplexPipe">
|
||||
<summary>Defines a class that provides a duplex pipe from which data can be read from and written to.</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.IDuplexPipe.Input">
|
||||
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeReader" /> half of the duplex pipe.</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.IDuplexPipe.Output">
|
||||
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeWriter" /> half of the duplex pipe.</summary>
|
||||
</member>
|
||||
<member name="T:System.IO.Pipelines.Pipe">
|
||||
<summary>Default <see cref="T:System.IO.Pipelines.PipeWriter" /> and <see cref="T:System.IO.Pipelines.PipeReader" /> implementation.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.Pipe.#ctor">
|
||||
<summary>Initializes the <see cref="T:System.IO.Pipelines.Pipe" /> using <see cref="P:System.IO.Pipelines.PipeOptions.Default" /> as options.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.Pipe.#ctor(System.IO.Pipelines.PipeOptions)">
|
||||
<summary>Initializes the <see cref="T:System.IO.Pipelines.Pipe" /> with the specified <see cref="T:System.IO.Pipelines.PipeOptions" />.</summary>
|
||||
<param name="options" />
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.Pipe.Reader">
|
||||
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeReader" /> for this pipe.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.Pipe.Reset">
|
||||
<summary>Resets the pipe.</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.Pipe.Writer">
|
||||
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeWriter" /> for this pipe.</summary>
|
||||
</member>
|
||||
<member name="T:System.IO.Pipelines.PipeOptions">
|
||||
<summary>Represents a set of <see cref="T:System.IO.Pipelines.Pipe" /> options.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeOptions.#ctor(System.Buffers.MemoryPool{System.Byte},System.IO.Pipelines.PipeScheduler,System.IO.Pipelines.PipeScheduler,System.Int64,System.Int64,System.Int32,System.Boolean)">
|
||||
<summary>Creates a new instance of <see cref="T:System.IO.Pipelines.PipeOptions" />.</summary>
|
||||
<param name="pool" />
|
||||
<param name="readerScheduler" />
|
||||
<param name="writerScheduler" />
|
||||
<param name="pauseWriterThreshold" />
|
||||
<param name="resumeWriterThreshold" />
|
||||
<param name="minimumSegmentSize" />
|
||||
<param name="useSynchronizationContext" />
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.PipeOptions.Default">
|
||||
<summary>Gets the default instance of <see cref="T:System.IO.Pipelines.PipeOptions" />.</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.PipeOptions.MinimumSegmentSize">
|
||||
<summary>Gets the minimum size of the segment requested from <see cref="P:System.IO.Pipelines.PipeOptions.Pool" />.</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.PipeOptions.PauseWriterThreshold">
|
||||
<summary>Gets the amount of bytes in <see cref="T:System.IO.Pipelines.Pipe" /> when <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> starts blocking.</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.PipeOptions.Pool">
|
||||
<summary>Gets the <see cref="T:System.Buffers.MemoryPool`1" /> instances used for buffer management.</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.PipeOptions.ReaderScheduler">
|
||||
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeScheduler" /> used to execute <see cref="T:System.IO.Pipelines.PipeReader" /> callbacks.</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.PipeOptions.ResumeWriterThreshold">
|
||||
<summary>Gets amount of bytes in <see cref="T:System.IO.Pipelines.Pipe" /> when <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> stops blocking.</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.PipeOptions.UseSynchronizationContext">
|
||||
<summary>Gets a value that determines if asynchronous callbacks should be executed on the <see cref="T:System.Threading.SynchronizationContext" /> they were captured on. This takes precedence over the schedulers specified in <see cref="P:System.IO.Pipelines.PipeOptions.ReaderScheduler" /> and <see cref="P:System.IO.Pipelines.PipeOptions.WriterScheduler" />.</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.PipeOptions.WriterScheduler">
|
||||
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeScheduler" /> used to execute <see cref="T:System.IO.Pipelines.PipeWriter" /> callbacks.</summary>
|
||||
</member>
|
||||
<member name="T:System.IO.Pipelines.PipeReader">
|
||||
<summary>Defines a class that provides access to a read side of pipe.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.#ctor">
|
||||
<summary>Initializes a new instance of the <see cref="T:System.IO.Pipelines.PipeReader" /> class.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.AdvanceTo(System.SequencePosition)">
|
||||
<summary>Moves forward the pipeline's read cursor to after the consumed data.</summary>
|
||||
<param name="consumed">Marks the extent of the data that has been successfully processed.</param>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.AdvanceTo(System.SequencePosition,System.SequencePosition)">
|
||||
<summary>Moves forward the pipeline's read cursor to after the consumed data.</summary>
|
||||
<param name="consumed">Marks the extent of the data that has been successfully processed.</param>
|
||||
<param name="examined">Marks the extent of the data that has been read and examined.</param>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.AsStream(System.Boolean)">
|
||||
<summary>Returns the underlying <see cref="T:System.IO.Stream" /> wrapped by the <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
|
||||
<param name="leaveOpen">An optional flag that indicates whether disposing the returned <see cref="T:System.IO.Stream" /> leaves <see cref="T:System.IO.Pipelines.PipeReader" /> open (<see langword="true" />) or completes <see cref="T:System.IO.Pipelines.PipeReader" /> (<see langword="false" />).</param>
|
||||
<returns>The underlying stream.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.CancelPendingRead">
|
||||
<summary>Cancels to currently pending or if none is pending next call to <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" />, without completing the <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.Complete(System.Exception)">
|
||||
<summary>Signals to the producer that the consumer is done reading.</summary>
|
||||
<param name="exception">Optional <see cref="T:System.Exception" /> indicating a failure that's causing the pipeline to complete.</param>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.CompleteAsync(System.Exception)">
|
||||
<summary>Marks the current pipe reader instance as being complete, meaning no more data will be read from it.</summary>
|
||||
<param name="exception">An optional exception that indicates the failure that caused the reader to complete.</param>
|
||||
<returns>A value task that represents the asynchronous complete operation.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.CopyToAsync(System.IO.Pipelines.PipeWriter,System.Threading.CancellationToken)">
|
||||
<summary>Asynchronously reads the bytes from the <see cref="T:System.IO.Pipelines.PipeReader" /> and writes them to the specified <see cref="T:System.IO.Pipelines.PipeWriter" />, using a specified buffer size and cancellation token.</summary>
|
||||
<param name="destination">The pipe writer to which the contents of the current stream will be copied.</param>
|
||||
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
|
||||
<returns>A task that represents the asynchronous copy operation.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.CopyToAsync(System.IO.Stream,System.Threading.CancellationToken)">
|
||||
<summary>Asynchronously reads the bytes from the <see cref="T:System.IO.Pipelines.PipeReader" /> and writes them to the specified stream, using a specified cancellation token.</summary>
|
||||
<param name="destination">The stream to which the contents of the current stream will be copied.</param>
|
||||
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
|
||||
<returns>A task that represents the asynchronous copy operation.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.Create(System.IO.Stream,System.IO.Pipelines.StreamPipeReaderOptions)">
|
||||
<summary>Creates a <see cref="T:System.IO.Pipelines.PipeReader" /> wrapping the specified <see cref="T:System.IO.Stream" />.</summary>
|
||||
<param name="stream">The stream that the pipe reader will wrap.</param>
|
||||
<param name="readerOptions">The options to configure the pipe reader.</param>
|
||||
<returns>A <see cref="T:System.IO.Pipelines.PipeReader" /> that wraps the <see cref="T:System.IO.Stream" />.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.OnWriterCompleted(System.Action{System.Exception,System.Object},System.Object)">
|
||||
<summary>Registers a callback that executes when the <see cref="T:System.IO.Pipelines.PipeWriter" /> side of the pipe is completed.</summary>
|
||||
<param name="callback">The callback to register.</param>
|
||||
<param name="state">The state object to pass to <paramref name="callback" /> when it's invoked.</param>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)">
|
||||
<summary>Asynchronously reads a sequence of bytes from the current <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
|
||||
<param name="cancellationToken" />
|
||||
<returns>A <see cref="T:System.Threading.Tasks.ValueTask`1" /> representing the asynchronous read operation.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.TryRead(System.IO.Pipelines.ReadResult@)">
|
||||
<summary>Attempts to synchronously read data the <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
|
||||
<param name="result">The <see cref="T:System.IO.Pipelines.ReadResult" /></param>
|
||||
<returns>
|
||||
<see langword="true" /> if data was available, or if the call was canceled or the writer was completed; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="T:System.IO.Pipelines.PipeScheduler">
|
||||
<summary>Abstraction for running <see cref="T:System.IO.Pipelines.PipeReader" /> and <see cref="T:System.IO.Pipelines.PipeWriter" /> callbacks and continuations.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeScheduler.#ctor" />
|
||||
<member name="P:System.IO.Pipelines.PipeScheduler.Inline">
|
||||
<summary>The <see cref="T:System.IO.Pipelines.PipeScheduler" /> implementation that runs callbacks inline.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeScheduler.Schedule(System.Action{System.Object},System.Object)">
|
||||
<summary>Requests <paramref name="action" /> to be run on scheduler with <paramref name="state" /> being passed in.</summary>
|
||||
<param name="action" />
|
||||
<param name="state" />
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.PipeScheduler.ThreadPool">
|
||||
<summary>The <see cref="T:System.IO.Pipelines.PipeScheduler" /> implementation that queues callbacks to thread pool.</summary>
|
||||
</member>
|
||||
<member name="T:System.IO.Pipelines.PipeWriter">
|
||||
<summary>Defines a class that provides a pipeline to which data can be written.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.#ctor">
|
||||
<summary>Initializes a new instance of the class.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.Advance(System.Int32)">
|
||||
<summary>Notifies the <see cref="T:System.IO.Pipelines.PipeWriter" /> that <paramref name="bytes" /> bytes were written to the output <see cref="T:System.Span`1" /> or <see cref="T:System.Memory`1" />. You must request a new buffer after calling <see cref="M:System.IO.Pipelines.PipeWriter.Advance(System.Int32)" /> to continue writing more data; you cannot write to a previously acquired buffer.</summary>
|
||||
<param name="bytes">The number of bytes written to the <see cref="T:System.Span`1" /> or <see cref="T:System.Memory`1" />.</param>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.AsStream(System.Boolean)">
|
||||
<summary>Returns the underlying <see cref="T:System.IO.Stream" /> wrapped by the <see cref="T:System.IO.Pipelines.PipeWriter" />.</summary>
|
||||
<param name="leaveOpen">An optional flag that indicates whether disposing the returned <see cref="T:System.IO.Stream" /> leaves <see cref="T:System.IO.Pipelines.PipeReader" /> open (<see langword="true" />) or completes <see cref="T:System.IO.Pipelines.PipeReader" /> (<see langword="false" />).</param>
|
||||
<returns>The underlying stream.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.CancelPendingFlush">
|
||||
<summary>Cancels the pending <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> operation. If there is none, cancels next <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> operation, without completing the <see cref="T:System.IO.Pipelines.PipeWriter" />.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.Complete(System.Exception)">
|
||||
<summary>Marks the <see cref="T:System.IO.Pipelines.PipeWriter" /> as being complete, meaning no more items will be written to it.</summary>
|
||||
<param name="exception">Optional <see cref="T:System.Exception" /> indicating a failure that's causing the pipeline to complete.</param>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.CompleteAsync(System.Exception)">
|
||||
<summary>Marks the current pipe writer instance as being complete, meaning no more data will be written to it.</summary>
|
||||
<param name="exception">An optional exception that indicates the failure that caused the pipeline to complete.</param>
|
||||
<returns>A value task that represents the asynchronous complete operation.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.CopyFromAsync(System.IO.Stream,System.Threading.CancellationToken)">
|
||||
<summary>Asynchronously reads the bytes from the specified stream and writes them to the <see cref="T:System.IO.Pipelines.PipeWriter" />.</summary>
|
||||
<param name="source">The stream from which the contents will be copied.</param>
|
||||
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
|
||||
<returns>A task that represents the asynchronous copy operation.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.Create(System.IO.Stream,System.IO.Pipelines.StreamPipeWriterOptions)">
|
||||
<summary>Creates a <see cref="T:System.IO.Pipelines.PipeWriter" /> wrapping the specified <see cref="T:System.IO.Stream" />.</summary>
|
||||
<param name="stream">The stream that the pipe writer will wrap.</param>
|
||||
<param name="writerOptions">The options to configure the pipe writer.</param>
|
||||
<returns>A <see cref="T:System.IO.Pipelines.PipeWriter" /> that wraps the <see cref="T:System.IO.Stream" />.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)">
|
||||
<summary>Makes bytes written available to <see cref="T:System.IO.Pipelines.PipeReader" /> and runs <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> continuation.</summary>
|
||||
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
|
||||
<returns>A task that represents and wraps the asynchronous flush operation.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.GetMemory(System.Int32)">
|
||||
<summary>Returns a <see cref="T:System.Memory`1" /> to write to that is at least the requested size, as specified by the <paramref name="sizeHint" /> parameter.</summary>
|
||||
<param name="sizeHint">The minimum length of the returned <see cref="T:System.Memory`1" />. If 0, a non-empty memory buffer of arbitrary size is returned.</param>
|
||||
<returns>A memory buffer of at least <paramref name="sizeHint" /> bytes. If <paramref name="sizeHint" /> is 0, returns a non-empty buffer of arbitrary size.</returns>
|
||||
<exception cref="T:System.OutOfMemoryException">The requested buffer size is not available.</exception>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.GetSpan(System.Int32)">
|
||||
<summary>Returns a <see cref="T:System.Span`1" /> to write to that is at least the requested size, as specified by the <paramref name="sizeHint" /> parameter.</summary>
|
||||
<param name="sizeHint">The minimum length of the returned <see cref="T:System.Span`1" />. If 0, a non-empty buffer of arbitrary size is returned.</param>
|
||||
<returns>A buffer of at least <paramref name="sizeHint" /> bytes. If <paramref name="sizeHint" /> is 0, returns a non-empty buffer of arbitrary size.</returns>
|
||||
<exception cref="T:System.OutOfMemoryException">The requested buffer size is not available.</exception>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.OnReaderCompleted(System.Action{System.Exception,System.Object},System.Object)">
|
||||
<summary>Registers a callback that executes when the <see cref="T:System.IO.Pipelines.PipeReader" /> side of the pipe is completed.</summary>
|
||||
<param name="callback">The callback to register.</param>
|
||||
<param name="state">The state object to pass to <paramref name="callback" /> when it's invoked.</param>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.WriteAsync(System.ReadOnlyMemory{System.Byte},System.Threading.CancellationToken)">
|
||||
<summary>Writes the specified byte memory range to the pipe and makes data accessible to the <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
|
||||
<param name="source">The read-only byte memory region to write.</param>
|
||||
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
|
||||
<returns>A task that represents the asynchronous write operation, and wraps the flush asynchronous operation.</returns>
|
||||
</member>
|
||||
<member name="T:System.IO.Pipelines.ReadResult">
|
||||
<summary>The result of a <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> call.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.ReadResult.#ctor(System.Buffers.ReadOnlySequence{System.Byte},System.Boolean,System.Boolean)">
|
||||
<summary>Creates a new instance of <see cref="T:System.IO.Pipelines.ReadResult" /> setting <see cref="P:System.IO.Pipelines.ReadResult.IsCanceled" /> and <see cref="P:System.IO.Pipelines.ReadResult.IsCompleted" /> flags.</summary>
|
||||
<param name="buffer" />
|
||||
<param name="isCanceled" />
|
||||
<param name="isCompleted" />
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.ReadResult.Buffer">
|
||||
<summary>Gets the <see cref="T:System.Buffers.ReadOnlySequence`1" /> that was read.</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.ReadResult.IsCanceled">
|
||||
<summary>
|
||||
<see langword="true" /> if the current <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> operation was canceled; otherwise, <see langword="false" />.</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.ReadResult.IsCompleted">
|
||||
<summary>
|
||||
<see langword="true" /> if the <see cref="T:System.IO.Pipelines.PipeReader" /> is complete; otherwise, <see langword="false" />.</summary>
|
||||
</member>
|
||||
<member name="T:System.IO.Pipelines.StreamPipeExtensions">
|
||||
<summary>Provides extension methods for <see cref="T:System.IO.Stream" /> that support read and write operations directly into pipes.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.StreamPipeExtensions.CopyToAsync(System.IO.Stream,System.IO.Pipelines.PipeWriter,System.Threading.CancellationToken)">
|
||||
<summary>Asynchronously reads the bytes from the <see cref="T:System.IO.Stream" /> and writes them to the specified <see cref="T:System.IO.Pipelines.PipeWriter" />, using a cancellation token.</summary>
|
||||
<param name="source">The stream from which the contents of the current stream will be copied.</param>
|
||||
<param name="destination">The writer to which the contents of the source stream will be copied.</param>
|
||||
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
|
||||
<returns>A task that represents the asynchronous copy operation.</returns>
|
||||
</member>
|
||||
<member name="T:System.IO.Pipelines.StreamPipeReaderOptions">
|
||||
<summary>Represents a set of options for controlling the creation of the <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.StreamPipeReaderOptions.#ctor(System.Buffers.MemoryPool{System.Byte},System.Int32,System.Int32,System.Boolean)">
|
||||
<summary>Initializes a <see cref="T:System.IO.Pipelines.StreamPipeReaderOptions" /> instance, optionally specifying a memory pool, a minimum buffer size, a minimum read size, and whether the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeReader" /> completes.</summary>
|
||||
<param name="pool">The memory pool to use when allocating memory. The default value is <see langword="null" />.</param>
|
||||
<param name="bufferSize">The minimum buffer size to use when renting memory from the <paramref name="pool" />. The default value is 4096.</param>
|
||||
<param name="minimumReadSize">The threshold of remaining bytes in the buffer before a new buffer is allocated. The default value is 1024.</param>
|
||||
<param name="leaveOpen">
|
||||
<see langword="true" /> to leave the underlying stream open after the <see cref="T:System.IO.Pipelines.PipeReader" /> completes; <see langword="false" /> to close it. The default is <see langword="false" />.</param>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.StreamPipeReaderOptions.BufferSize">
|
||||
<summary>Gets the minimum buffer size to use when renting memory from the <see cref="P:System.IO.Pipelines.StreamPipeReaderOptions.Pool" />.</summary>
|
||||
<returns>The buffer size.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.StreamPipeReaderOptions.LeaveOpen">
|
||||
<summary>Gets the value that indicates if the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeReader" /> completes.</summary>
|
||||
<returns>
|
||||
<see langword="true" /> if the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeReader" /> completes; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.StreamPipeReaderOptions.MinimumReadSize">
|
||||
<summary>Gets the threshold of remaining bytes in the buffer before a new buffer is allocated.</summary>
|
||||
<returns>The minimum read size.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.StreamPipeReaderOptions.Pool">
|
||||
<summary>Gets the <see cref="T:System.Buffers.MemoryPool`1" /> to use when allocating memory.</summary>
|
||||
<returns>A memory pool instance.</returns>
|
||||
</member>
|
||||
<member name="T:System.IO.Pipelines.StreamPipeWriterOptions">
|
||||
<summary>Represents a set of options for controlling the creation of the <see cref="T:System.IO.Pipelines.PipeWriter" />.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.StreamPipeWriterOptions.#ctor(System.Buffers.MemoryPool{System.Byte},System.Int32,System.Boolean)">
|
||||
<summary>Initializes a <see cref="T:System.IO.Pipelines.StreamPipeWriterOptions" /> instance, optionally specifying a memory pool, a minimum buffer size, and whether the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeWriter" /> completes.</summary>
|
||||
<param name="pool">The memory pool to use when allocating memory. The default value is <see langword="null" />.</param>
|
||||
<param name="minimumBufferSize">The minimum buffer size to use when renting memory from the <paramref name="pool" />. The default value is 4096.</param>
|
||||
<param name="leaveOpen">
|
||||
<see langword="true" /> to leave the underlying stream open after the <see cref="T:System.IO.Pipelines.PipeWriter" /> completes; <see langword="false" /> to close it. The default is <see langword="false" />.</param>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.StreamPipeWriterOptions.LeaveOpen">
|
||||
<summary>Gets the value that indicates if the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeWriter" /> completes.</summary>
|
||||
<returns>
|
||||
<see langword="true" /> if the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeWriter" /> completes; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.StreamPipeWriterOptions.MinimumBufferSize">
|
||||
<summary>Gets the minimum buffer size to use when renting memory from the <see cref="P:System.IO.Pipelines.StreamPipeWriterOptions.Pool" />.</summary>
|
||||
<returns>An integer representing the minimum buffer size.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.StreamPipeWriterOptions.Pool">
|
||||
<summary>Gets the <see cref="T:System.Buffers.MemoryPool`1" /> to use when allocating memory.</summary>
|
||||
<returns>A memory pool instance.</returns>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
BIN
Binary file not shown.
-318
@@ -1,318 +0,0 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>System.IO.Pipelines</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:System.IO.Pipelines.FlushResult">
|
||||
<summary>Result returned by <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> call.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.FlushResult.#ctor(System.Boolean,System.Boolean)">
|
||||
<summary>Creates a new instance of <see cref="T:System.IO.Pipelines.FlushResult" /> setting <see cref="P:System.IO.Pipelines.FlushResult.IsCanceled" /> and <see cref="P:System.IO.Pipelines.FlushResult.IsCompleted" /> flags.</summary>
|
||||
<param name="isCanceled" />
|
||||
<param name="isCompleted" />
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.FlushResult.IsCanceled">
|
||||
<summary>
|
||||
<see langword="true" /> if the current <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> operation was canceled; otherwise, <see langword="false" />.</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.FlushResult.IsCompleted">
|
||||
<summary>
|
||||
<see langword="true" /> if the <see cref="T:System.IO.Pipelines.PipeWriter" /> is complete; otherwise, <see langword="false" />.</summary>
|
||||
</member>
|
||||
<member name="T:System.IO.Pipelines.IDuplexPipe">
|
||||
<summary>Defines a class that provides a duplex pipe from which data can be read from and written to.</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.IDuplexPipe.Input">
|
||||
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeReader" /> half of the duplex pipe.</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.IDuplexPipe.Output">
|
||||
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeWriter" /> half of the duplex pipe.</summary>
|
||||
</member>
|
||||
<member name="T:System.IO.Pipelines.Pipe">
|
||||
<summary>Default <see cref="T:System.IO.Pipelines.PipeWriter" /> and <see cref="T:System.IO.Pipelines.PipeReader" /> implementation.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.Pipe.#ctor">
|
||||
<summary>Initializes the <see cref="T:System.IO.Pipelines.Pipe" /> using <see cref="P:System.IO.Pipelines.PipeOptions.Default" /> as options.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.Pipe.#ctor(System.IO.Pipelines.PipeOptions)">
|
||||
<summary>Initializes the <see cref="T:System.IO.Pipelines.Pipe" /> with the specified <see cref="T:System.IO.Pipelines.PipeOptions" />.</summary>
|
||||
<param name="options" />
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.Pipe.Reader">
|
||||
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeReader" /> for this pipe.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.Pipe.Reset">
|
||||
<summary>Resets the pipe.</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.Pipe.Writer">
|
||||
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeWriter" /> for this pipe.</summary>
|
||||
</member>
|
||||
<member name="T:System.IO.Pipelines.PipeOptions">
|
||||
<summary>Represents a set of <see cref="T:System.IO.Pipelines.Pipe" /> options.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeOptions.#ctor(System.Buffers.MemoryPool{System.Byte},System.IO.Pipelines.PipeScheduler,System.IO.Pipelines.PipeScheduler,System.Int64,System.Int64,System.Int32,System.Boolean)">
|
||||
<summary>Creates a new instance of <see cref="T:System.IO.Pipelines.PipeOptions" />.</summary>
|
||||
<param name="pool" />
|
||||
<param name="readerScheduler" />
|
||||
<param name="writerScheduler" />
|
||||
<param name="pauseWriterThreshold" />
|
||||
<param name="resumeWriterThreshold" />
|
||||
<param name="minimumSegmentSize" />
|
||||
<param name="useSynchronizationContext" />
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.PipeOptions.Default">
|
||||
<summary>Gets the default instance of <see cref="T:System.IO.Pipelines.PipeOptions" />.</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.PipeOptions.MinimumSegmentSize">
|
||||
<summary>Gets the minimum size of the segment requested from <see cref="P:System.IO.Pipelines.PipeOptions.Pool" />.</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.PipeOptions.PauseWriterThreshold">
|
||||
<summary>Gets the amount of bytes in <see cref="T:System.IO.Pipelines.Pipe" /> when <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> starts blocking.</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.PipeOptions.Pool">
|
||||
<summary>Gets the <see cref="T:System.Buffers.MemoryPool`1" /> instances used for buffer management.</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.PipeOptions.ReaderScheduler">
|
||||
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeScheduler" /> used to execute <see cref="T:System.IO.Pipelines.PipeReader" /> callbacks.</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.PipeOptions.ResumeWriterThreshold">
|
||||
<summary>Gets amount of bytes in <see cref="T:System.IO.Pipelines.Pipe" /> when <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> stops blocking.</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.PipeOptions.UseSynchronizationContext">
|
||||
<summary>Gets a value that determines if asynchronous callbacks should be executed on the <see cref="T:System.Threading.SynchronizationContext" /> they were captured on. This takes precedence over the schedulers specified in <see cref="P:System.IO.Pipelines.PipeOptions.ReaderScheduler" /> and <see cref="P:System.IO.Pipelines.PipeOptions.WriterScheduler" />.</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.PipeOptions.WriterScheduler">
|
||||
<summary>Gets the <see cref="T:System.IO.Pipelines.PipeScheduler" /> used to execute <see cref="T:System.IO.Pipelines.PipeWriter" /> callbacks.</summary>
|
||||
</member>
|
||||
<member name="T:System.IO.Pipelines.PipeReader">
|
||||
<summary>Defines a class that provides access to a read side of pipe.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.#ctor">
|
||||
<summary>Initializes a new instance of the <see cref="T:System.IO.Pipelines.PipeReader" /> class.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.AdvanceTo(System.SequencePosition)">
|
||||
<summary>Moves forward the pipeline's read cursor to after the consumed data.</summary>
|
||||
<param name="consumed">Marks the extent of the data that has been successfully processed.</param>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.AdvanceTo(System.SequencePosition,System.SequencePosition)">
|
||||
<summary>Moves forward the pipeline's read cursor to after the consumed data.</summary>
|
||||
<param name="consumed">Marks the extent of the data that has been successfully processed.</param>
|
||||
<param name="examined">Marks the extent of the data that has been read and examined.</param>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.AsStream(System.Boolean)">
|
||||
<summary>Returns the underlying <see cref="T:System.IO.Stream" /> wrapped by the <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
|
||||
<param name="leaveOpen">An optional flag that indicates whether disposing the returned <see cref="T:System.IO.Stream" /> leaves <see cref="T:System.IO.Pipelines.PipeReader" /> open (<see langword="true" />) or completes <see cref="T:System.IO.Pipelines.PipeReader" /> (<see langword="false" />).</param>
|
||||
<returns>The underlying stream.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.CancelPendingRead">
|
||||
<summary>Cancels to currently pending or if none is pending next call to <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" />, without completing the <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.Complete(System.Exception)">
|
||||
<summary>Signals to the producer that the consumer is done reading.</summary>
|
||||
<param name="exception">Optional <see cref="T:System.Exception" /> indicating a failure that's causing the pipeline to complete.</param>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.CompleteAsync(System.Exception)">
|
||||
<summary>Marks the current pipe reader instance as being complete, meaning no more data will be read from it.</summary>
|
||||
<param name="exception">An optional exception that indicates the failure that caused the reader to complete.</param>
|
||||
<returns>A value task that represents the asynchronous complete operation.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.CopyToAsync(System.IO.Pipelines.PipeWriter,System.Threading.CancellationToken)">
|
||||
<summary>Asynchronously reads the bytes from the <see cref="T:System.IO.Pipelines.PipeReader" /> and writes them to the specified <see cref="T:System.IO.Pipelines.PipeWriter" />, using a specified buffer size and cancellation token.</summary>
|
||||
<param name="destination">The pipe writer to which the contents of the current stream will be copied.</param>
|
||||
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
|
||||
<returns>A task that represents the asynchronous copy operation.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.CopyToAsync(System.IO.Stream,System.Threading.CancellationToken)">
|
||||
<summary>Asynchronously reads the bytes from the <see cref="T:System.IO.Pipelines.PipeReader" /> and writes them to the specified stream, using a specified cancellation token.</summary>
|
||||
<param name="destination">The stream to which the contents of the current stream will be copied.</param>
|
||||
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
|
||||
<returns>A task that represents the asynchronous copy operation.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.Create(System.IO.Stream,System.IO.Pipelines.StreamPipeReaderOptions)">
|
||||
<summary>Creates a <see cref="T:System.IO.Pipelines.PipeReader" /> wrapping the specified <see cref="T:System.IO.Stream" />.</summary>
|
||||
<param name="stream">The stream that the pipe reader will wrap.</param>
|
||||
<param name="readerOptions">The options to configure the pipe reader.</param>
|
||||
<returns>A <see cref="T:System.IO.Pipelines.PipeReader" /> that wraps the <see cref="T:System.IO.Stream" />.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.OnWriterCompleted(System.Action{System.Exception,System.Object},System.Object)">
|
||||
<summary>Registers a callback that executes when the <see cref="T:System.IO.Pipelines.PipeWriter" /> side of the pipe is completed.</summary>
|
||||
<param name="callback">The callback to register.</param>
|
||||
<param name="state">The state object to pass to <paramref name="callback" /> when it's invoked.</param>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)">
|
||||
<summary>Asynchronously reads a sequence of bytes from the current <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
|
||||
<param name="cancellationToken" />
|
||||
<returns>A <see cref="T:System.Threading.Tasks.ValueTask`1" /> representing the asynchronous read operation.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeReader.TryRead(System.IO.Pipelines.ReadResult@)">
|
||||
<summary>Attempts to synchronously read data the <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
|
||||
<param name="result">The <see cref="T:System.IO.Pipelines.ReadResult" /></param>
|
||||
<returns>
|
||||
<see langword="true" /> if data was available, or if the call was canceled or the writer was completed; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="T:System.IO.Pipelines.PipeScheduler">
|
||||
<summary>Abstraction for running <see cref="T:System.IO.Pipelines.PipeReader" /> and <see cref="T:System.IO.Pipelines.PipeWriter" /> callbacks and continuations.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeScheduler.#ctor" />
|
||||
<member name="P:System.IO.Pipelines.PipeScheduler.Inline">
|
||||
<summary>The <see cref="T:System.IO.Pipelines.PipeScheduler" /> implementation that runs callbacks inline.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeScheduler.Schedule(System.Action{System.Object},System.Object)">
|
||||
<summary>Requests <paramref name="action" /> to be run on scheduler with <paramref name="state" /> being passed in.</summary>
|
||||
<param name="action" />
|
||||
<param name="state" />
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.PipeScheduler.ThreadPool">
|
||||
<summary>The <see cref="T:System.IO.Pipelines.PipeScheduler" /> implementation that queues callbacks to thread pool.</summary>
|
||||
</member>
|
||||
<member name="T:System.IO.Pipelines.PipeWriter">
|
||||
<summary>Defines a class that provides a pipeline to which data can be written.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.#ctor">
|
||||
<summary>Initializes a new instance of the class.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.Advance(System.Int32)">
|
||||
<summary>Notifies the <see cref="T:System.IO.Pipelines.PipeWriter" /> that <paramref name="bytes" /> bytes were written to the output <see cref="T:System.Span`1" /> or <see cref="T:System.Memory`1" />. You must request a new buffer after calling <see cref="M:System.IO.Pipelines.PipeWriter.Advance(System.Int32)" /> to continue writing more data; you cannot write to a previously acquired buffer.</summary>
|
||||
<param name="bytes">The number of bytes written to the <see cref="T:System.Span`1" /> or <see cref="T:System.Memory`1" />.</param>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.AsStream(System.Boolean)">
|
||||
<summary>Returns the underlying <see cref="T:System.IO.Stream" /> wrapped by the <see cref="T:System.IO.Pipelines.PipeWriter" />.</summary>
|
||||
<param name="leaveOpen">An optional flag that indicates whether disposing the returned <see cref="T:System.IO.Stream" /> leaves <see cref="T:System.IO.Pipelines.PipeReader" /> open (<see langword="true" />) or completes <see cref="T:System.IO.Pipelines.PipeReader" /> (<see langword="false" />).</param>
|
||||
<returns>The underlying stream.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.CancelPendingFlush">
|
||||
<summary>Cancels the pending <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> operation. If there is none, cancels next <see cref="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)" /> operation, without completing the <see cref="T:System.IO.Pipelines.PipeWriter" />.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.Complete(System.Exception)">
|
||||
<summary>Marks the <see cref="T:System.IO.Pipelines.PipeWriter" /> as being complete, meaning no more items will be written to it.</summary>
|
||||
<param name="exception">Optional <see cref="T:System.Exception" /> indicating a failure that's causing the pipeline to complete.</param>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.CompleteAsync(System.Exception)">
|
||||
<summary>Marks the current pipe writer instance as being complete, meaning no more data will be written to it.</summary>
|
||||
<param name="exception">An optional exception that indicates the failure that caused the pipeline to complete.</param>
|
||||
<returns>A value task that represents the asynchronous complete operation.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.CopyFromAsync(System.IO.Stream,System.Threading.CancellationToken)">
|
||||
<summary>Asynchronously reads the bytes from the specified stream and writes them to the <see cref="T:System.IO.Pipelines.PipeWriter" />.</summary>
|
||||
<param name="source">The stream from which the contents will be copied.</param>
|
||||
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
|
||||
<returns>A task that represents the asynchronous copy operation.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.Create(System.IO.Stream,System.IO.Pipelines.StreamPipeWriterOptions)">
|
||||
<summary>Creates a <see cref="T:System.IO.Pipelines.PipeWriter" /> wrapping the specified <see cref="T:System.IO.Stream" />.</summary>
|
||||
<param name="stream">The stream that the pipe writer will wrap.</param>
|
||||
<param name="writerOptions">The options to configure the pipe writer.</param>
|
||||
<returns>A <see cref="T:System.IO.Pipelines.PipeWriter" /> that wraps the <see cref="T:System.IO.Stream" />.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.FlushAsync(System.Threading.CancellationToken)">
|
||||
<summary>Makes bytes written available to <see cref="T:System.IO.Pipelines.PipeReader" /> and runs <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> continuation.</summary>
|
||||
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
|
||||
<returns>A task that represents and wraps the asynchronous flush operation.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.GetMemory(System.Int32)">
|
||||
<summary>Returns a <see cref="T:System.Memory`1" /> to write to that is at least the requested size, as specified by the <paramref name="sizeHint" /> parameter.</summary>
|
||||
<param name="sizeHint">The minimum length of the returned <see cref="T:System.Memory`1" />. If 0, a non-empty memory buffer of arbitrary size is returned.</param>
|
||||
<returns>A memory buffer of at least <paramref name="sizeHint" /> bytes. If <paramref name="sizeHint" /> is 0, returns a non-empty buffer of arbitrary size.</returns>
|
||||
<exception cref="T:System.OutOfMemoryException">The requested buffer size is not available.</exception>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.GetSpan(System.Int32)">
|
||||
<summary>Returns a <see cref="T:System.Span`1" /> to write to that is at least the requested size, as specified by the <paramref name="sizeHint" /> parameter.</summary>
|
||||
<param name="sizeHint">The minimum length of the returned <see cref="T:System.Span`1" />. If 0, a non-empty buffer of arbitrary size is returned.</param>
|
||||
<returns>A buffer of at least <paramref name="sizeHint" /> bytes. If <paramref name="sizeHint" /> is 0, returns a non-empty buffer of arbitrary size.</returns>
|
||||
<exception cref="T:System.OutOfMemoryException">The requested buffer size is not available.</exception>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.OnReaderCompleted(System.Action{System.Exception,System.Object},System.Object)">
|
||||
<summary>Registers a callback that executes when the <see cref="T:System.IO.Pipelines.PipeReader" /> side of the pipe is completed.</summary>
|
||||
<param name="callback">The callback to register.</param>
|
||||
<param name="state">The state object to pass to <paramref name="callback" /> when it's invoked.</param>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.PipeWriter.WriteAsync(System.ReadOnlyMemory{System.Byte},System.Threading.CancellationToken)">
|
||||
<summary>Writes the specified byte memory range to the pipe and makes data accessible to the <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
|
||||
<param name="source">The read-only byte memory region to write.</param>
|
||||
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
|
||||
<returns>A task that represents the asynchronous write operation, and wraps the flush asynchronous operation.</returns>
|
||||
</member>
|
||||
<member name="T:System.IO.Pipelines.ReadResult">
|
||||
<summary>The result of a <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> call.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.ReadResult.#ctor(System.Buffers.ReadOnlySequence{System.Byte},System.Boolean,System.Boolean)">
|
||||
<summary>Creates a new instance of <see cref="T:System.IO.Pipelines.ReadResult" /> setting <see cref="P:System.IO.Pipelines.ReadResult.IsCanceled" /> and <see cref="P:System.IO.Pipelines.ReadResult.IsCompleted" /> flags.</summary>
|
||||
<param name="buffer" />
|
||||
<param name="isCanceled" />
|
||||
<param name="isCompleted" />
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.ReadResult.Buffer">
|
||||
<summary>Gets the <see cref="T:System.Buffers.ReadOnlySequence`1" /> that was read.</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.ReadResult.IsCanceled">
|
||||
<summary>
|
||||
<see langword="true" /> if the current <see cref="M:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)" /> operation was canceled; otherwise, <see langword="false" />.</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.ReadResult.IsCompleted">
|
||||
<summary>
|
||||
<see langword="true" /> if the <see cref="T:System.IO.Pipelines.PipeReader" /> is complete; otherwise, <see langword="false" />.</summary>
|
||||
</member>
|
||||
<member name="T:System.IO.Pipelines.StreamPipeExtensions">
|
||||
<summary>Provides extension methods for <see cref="T:System.IO.Stream" /> that support read and write operations directly into pipes.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.StreamPipeExtensions.CopyToAsync(System.IO.Stream,System.IO.Pipelines.PipeWriter,System.Threading.CancellationToken)">
|
||||
<summary>Asynchronously reads the bytes from the <see cref="T:System.IO.Stream" /> and writes them to the specified <see cref="T:System.IO.Pipelines.PipeWriter" />, using a cancellation token.</summary>
|
||||
<param name="source">The stream from which the contents of the current stream will be copied.</param>
|
||||
<param name="destination">The writer to which the contents of the source stream will be copied.</param>
|
||||
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
|
||||
<returns>A task that represents the asynchronous copy operation.</returns>
|
||||
</member>
|
||||
<member name="T:System.IO.Pipelines.StreamPipeReaderOptions">
|
||||
<summary>Represents a set of options for controlling the creation of the <see cref="T:System.IO.Pipelines.PipeReader" />.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.StreamPipeReaderOptions.#ctor(System.Buffers.MemoryPool{System.Byte},System.Int32,System.Int32,System.Boolean)">
|
||||
<summary>Initializes a <see cref="T:System.IO.Pipelines.StreamPipeReaderOptions" /> instance, optionally specifying a memory pool, a minimum buffer size, a minimum read size, and whether the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeReader" /> completes.</summary>
|
||||
<param name="pool">The memory pool to use when allocating memory. The default value is <see langword="null" />.</param>
|
||||
<param name="bufferSize">The minimum buffer size to use when renting memory from the <paramref name="pool" />. The default value is 4096.</param>
|
||||
<param name="minimumReadSize">The threshold of remaining bytes in the buffer before a new buffer is allocated. The default value is 1024.</param>
|
||||
<param name="leaveOpen">
|
||||
<see langword="true" /> to leave the underlying stream open after the <see cref="T:System.IO.Pipelines.PipeReader" /> completes; <see langword="false" /> to close it. The default is <see langword="false" />.</param>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.StreamPipeReaderOptions.BufferSize">
|
||||
<summary>Gets the minimum buffer size to use when renting memory from the <see cref="P:System.IO.Pipelines.StreamPipeReaderOptions.Pool" />.</summary>
|
||||
<returns>The buffer size.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.StreamPipeReaderOptions.LeaveOpen">
|
||||
<summary>Gets the value that indicates if the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeReader" /> completes.</summary>
|
||||
<returns>
|
||||
<see langword="true" /> if the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeReader" /> completes; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.StreamPipeReaderOptions.MinimumReadSize">
|
||||
<summary>Gets the threshold of remaining bytes in the buffer before a new buffer is allocated.</summary>
|
||||
<returns>The minimum read size.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.StreamPipeReaderOptions.Pool">
|
||||
<summary>Gets the <see cref="T:System.Buffers.MemoryPool`1" /> to use when allocating memory.</summary>
|
||||
<returns>A memory pool instance.</returns>
|
||||
</member>
|
||||
<member name="T:System.IO.Pipelines.StreamPipeWriterOptions">
|
||||
<summary>Represents a set of options for controlling the creation of the <see cref="T:System.IO.Pipelines.PipeWriter" />.</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Pipelines.StreamPipeWriterOptions.#ctor(System.Buffers.MemoryPool{System.Byte},System.Int32,System.Boolean)">
|
||||
<summary>Initializes a <see cref="T:System.IO.Pipelines.StreamPipeWriterOptions" /> instance, optionally specifying a memory pool, a minimum buffer size, and whether the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeWriter" /> completes.</summary>
|
||||
<param name="pool">The memory pool to use when allocating memory. The default value is <see langword="null" />.</param>
|
||||
<param name="minimumBufferSize">The minimum buffer size to use when renting memory from the <paramref name="pool" />. The default value is 4096.</param>
|
||||
<param name="leaveOpen">
|
||||
<see langword="true" /> to leave the underlying stream open after the <see cref="T:System.IO.Pipelines.PipeWriter" /> completes; <see langword="false" /> to close it. The default is <see langword="false" />.</param>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.StreamPipeWriterOptions.LeaveOpen">
|
||||
<summary>Gets the value that indicates if the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeWriter" /> completes.</summary>
|
||||
<returns>
|
||||
<see langword="true" /> if the underlying stream should be left open after the <see cref="T:System.IO.Pipelines.PipeWriter" /> completes; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.StreamPipeWriterOptions.MinimumBufferSize">
|
||||
<summary>Gets the minimum buffer size to use when renting memory from the <see cref="P:System.IO.Pipelines.StreamPipeWriterOptions.Pool" />.</summary>
|
||||
<returns>An integer representing the minimum buffer size.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Pipelines.StreamPipeWriterOptions.Pool">
|
||||
<summary>Gets the <see cref="T:System.Buffers.MemoryPool`1" /> to use when allocating memory.</summary>
|
||||
<returns>A memory pool instance.</returns>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -1 +0,0 @@
|
||||
8a3ffed558ddf943c1efa87d693227722d6af094
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user