12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211 |
- <?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="M:K4os.Compression.LZ4.Encoders.ILZ4Decoder.Peek(System.Int32)">
- <summary>
- Peeks at previously decoded bytes. Please note, <paramref name="offset"/> should be
- negative number, pointing to bytes before current head.
- </summary>
- <param name="offset">Offset in source buffer relatively to current head.
- Please note, it should be negative value.</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. Please 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="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="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.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.Peek(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.Peek(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.TopupAndEncode(K4os.Compression.LZ4.Encoders.ILZ4Encoder,System.ReadOnlySpan{System.Byte},System.Span{System.Byte},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="target">Target buffer (used to encode into)</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.FlushAndEncode(K4os.Compression.LZ4.Encoders.ILZ4Encoder,System.Span{System.Byte},System.Boolean,System.Int32@)">
- <summary>Encoded remaining bytes in encoder.</summary>
- <param name="encoder">Encoder.</param>
- <param name="target">Target buffer.</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.Drain(K4os.Compression.LZ4.Encoders.ILZ4Decoder,System.Span{System.Byte},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="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="M:K4os.Compression.LZ4.Encoders.LZ4EncoderExtensions.DecodeAndDrain(K4os.Compression.LZ4.Encoders.ILZ4Decoder,System.ReadOnlySpan{System.Byte},System.Span{System.Byte},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="target">Target buffer (to drained into).</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.Inject(K4os.Compression.LZ4.Encoders.ILZ4Decoder,System.Byte[],System.Int32,System.Int32)">
- <summary>
- Inject already decompressed block and caches it in decoder.
- Used with uncompressed-yet-chained blocks and pre-made dictionaries.
- See <see cref="M:K4os.Compression.LZ4.Encoders.ILZ4Decoder.Inject(System.Byte*,System.Int32)"/>.
- </summary>
- <param name="decoder">Decoder.</param>
- <param name="buffer">Uncompressed block.</param>
- <param name="offset">Offset in 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.LZ4EncoderExtensions.Decode(K4os.Compression.LZ4.Encoders.ILZ4Decoder,System.Byte[],System.Int32,System.Int32,System.Int32)">
- <summary>
- Decodes previously compressed block and caches decompressed block in decoder.
- Returns number of bytes decoded.
- See <see cref="M:K4os.Compression.LZ4.Encoders.ILZ4Decoder.Decode(System.Byte*,System.Int32,System.Int32)"/>.
- </summary>
- <param name="decoder">Decoder.</param>
- <param name="buffer">Compressed block.</param>
- <param name="offset">Offset in 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="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.Engine.Algorithm">
- <summary>Algorithm selection.</summary>
- </member>
- <member name="F:K4os.Compression.LZ4.Engine.Algorithm.X32">
- <summary>Intel and ARMv7 version of 32 bit algorithm.</summary>
- </member>
- <member name="F:K4os.Compression.LZ4.Engine.Algorithm.X64">
- <summary>Intel version of 64 bit algorithm.</summary>
- </member>
- <member name="P:K4os.Compression.LZ4.Engine.LL.Algorithm">
- <summary>Checks what algorithm should be used (32 vs 64 bit).</summary>
- </member>
- <member name="T:K4os.Compression.LZ4.Engine.Pubternal">
- <summary>
- Existence of this class is an admission of failure.
- I failed to export internals to test assemblies.
- Using InternalsVisibleTo work, of course, but with signing (which was requested
- in https://github.com/MiloszKrajewski/K4os.Compression.LZ4/issues/9) it is
- absolute PITA. So no, I'm not using InternalsVisibleTo I will just expose this
- little class with some "redirects" to real internals.
- </summary>
- </member>
- <member name="T:K4os.Compression.LZ4.Engine.Pubternal.FastContext">
- <summary>Pubternal wrapper for LZ4_stream_t.</summary>
- </member>
- <member name="M:K4os.Compression.LZ4.Engine.Pubternal.FastContext.#ctor">
- <summary>Creates new instance of wrapper for LZ4_stream_t.</summary>
- </member>
- <member name="M:K4os.Compression.LZ4.Engine.Pubternal.FastContext.ReleaseUnmanaged">
- <inheritdoc/>
- </member>
- <member name="M:K4os.Compression.LZ4.Engine.Pubternal.CompressFast(K4os.Compression.LZ4.Engine.Pubternal.FastContext,System.Byte*,System.Byte*,System.Int32,System.Int32,System.Int32)">
- <summary>
- Compresses chunk of data using LZ4_compress_fast_continue.
- </summary>
- <param name="context">Wrapper for LZ4_stream_t</param>
- <param name="source">Source block address.</param>
- <param name="target">Target block address.</param>
- <param name="sourceLength">Source block length.</param>
- <param name="targetLength">Target block length.</param>
- <param name="acceleration">Acceleration.</param>
- <returns>Number of bytes actually written to target.</returns>
- </member>
- <member name="T:K4os.Compression.LZ4.Internal.BufferPool">
- <summary>
- Naive wrapper around ArrayPool. Makes calls if something should be pooled.
- </summary>
- </member>
- <member name="F:K4os.Compression.LZ4.Internal.BufferPool.MinPooledSize">
- <summary>Minimum size of the buffer that can be pooled.</summary>
- </member>
- <member name="M:K4os.Compression.LZ4.Internal.BufferPool.Alloc(System.Int32,System.Boolean)">
- <summary>Allocate temporary buffer to store decompressed data.</summary>
- <param name="size">Minimum size of the buffer.</param>
- <param name="zero">Clear all data.</param>
- <returns>Allocated buffer.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Internal.BufferPool.IsPooled(System.Byte[])">
- <summary>
- Determines if buffer was pooled or not.
- The logic is quite simple: if buffer is smaller than 512 bytes are pooled.
- </summary>
- <param name="buffer">Buffer.</param>
- <returns><c>true</c> if buffer was pooled; <c>false</c> otherwise</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Internal.BufferPool.Free(System.Byte[])">
- <summary>Releases allocated buffer. <see cref="M:K4os.Compression.LZ4.Internal.BufferPool.Alloc(System.Int32,System.Boolean)"/></summary>
- <param name="buffer">Previously allocated buffer.</param>
- </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="P:K4os.Compression.LZ4.Internal.Mem.System32">
- <summary>Checks if process is ran in 32-bit mode.</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.CpBlk(System.Void*,System.Void*,System.UInt32)">
- <summary>
- Copies memory block for <paramref name="source"/> to <paramref name="target"/>.
- </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.ZBlk(System.Void*,System.Byte,System.UInt32)">
- <summary>
- Fills <paramref name="target"/> memory block with predefined <paramref name="value"/>.
- </summary>
- <param name="target">The target block address.</param>
- <param name="value">Value to be used.</param>
- <param name="length">Length in bytes.</param>
- </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"/>.
- </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.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.Zero(System.Byte*,System.Int32)">
- <summary>Fill block of memory with zeroes.</summary>
- <param name="target">Address.</param>
- <param name="length">Length.</param>
- <returns>Original pointer.</returns>
- </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>
- <returns>Original pointer.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Internal.Mem.AllocZero(System.Int32)">
- <summary>Allocates 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)"/>.</summary>
- <param name="ptr">Pointer to allocated block.</param>
- </member>
- <member name="M:K4os.Compression.LZ4.Internal.Mem.CloneArray``1(``0[])">
- <summary>Clones managed array to unmanaged one.
- Allows quicker yet less safe unchecked access.</summary>
- <param name="array">Input array.</param>
- <returns>Cloned array.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Internal.Mem.Peek1(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.Poke1(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.Peek2(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.Poke2(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.Peek4(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.Poke4(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.Peek8(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.UInt64)">
- <summary>Writes exactly 8 bytes to given address.</summary>
- <param name="p">Address.</param>
- <param name="v">Value.</param>
- </member>
- <member name="M:K4os.Compression.LZ4.Internal.Mem.Copy1(System.Byte*,System.Byte*)">
- <summary>Copies exactly 1 byte 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.Copy2(System.Byte*,System.Byte*)">
- <summary>Copies exactly 2 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.Copy4(System.Byte*,System.Byte*)">
- <summary>Copies exactly 4 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.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="T:K4os.Compression.LZ4.Internal.PinnedMemory">
- <summary>
- Represents pinned memory.
- It either points to unmanaged memory or block of memory from shared array pool.
- When disposed, it handles it appropriately.
- </summary>
- </member>
- <member name="P:K4os.Compression.LZ4.Internal.PinnedMemory.MaxPooledSize">
- <summary>
- Maximum size of the buffer that can be pooled from shared array pool.
- </summary>
- </member>
- <member name="P:K4os.Compression.LZ4.Internal.PinnedMemory.Pointer">
- <summary>Pointer to block of bytes.</summary>
- </member>
- <member name="P:K4os.Compression.LZ4.Internal.PinnedMemory.Span">
- <summary>Pointer to block of bytes as span.</summary>
- </member>
- <member name="M:K4os.Compression.LZ4.Internal.PinnedMemory.Reference``1">
- <summary>Pointer to block of bytes.</summary>
- </member>
- <member name="M:K4os.Compression.LZ4.Internal.PinnedMemory.Alloc(System.Int32,System.Boolean)">
- <summary>
- Allocates pinned block of memory, depending on the size it tries to use shared array pool.
- </summary>
- <param name="size">Size in bytes.</param>
- <param name="zero">Indicates if block should be zeroed.</param>
- <returns>Allocated <see cref="T:K4os.Compression.LZ4.Internal.PinnedMemory"/>.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException"></exception>
- </member>
- <member name="M:K4os.Compression.LZ4.Internal.PinnedMemory.Alloc(K4os.Compression.LZ4.Internal.PinnedMemory@,System.Int32,System.Boolean)">
- <summary>
- Allocates pinned block of memory, depending on the size it tries to use shared array pool.
- </summary>
- <param name="memory">Pinned memory pointer.</param>
- <param name="size">Size in bytes.</param>
- <param name="zero">Indicates if block should be zeroed.</param>
- <returns>Allocated <see cref="T:K4os.Compression.LZ4.Internal.PinnedMemory"/>.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException"></exception>
- </member>
- <member name="M:K4os.Compression.LZ4.Internal.PinnedMemory.Alloc``1(K4os.Compression.LZ4.Internal.PinnedMemory@,System.Boolean)">
- <summary>
- Allocates pinned block of memory for one item from shared array pool.
- </summary>
- <param name="memory">PinnedMemory pointer.</param>
- <param name="zero">Indicates if block should be zeroed.</param>
- <typeparam name="T">Type of item.</typeparam>
- </member>
- <member name="M:K4os.Compression.LZ4.Internal.PinnedMemory.Clear">
- <summary>Fill allocated block of memory with zeros.</summary>
- </member>
- <member name="M:K4os.Compression.LZ4.Internal.PinnedMemory.Free">
- <summary>
- Releases the memory.
- </summary>
- </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.Internal.Mem32">
- <summary>Unsafe memory operations.</summary>
- </member>
- <member name="M:K4os.Compression.LZ4.Internal.Mem32.PeekW(System.Void*)">
- <summary>Reads 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.Mem32.PokeW(System.Void*,System.UInt32)">
- <summary>Writes 4 or 8 bytes to given address.</summary>
- <param name="p">Address.</param>
- <param name="v">Value.</param>
- </member>
- <member name="M:K4os.Compression.LZ4.Internal.Mem32.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.Mem32.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.Mem32.WildCopy8(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.Mem32.WildCopy32(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 32 bytes more than expected.
- This version copies two times 16 bytes (instead of one time 32 bytes)
- because it must be compatible with offsets >= 16.
- </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="T:K4os.Compression.LZ4.Internal.Mem64">
- <summary>Unsafe memory operations.</summary>
- </member>
- <member name="M:K4os.Compression.LZ4.Internal.Mem64.Peek2(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.Mem64.Poke2(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.Mem64.Peek4(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.Mem64.Poke4(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.Mem64.Copy1(System.Byte*,System.Byte*)">
- <summary>Copies exactly 1 byte 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.Mem64.Copy2(System.Byte*,System.Byte*)">
- <summary>Copies exactly 2 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.Mem64.Copy4(System.Byte*,System.Byte*)">
- <summary>Copies exactly 4 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.Mem64.Peek8(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.Mem64.Poke8(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="M:K4os.Compression.LZ4.Internal.Mem64.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.Mem64.PeekW(System.Void*)">
- <summary>Reads 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.Mem64.PokeW(System.Void*,System.UInt64)">
- <summary>Writes 8 bytes to given address.</summary>
- <param name="p">Address.</param>
- <param name="v">Value.</param>
- </member>
- <member name="M:K4os.Compression.LZ4.Internal.Mem64.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.Mem64.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.Mem64.WildCopy8(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.Mem64.WildCopy32(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 32 bytes more than expected.
- This version copies two times 16 bytes (instead of one time 32 bytes)
- because it must be compatible with offsets >= 16.
- </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="T:K4os.Compression.LZ4.LZ4Codec">
- <summary>
- Static class exposing LZ4 block compression methods.
- </summary>
- </member>
- <member name="F:K4os.Compression.LZ4.LZ4Codec.Version">
- <summary>Version of LZ4 implementation.</summary>
- </member>
- <member name="P:K4os.Compression.LZ4.LZ4Codec.Enforce32">
- <summary>
- Enforces 32-bit compression/decompression algorithm even on 64-bit systems.
- Please note, this property should not be used on regular basis, it just allows
- to workaround some problems on platforms which do not support 64-bit the same was
- as Intel (for example: unaligned read/writes).
- </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.Byte*,System.Int32,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>
- <param name="dictionary">Dictionary buffer.</param>
- <param name="dictionaryLength">Dictionary 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.ReadOnlySpan{System.Byte},System.Span{System.Byte},System.ReadOnlySpan{System.Byte})">
- <summary>Decompresses data from given buffer.</summary>
- <param name="source">Input buffer.</param>
- <param name="target">Output buffer.</param>
- <param name="dictionary">Dictionary 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="M:K4os.Compression.LZ4.LZ4Codec.Decode(System.Byte[],System.Int32,System.Int32,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>
- <param name="dictionary">Dictionary buffer.</param>
- <param name="dictionaryOffset">Dictionary buffer offset.</param>
- <param name="dictionaryLength">Dictionary 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>
- <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="sourceIndex">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.Byte*,System.Int32,K4os.Compression.LZ4.LZ4Level)">
- <summary>Compresses input buffer into self-contained package.</summary>
- <param name="source">Input buffer.</param>
- <param name="length">Length of input data.</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``1(System.ReadOnlySpan{System.Byte},``0,K4os.Compression.LZ4.LZ4Level)">
- <summary>Compresses input buffer into self-contained package.</summary>
- <param name="source">Input buffer.</param>
- <param name="writer">Where the compressed data is written.</param>
- <param name="level">Compression level.</param>
- <returns>Output buffer.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.LZ4Pickler.Pickle(System.ReadOnlySpan{System.Byte},System.Buffers.IBufferWriter{System.Byte},K4os.Compression.LZ4.LZ4Level)">
- <summary>Compresses input buffer into self-contained package.</summary>
- <param name="source">Input buffer.</param>
- <param name="writer">Where the compressed data is written.</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="index">Input buffer offset.</param>
- <param name="count">Input buffer length.</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="count">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``1(System.ReadOnlySpan{System.Byte},``0)">
- <summary>Decompresses previously pickled buffer (see: <see cref="T:K4os.Compression.LZ4.LZ4Pickler"/>.</summary>
- <param name="source">Input buffer.</param>
- <param name="writer">Where the decompressed data is written.</param>
- </member>
- <member name="M:K4os.Compression.LZ4.LZ4Pickler.Unpickle(System.ReadOnlySpan{System.Byte},System.Buffers.IBufferWriter{System.Byte})">
- <summary>Decompresses previously pickled buffer (see: <see cref="T:K4os.Compression.LZ4.LZ4Pickler"/>.</summary>
- <param name="source">Input buffer.</param>
- <param name="writer">Where the decompressed data is written.</param>
- </member>
- <member name="M:K4os.Compression.LZ4.LZ4Pickler.UnpickledSize(System.ReadOnlySpan{System.Byte})">
- <summary>
- Returns the uncompressed size of a chunk of compressed data.
- </summary>
- <param name="source">The data to inspect.</param>
- <returns>The size in bytes of the data once unpickled.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.LZ4Pickler.UnpickledSize(K4os.Compression.LZ4.PickleHeader@)">
- <summary>
- Returns the uncompressed size of a chunk of compressed data.
- </summary>
- <param name="header">Decoded header.</param>
- <returns>The size in bytes of the data once unpickled.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.LZ4Pickler.Unpickle(System.ReadOnlySpan{System.Byte},System.Span{System.Byte})">
- <summary>Decompresses previously pickled buffer (see: <see cref="T:K4os.Compression.LZ4.LZ4Pickler"/>.</summary>
- <param name="source">Input buffer.</param>
- <param name="output">Where the decompressed data is written.</param>
- <remarks>
- You obtain the size of the output buffer by calling <see cref="M:K4os.Compression.LZ4.LZ4Pickler.UnpickledSize(System.ReadOnlySpan{System.Byte})"/>.
- </remarks>
- </member>
- </members>
- </doc>
|