build: MySql.Data 직접 참조 방식에서 NuGet 패키지 참조로 전환
This commit is contained in:
parent
b3ec8eb46d
commit
a85f2997bc
@ -13,6 +13,10 @@
|
|||||||
<assemblyIdentity name="System.Buffers" publicKeyToken="cc7b13ffcd2ddd51" culture="neutral" />
|
<assemblyIdentity name="System.Buffers" publicKeyToken="cc7b13ffcd2ddd51" culture="neutral" />
|
||||||
<bindingRedirect oldVersion="0.0.0.0-4.0.3.0" newVersion="4.0.3.0" />
|
<bindingRedirect oldVersion="0.0.0.0-4.0.3.0" newVersion="4.0.3.0" />
|
||||||
</dependentAssembly>
|
</dependentAssembly>
|
||||||
|
<dependentAssembly>
|
||||||
|
<assemblyIdentity name="System.Memory" publicKeyToken="cc7b13ffcd2ddd51" culture="neutral" />
|
||||||
|
<bindingRedirect oldVersion="0.0.0.0-4.0.1.2" newVersion="4.0.1.2" />
|
||||||
|
</dependentAssembly>
|
||||||
</assemblyBinding>
|
</assemblyBinding>
|
||||||
</runtime>
|
</runtime>
|
||||||
</configuration>
|
</configuration>
|
@ -3,14 +3,21 @@
|
|||||||
<package id="AForge" version="2.2.5" targetFramework="net48" />
|
<package id="AForge" version="2.2.5" targetFramework="net48" />
|
||||||
<package id="AForge.Video" version="2.2.5" targetFramework="net48" />
|
<package id="AForge.Video" version="2.2.5" targetFramework="net48" />
|
||||||
<package id="AForge.Video.DirectShow" version="2.2.5" targetFramework="net48" />
|
<package id="AForge.Video.DirectShow" version="2.2.5" targetFramework="net48" />
|
||||||
|
<package id="BouncyCastle" version="1.8.3.1" targetFramework="net48" />
|
||||||
|
<package id="Google.Protobuf" version="3.6.1" targetFramework="net48" />
|
||||||
|
<package id="K4os.Compression.LZ4" version="1.1.11" targetFramework="net48" />
|
||||||
|
<package id="K4os.Compression.LZ4.Streams" version="1.1.11" targetFramework="net48" />
|
||||||
|
<package id="K4os.Hash.xxHash" version="1.0.6" targetFramework="net48" />
|
||||||
<package id="M2Mqtt" version="4.3.0.0" targetFramework="net48" />
|
<package id="M2Mqtt" version="4.3.0.0" targetFramework="net48" />
|
||||||
<package id="Microsoft.Bcl.AsyncInterfaces" version="8.0.0" targetFramework="net48" />
|
<package id="Microsoft.Bcl.AsyncInterfaces" version="8.0.0" targetFramework="net48" />
|
||||||
<package id="Microsoft.Bcl.HashCode" version="1.1.1" targetFramework="net48" />
|
<package id="Microsoft.Bcl.HashCode" version="1.1.1" targetFramework="net48" />
|
||||||
<package id="Microsoft.Extensions.DependencyInjection.Abstractions" version="8.0.0" targetFramework="net48" />
|
<package id="Microsoft.Extensions.DependencyInjection.Abstractions" version="8.0.0" targetFramework="net48" />
|
||||||
<package id="Microsoft.Extensions.Logging.Abstractions" version="8.0.0" targetFramework="net48" />
|
<package id="Microsoft.Extensions.Logging.Abstractions" version="8.0.0" targetFramework="net48" />
|
||||||
|
<package id="MySql.Data" version="8.0.20" targetFramework="net48" />
|
||||||
<package id="Npgsql" version="8.0.2" targetFramework="net48" />
|
<package id="Npgsql" version="8.0.2" targetFramework="net48" />
|
||||||
<package id="OpenCvSharp4" version="4.9.0.20240103" targetFramework="net48" />
|
<package id="OpenCvSharp4" version="4.9.0.20240103" targetFramework="net48" />
|
||||||
<package id="OpenCvSharp4.Extensions" version="4.9.0.20240103" targetFramework="net48" />
|
<package id="OpenCvSharp4.Extensions" version="4.9.0.20240103" targetFramework="net48" />
|
||||||
|
<package id="SSH.NET" version="2016.1.0" targetFramework="net48" />
|
||||||
<package id="System.Buffers" version="4.5.1" targetFramework="net48" />
|
<package id="System.Buffers" version="4.5.1" targetFramework="net48" />
|
||||||
<package id="System.Collections.Immutable" version="8.0.0" targetFramework="net48" />
|
<package id="System.Collections.Immutable" version="8.0.0" targetFramework="net48" />
|
||||||
<package id="System.Diagnostics.DiagnosticSource" version="8.0.0" targetFramework="net48" />
|
<package id="System.Diagnostics.DiagnosticSource" version="8.0.0" targetFramework="net48" />
|
||||||
|
BIN
packages/BouncyCastle.1.8.3.1/.signature.p7s
vendored
Normal file
BIN
packages/BouncyCastle.1.8.3.1/.signature.p7s
vendored
Normal file
Binary file not shown.
BIN
packages/BouncyCastle.1.8.3.1/BouncyCastle.1.8.3.1.nupkg
vendored
Normal file
BIN
packages/BouncyCastle.1.8.3.1/BouncyCastle.1.8.3.1.nupkg
vendored
Normal file
Binary file not shown.
30
packages/BouncyCastle.1.8.3.1/README.md
vendored
Normal file
30
packages/BouncyCastle.1.8.3.1/README.md
vendored
Normal file
@ -0,0 +1,30 @@
|
|||||||
|
# The Bouncy Castle Crypto Package For C Sharp
|
||||||
|
|
||||||
|
The Bouncy Castle Crypto package is a C\# implementation of cryptographic algorithms and protocols, it was developed by the Legion of the Bouncy Castle, a registered Australian Charity, with a little help! The Legion, and the latest goings on with this package, can be found at [http://www.bouncycastle.org](http://www.bouncycastle.org). In addition to providing basic cryptography algorithms, the package also provides support for CMS, TSP, X.509 certificate generation and a variety of other standards such as OpenPGP.
|
||||||
|
|
||||||
|
The Legion also gratefully acknowledges the contributions made to this package by others (see [here](http://www.bouncycastle.org/csharp/contributors.html) for the current list). If you would like to contribute to our efforts please feel free to get in touch with us or visit our [donations page](https://www.bouncycastle.org/donate), sponsor some specific work, or purchase a support contract through [Crypto Workshop](http://www.cryptoworkshop.com).
|
||||||
|
|
||||||
|
Except where otherwise stated, this software is distributed under a license based on the MIT X Consortium license. To view the license, [see here](http://www.bouncycastle.org/licence.html). The OpenPGP library also includes a modified BZIP2 library which is licensed under the [Apache Software License, Version 2.0](http://www.apache.org/licenses/).
|
||||||
|
|
||||||
|
**Note**: this source tree is not the FIPS version of the APIs - if you are interested in our FIPS version please contact us directly at [office@bouncycastle.org](mailto:office@bouncycastle.org).
|
||||||
|
|
||||||
|
## Mailing Lists
|
||||||
|
|
||||||
|
For those who are interested, there are 2 mailing lists for participation in this project. To subscribe use the links below and include the word subscribe in the message body. (To unsubscribe, replace **subscribe** with **unsubscribe** in the message body)
|
||||||
|
|
||||||
|
* [announce-crypto-csharp-request@bouncycastle.org](mailto:announce-crypto-csharp-request@bouncycastle.org)
|
||||||
|
This mailing list is for new release announcements only, general subscribers cannot post to it.
|
||||||
|
* [dev-crypto-csharp-request@bouncycastle.org](mailto:dev-crypto-csharp-request@bouncycastle.org)
|
||||||
|
This mailing list is for discussion of development of the package. This includes bugs, comments, requests for enhancements, questions about use or operation.
|
||||||
|
|
||||||
|
**NOTE:**You need to be subscribed to send mail to the above mailing list.
|
||||||
|
|
||||||
|
## Feedback
|
||||||
|
|
||||||
|
If you want to provide feedback directly to the members of **The Legion** then please use [feedback-crypto@bouncycastle.org](mailto:feedback-crypto@bouncycastle.org), if you want to help this project survive please consider [donating](https://www.bouncycastle.org/donate).
|
||||||
|
|
||||||
|
For bug reporting/requests you can report issues here on github, via feedback-crypto if required, and we also have a [Jira issue tracker](http://www.bouncycastle.org/jira). We will accept pull requests based on this repository as well.
|
||||||
|
|
||||||
|
## Finally
|
||||||
|
|
||||||
|
Enjoy!
|
BIN
packages/BouncyCastle.1.8.3.1/lib/BouncyCastle.Crypto.dll
vendored
Normal file
BIN
packages/BouncyCastle.1.8.3.1/lib/BouncyCastle.Crypto.dll
vendored
Normal file
Binary file not shown.
BIN
packages/Google.Protobuf.3.6.1/.signature.p7s
vendored
Normal file
BIN
packages/Google.Protobuf.3.6.1/.signature.p7s
vendored
Normal file
Binary file not shown.
BIN
packages/Google.Protobuf.3.6.1/Google.Protobuf.3.6.1.nupkg
vendored
Normal file
BIN
packages/Google.Protobuf.3.6.1/Google.Protobuf.3.6.1.nupkg
vendored
Normal file
Binary file not shown.
BIN
packages/Google.Protobuf.3.6.1/lib/net45/Google.Protobuf.dll
vendored
Normal file
BIN
packages/Google.Protobuf.3.6.1/lib/net45/Google.Protobuf.dll
vendored
Normal file
Binary file not shown.
7548
packages/Google.Protobuf.3.6.1/lib/net45/Google.Protobuf.xml
vendored
Normal file
7548
packages/Google.Protobuf.3.6.1/lib/net45/Google.Protobuf.xml
vendored
Normal file
File diff suppressed because it is too large
Load Diff
BIN
packages/Google.Protobuf.3.6.1/lib/netstandard1.0/Google.Protobuf.dll
vendored
Normal file
BIN
packages/Google.Protobuf.3.6.1/lib/netstandard1.0/Google.Protobuf.dll
vendored
Normal file
Binary file not shown.
7548
packages/Google.Protobuf.3.6.1/lib/netstandard1.0/Google.Protobuf.xml
vendored
Normal file
7548
packages/Google.Protobuf.3.6.1/lib/netstandard1.0/Google.Protobuf.xml
vendored
Normal file
File diff suppressed because it is too large
Load Diff
BIN
packages/K4os.Compression.LZ4.1.1.11/.signature.p7s
vendored
Normal file
BIN
packages/K4os.Compression.LZ4.1.1.11/.signature.p7s
vendored
Normal file
Binary file not shown.
BIN
packages/K4os.Compression.LZ4.1.1.11/K4os.Compression.LZ4.1.1.11.nupkg
vendored
Normal file
BIN
packages/K4os.Compression.LZ4.1.1.11/K4os.Compression.LZ4.1.1.11.nupkg
vendored
Normal file
Binary file not shown.
BIN
packages/K4os.Compression.LZ4.1.1.11/lib/net45/K4os.Compression.LZ4.dll
vendored
Normal file
BIN
packages/K4os.Compression.LZ4.1.1.11/lib/net45/K4os.Compression.LZ4.dll
vendored
Normal file
Binary file not shown.
794
packages/K4os.Compression.LZ4.1.1.11/lib/net45/K4os.Compression.LZ4.xml
vendored
Normal file
794
packages/K4os.Compression.LZ4.1.1.11/lib/net45/K4os.Compression.LZ4.xml
vendored
Normal file
@ -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
packages/K4os.Compression.LZ4.1.1.11/lib/net46/K4os.Compression.LZ4.dll
vendored
Normal file
BIN
packages/K4os.Compression.LZ4.1.1.11/lib/net46/K4os.Compression.LZ4.dll
vendored
Normal file
Binary file not shown.
794
packages/K4os.Compression.LZ4.1.1.11/lib/net46/K4os.Compression.LZ4.xml
vendored
Normal file
794
packages/K4os.Compression.LZ4.1.1.11/lib/net46/K4os.Compression.LZ4.xml
vendored
Normal file
@ -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
packages/K4os.Compression.LZ4.1.1.11/lib/netstandard1.6/K4os.Compression.LZ4.dll
vendored
Normal file
BIN
packages/K4os.Compression.LZ4.1.1.11/lib/netstandard1.6/K4os.Compression.LZ4.dll
vendored
Normal file
Binary file not shown.
794
packages/K4os.Compression.LZ4.1.1.11/lib/netstandard1.6/K4os.Compression.LZ4.xml
vendored
Normal file
794
packages/K4os.Compression.LZ4.1.1.11/lib/netstandard1.6/K4os.Compression.LZ4.xml
vendored
Normal file
@ -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
packages/K4os.Compression.LZ4.1.1.11/lib/netstandard2.0/K4os.Compression.LZ4.dll
vendored
Normal file
BIN
packages/K4os.Compression.LZ4.1.1.11/lib/netstandard2.0/K4os.Compression.LZ4.dll
vendored
Normal file
Binary file not shown.
794
packages/K4os.Compression.LZ4.1.1.11/lib/netstandard2.0/K4os.Compression.LZ4.xml
vendored
Normal file
794
packages/K4os.Compression.LZ4.1.1.11/lib/netstandard2.0/K4os.Compression.LZ4.xml
vendored
Normal file
@ -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
packages/K4os.Compression.LZ4.Streams.1.1.11/.signature.p7s
vendored
Normal file
BIN
packages/K4os.Compression.LZ4.Streams.1.1.11/.signature.p7s
vendored
Normal file
Binary file not shown.
BIN
packages/K4os.Compression.LZ4.Streams.1.1.11/K4os.Compression.LZ4.Streams.1.1.11.nupkg
vendored
Normal file
BIN
packages/K4os.Compression.LZ4.Streams.1.1.11/K4os.Compression.LZ4.Streams.1.1.11.nupkg
vendored
Normal file
Binary file not shown.
BIN
packages/K4os.Compression.LZ4.Streams.1.1.11/lib/net45/K4os.Compression.LZ4.Streams.dll
vendored
Normal file
BIN
packages/K4os.Compression.LZ4.Streams.1.1.11/lib/net45/K4os.Compression.LZ4.Streams.dll
vendored
Normal file
Binary file not shown.
296
packages/K4os.Compression.LZ4.Streams.1.1.11/lib/net45/K4os.Compression.LZ4.Streams.xml
vendored
Normal file
296
packages/K4os.Compression.LZ4.Streams.1.1.11/lib/net45/K4os.Compression.LZ4.Streams.xml
vendored
Normal file
@ -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
packages/K4os.Compression.LZ4.Streams.1.1.11/lib/net46/K4os.Compression.LZ4.Streams.dll
vendored
Normal file
BIN
packages/K4os.Compression.LZ4.Streams.1.1.11/lib/net46/K4os.Compression.LZ4.Streams.dll
vendored
Normal file
Binary file not shown.
296
packages/K4os.Compression.LZ4.Streams.1.1.11/lib/net46/K4os.Compression.LZ4.Streams.xml
vendored
Normal file
296
packages/K4os.Compression.LZ4.Streams.1.1.11/lib/net46/K4os.Compression.LZ4.Streams.xml
vendored
Normal file
@ -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
packages/K4os.Compression.LZ4.Streams.1.1.11/lib/netstandard1.6/K4os.Compression.LZ4.Streams.dll
vendored
Normal file
BIN
packages/K4os.Compression.LZ4.Streams.1.1.11/lib/netstandard1.6/K4os.Compression.LZ4.Streams.dll
vendored
Normal file
Binary file not shown.
296
packages/K4os.Compression.LZ4.Streams.1.1.11/lib/netstandard1.6/K4os.Compression.LZ4.Streams.xml
vendored
Normal file
296
packages/K4os.Compression.LZ4.Streams.1.1.11/lib/netstandard1.6/K4os.Compression.LZ4.Streams.xml
vendored
Normal file
@ -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
packages/K4os.Compression.LZ4.Streams.1.1.11/lib/netstandard2.0/K4os.Compression.LZ4.Streams.dll
vendored
Normal file
BIN
packages/K4os.Compression.LZ4.Streams.1.1.11/lib/netstandard2.0/K4os.Compression.LZ4.Streams.dll
vendored
Normal file
Binary file not shown.
296
packages/K4os.Compression.LZ4.Streams.1.1.11/lib/netstandard2.0/K4os.Compression.LZ4.Streams.xml
vendored
Normal file
296
packages/K4os.Compression.LZ4.Streams.1.1.11/lib/netstandard2.0/K4os.Compression.LZ4.Streams.xml
vendored
Normal file
@ -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
packages/K4os.Hash.xxHash.1.0.6/.signature.p7s
vendored
Normal file
BIN
packages/K4os.Hash.xxHash.1.0.6/.signature.p7s
vendored
Normal file
Binary file not shown.
BIN
packages/K4os.Hash.xxHash.1.0.6/K4os.Hash.xxHash.1.0.6.nupkg
vendored
Normal file
BIN
packages/K4os.Hash.xxHash.1.0.6/K4os.Hash.xxHash.1.0.6.nupkg
vendored
Normal file
Binary file not shown.
BIN
packages/K4os.Hash.xxHash.1.0.6/lib/net45/K4os.Hash.xxHash.dll
vendored
Normal file
BIN
packages/K4os.Hash.xxHash.1.0.6/lib/net45/K4os.Hash.xxHash.dll
vendored
Normal file
Binary file not shown.
163
packages/K4os.Hash.xxHash.1.0.6/lib/net45/K4os.Hash.xxHash.xml
vendored
Normal file
163
packages/K4os.Hash.xxHash.1.0.6/lib/net45/K4os.Hash.xxHash.xml
vendored
Normal file
@ -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
packages/K4os.Hash.xxHash.1.0.6/lib/net46/K4os.Hash.xxHash.dll
vendored
Normal file
BIN
packages/K4os.Hash.xxHash.1.0.6/lib/net46/K4os.Hash.xxHash.dll
vendored
Normal file
Binary file not shown.
163
packages/K4os.Hash.xxHash.1.0.6/lib/net46/K4os.Hash.xxHash.xml
vendored
Normal file
163
packages/K4os.Hash.xxHash.1.0.6/lib/net46/K4os.Hash.xxHash.xml
vendored
Normal file
@ -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
packages/K4os.Hash.xxHash.1.0.6/lib/netstandard1.6/K4os.Hash.xxHash.dll
vendored
Normal file
BIN
packages/K4os.Hash.xxHash.1.0.6/lib/netstandard1.6/K4os.Hash.xxHash.dll
vendored
Normal file
Binary file not shown.
163
packages/K4os.Hash.xxHash.1.0.6/lib/netstandard1.6/K4os.Hash.xxHash.xml
vendored
Normal file
163
packages/K4os.Hash.xxHash.1.0.6/lib/netstandard1.6/K4os.Hash.xxHash.xml
vendored
Normal file
@ -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
packages/K4os.Hash.xxHash.1.0.6/lib/netstandard2.0/K4os.Hash.xxHash.dll
vendored
Normal file
BIN
packages/K4os.Hash.xxHash.1.0.6/lib/netstandard2.0/K4os.Hash.xxHash.dll
vendored
Normal file
Binary file not shown.
163
packages/K4os.Hash.xxHash.1.0.6/lib/netstandard2.0/K4os.Hash.xxHash.xml
vendored
Normal file
163
packages/K4os.Hash.xxHash.1.0.6/lib/netstandard2.0/K4os.Hash.xxHash.xml
vendored
Normal file
@ -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
packages/MySql.Data.8.0.20/.signature.p7s
vendored
Normal file
BIN
packages/MySql.Data.8.0.20/.signature.p7s
vendored
Normal file
Binary file not shown.
BIN
packages/MySql.Data.8.0.20/MySql.Data.8.0.20.nupkg
vendored
Normal file
BIN
packages/MySql.Data.8.0.20/MySql.Data.8.0.20.nupkg
vendored
Normal file
Binary file not shown.
BIN
packages/MySql.Data.8.0.20/lib/net452/MySql.Data.dll
vendored
Normal file
BIN
packages/MySql.Data.8.0.20/lib/net452/MySql.Data.dll
vendored
Normal file
Binary file not shown.
17757
packages/MySql.Data.8.0.20/lib/net452/MySql.Data.xml
vendored
Normal file
17757
packages/MySql.Data.8.0.20/lib/net452/MySql.Data.xml
vendored
Normal file
File diff suppressed because it is too large
Load Diff
BIN
packages/MySql.Data.8.0.20/lib/net452/Ubiety.Dns.Core.dll
vendored
Normal file
BIN
packages/MySql.Data.8.0.20/lib/net452/Ubiety.Dns.Core.dll
vendored
Normal file
Binary file not shown.
BIN
packages/MySql.Data.8.0.20/lib/net452/Zstandard.Net.dll
vendored
Normal file
BIN
packages/MySql.Data.8.0.20/lib/net452/Zstandard.Net.dll
vendored
Normal file
Binary file not shown.
BIN
packages/MySql.Data.8.0.20/lib/net48/MySql.Data.dll
vendored
Normal file
BIN
packages/MySql.Data.8.0.20/lib/net48/MySql.Data.dll
vendored
Normal file
Binary file not shown.
17757
packages/MySql.Data.8.0.20/lib/net48/MySql.Data.xml
vendored
Normal file
17757
packages/MySql.Data.8.0.20/lib/net48/MySql.Data.xml
vendored
Normal file
File diff suppressed because it is too large
Load Diff
BIN
packages/MySql.Data.8.0.20/lib/net48/Ubiety.Dns.Core.dll
vendored
Normal file
BIN
packages/MySql.Data.8.0.20/lib/net48/Ubiety.Dns.Core.dll
vendored
Normal file
Binary file not shown.
BIN
packages/MySql.Data.8.0.20/lib/net48/Zstandard.Net.dll
vendored
Normal file
BIN
packages/MySql.Data.8.0.20/lib/net48/Zstandard.Net.dll
vendored
Normal file
Binary file not shown.
BIN
packages/MySql.Data.8.0.20/lib/netstandard2.0/MySql.Data.dll
vendored
Normal file
BIN
packages/MySql.Data.8.0.20/lib/netstandard2.0/MySql.Data.dll
vendored
Normal file
Binary file not shown.
17737
packages/MySql.Data.8.0.20/lib/netstandard2.0/MySql.Data.xml
vendored
Normal file
17737
packages/MySql.Data.8.0.20/lib/netstandard2.0/MySql.Data.xml
vendored
Normal file
File diff suppressed because it is too large
Load Diff
BIN
packages/MySql.Data.8.0.20/lib/netstandard2.0/Ubiety.Dns.Core.dll
vendored
Normal file
BIN
packages/MySql.Data.8.0.20/lib/netstandard2.0/Ubiety.Dns.Core.dll
vendored
Normal file
Binary file not shown.
BIN
packages/MySql.Data.8.0.20/lib/netstandard2.0/Zstandard.Net.dll
vendored
Normal file
BIN
packages/MySql.Data.8.0.20/lib/netstandard2.0/Zstandard.Net.dll
vendored
Normal file
Binary file not shown.
BIN
packages/MySql.Data.8.0.20/lib/netstandard2.1/MySql.Data.dll
vendored
Normal file
BIN
packages/MySql.Data.8.0.20/lib/netstandard2.1/MySql.Data.dll
vendored
Normal file
Binary file not shown.
17737
packages/MySql.Data.8.0.20/lib/netstandard2.1/MySql.Data.xml
vendored
Normal file
17737
packages/MySql.Data.8.0.20/lib/netstandard2.1/MySql.Data.xml
vendored
Normal file
File diff suppressed because it is too large
Load Diff
BIN
packages/MySql.Data.8.0.20/lib/netstandard2.1/Ubiety.Dns.Core.dll
vendored
Normal file
BIN
packages/MySql.Data.8.0.20/lib/netstandard2.1/Ubiety.Dns.Core.dll
vendored
Normal file
Binary file not shown.
BIN
packages/MySql.Data.8.0.20/lib/netstandard2.1/Zstandard.Net.dll
vendored
Normal file
BIN
packages/MySql.Data.8.0.20/lib/netstandard2.1/Zstandard.Net.dll
vendored
Normal file
Binary file not shown.
BIN
packages/SSH.NET.2016.1.0/.signature.p7s
vendored
Normal file
BIN
packages/SSH.NET.2016.1.0/.signature.p7s
vendored
Normal file
Binary file not shown.
BIN
packages/SSH.NET.2016.1.0/SSH.NET.2016.1.0.nupkg
vendored
Normal file
BIN
packages/SSH.NET.2016.1.0/SSH.NET.2016.1.0.nupkg
vendored
Normal file
Binary file not shown.
BIN
packages/SSH.NET.2016.1.0/lib/net35/Renci.SshNet.dll
vendored
Normal file
BIN
packages/SSH.NET.2016.1.0/lib/net35/Renci.SshNet.dll
vendored
Normal file
Binary file not shown.
19524
packages/SSH.NET.2016.1.0/lib/net35/Renci.SshNet.xml
vendored
Normal file
19524
packages/SSH.NET.2016.1.0/lib/net35/Renci.SshNet.xml
vendored
Normal file
File diff suppressed because it is too large
Load Diff
BIN
packages/SSH.NET.2016.1.0/lib/net40/Renci.SshNet.dll
vendored
Normal file
BIN
packages/SSH.NET.2016.1.0/lib/net40/Renci.SshNet.dll
vendored
Normal file
Binary file not shown.
19415
packages/SSH.NET.2016.1.0/lib/net40/Renci.SshNet.xml
vendored
Normal file
19415
packages/SSH.NET.2016.1.0/lib/net40/Renci.SshNet.xml
vendored
Normal file
File diff suppressed because it is too large
Load Diff
BIN
packages/SSH.NET.2016.1.0/lib/netstandard1.3/Renci.SshNet.dll
vendored
Normal file
BIN
packages/SSH.NET.2016.1.0/lib/netstandard1.3/Renci.SshNet.dll
vendored
Normal file
Binary file not shown.
19325
packages/SSH.NET.2016.1.0/lib/netstandard1.3/Renci.SshNet.xml
vendored
Normal file
19325
packages/SSH.NET.2016.1.0/lib/netstandard1.3/Renci.SshNet.xml
vendored
Normal file
File diff suppressed because it is too large
Load Diff
BIN
packages/SSH.NET.2016.1.0/lib/sl4/Renci.SshNet.dll
vendored
Normal file
BIN
packages/SSH.NET.2016.1.0/lib/sl4/Renci.SshNet.dll
vendored
Normal file
Binary file not shown.
19008
packages/SSH.NET.2016.1.0/lib/sl4/Renci.SshNet.xml
vendored
Normal file
19008
packages/SSH.NET.2016.1.0/lib/sl4/Renci.SshNet.xml
vendored
Normal file
File diff suppressed because it is too large
Load Diff
BIN
packages/SSH.NET.2016.1.0/lib/sl5/Renci.SshNet.dll
vendored
Normal file
BIN
packages/SSH.NET.2016.1.0/lib/sl5/Renci.SshNet.dll
vendored
Normal file
Binary file not shown.
19008
packages/SSH.NET.2016.1.0/lib/sl5/Renci.SshNet.xml
vendored
Normal file
19008
packages/SSH.NET.2016.1.0/lib/sl5/Renci.SshNet.xml
vendored
Normal file
File diff suppressed because it is too large
Load Diff
BIN
packages/SSH.NET.2016.1.0/lib/uap10/Renci.SshNet.dll
vendored
Normal file
BIN
packages/SSH.NET.2016.1.0/lib/uap10/Renci.SshNet.dll
vendored
Normal file
Binary file not shown.
19120
packages/SSH.NET.2016.1.0/lib/uap10/Renci.SshNet.xml
vendored
Normal file
19120
packages/SSH.NET.2016.1.0/lib/uap10/Renci.SshNet.xml
vendored
Normal file
File diff suppressed because it is too large
Load Diff
BIN
packages/SSH.NET.2016.1.0/lib/wp71/Renci.SshNet.dll
vendored
Normal file
BIN
packages/SSH.NET.2016.1.0/lib/wp71/Renci.SshNet.dll
vendored
Normal file
Binary file not shown.
18979
packages/SSH.NET.2016.1.0/lib/wp71/Renci.SshNet.xml
vendored
Normal file
18979
packages/SSH.NET.2016.1.0/lib/wp71/Renci.SshNet.xml
vendored
Normal file
File diff suppressed because it is too large
Load Diff
BIN
packages/SSH.NET.2016.1.0/lib/wp8/Renci.SshNet.dll
vendored
Normal file
BIN
packages/SSH.NET.2016.1.0/lib/wp8/Renci.SshNet.dll
vendored
Normal file
Binary file not shown.
18961
packages/SSH.NET.2016.1.0/lib/wp8/Renci.SshNet.xml
vendored
Normal file
18961
packages/SSH.NET.2016.1.0/lib/wp8/Renci.SshNet.xml
vendored
Normal file
File diff suppressed because it is too large
Load Diff
Loading…
x
Reference in New Issue
Block a user