123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689 |
- <?xml version="1.0"?>
- <doc>
- <assembly>
- <name>K4os.Compression.LZ4.Streams</name>
- </assembly>
- <members>
- <member name="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader">
- <summary>
- Generic interface for frame/stream decoder for LZ4.
- </summary>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader.OpenFrame">
- <summary>
- Opens frame for reading. Please note, this method is not needed as it will be
- called automatically, but it can be used to quickly check if frame is valid.
- </summary>
- <returns><c>true</c> if frame was just opened,
- <c>false</c> if it was opened before.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader.OpenFrameAsync(System.Threading.CancellationToken)">
- <summary>Async version of <see cref="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader.OpenFrame"/>.</summary>
- <param name="token">Cancellation token.</param>
- <returns><c>true</c> if frame was just opened,
- <c>false</c> if it was opened before.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader.GetFrameLength">
- <summary>Gets the length of the frame content if it was provided when content was encoded.</summary>
- <returns>Frame length, or <c>null</c></returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader.GetFrameLengthAsync(System.Threading.CancellationToken)">
- <summary>Async version of <see cref="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader.GetFrameLength"/>.</summary>
- <param name="token">Cancellation token.</param>
- <returns>Frame length, or <c>null</c></returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader.ReadOneByte">
- <summary>Reads one byte from LZ4 stream.</summary>
- <returns>A byte, or -1 if end of stream.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader.ReadOneByteAsync(System.Threading.CancellationToken)">
- <summary>Reads one byte from LZ4 stream.</summary>
- <param name="token">Cancellation token.</param>
- <returns>A byte, or -1 if end of stream.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader.ReadManyBytes(System.Span{System.Byte},System.Boolean)">
- <summary>Reads many bytes from LZ4 stream. Return number of bytes actually read.</summary>
- <param name="buffer">Byte buffer to read into.</param>
- <param name="interactive">if <c>true</c> then returns as soon as some bytes are read,
- if <c>false</c> then waits for all bytes being read or end of stream.</param>
- <returns>Number of bytes actually read.
- <c>0</c> means that end of stream has been reached.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader.ReadManyBytesAsync(System.Threading.CancellationToken,System.Memory{System.Byte},System.Boolean)">
- <summary>Reads many bytes from LZ4 stream. Return number of bytes actually read.</summary>
- <param name="token">Cancellation token.</param>
- <param name="buffer">Byte buffer to read into.</param>
- <param name="interactive">if <c>true</c> then returns as soon as some bytes are read,
- if <c>false</c> then waits for all bytes being read or end of stream.</param>
- <returns>Number of bytes actually read.
- <c>0</c> means that end of stream has been reached.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader.GetBytesRead">
- <summary>Returns how many bytes in has been read from stream so far.</summary>
- <returns>Number of bytes read in total.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader.CloseFrame">
- <summary>Closes the stream, releases allocated memory.</summary>
- </member>
- <member name="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter">
- <summary>
- Generic interface for LZ4 frame/stream writer.
- </summary>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter.OpenFrame">
- <summary>
- Opens a stream by reading frame header. Please note, this methods can be called explicitly
- but does not need to be called, it will be called automatically if needed.
- </summary>
- <returns><c>true</c> if frame has been opened,
- or <c>false</c> if it was opened before.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter.OpenFrameAsync(System.Threading.CancellationToken)">
- <summary>
- Opens a stream by reading frame header. Please note, this methods can be called explicitly
- but does not need to be called, it will be called automatically if needed.
- </summary>
- <param name="token">Cancellation token.</param>
- <returns><c>true</c> if frame has been opened,
- or <c>false</c> if it was opened before.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter.WriteOneByte(System.Byte)">
- <summary>Writes one byte to stream.</summary>
- <param name="value">Byte to be written.</param>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter.WriteOneByteAsync(System.Threading.CancellationToken,System.Byte)">
- <summary>Writes one byte to stream.</summary>
- <param name="token">Cancellation token.</param>
- <param name="value">Byte to be written.</param>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter.WriteManyBytes(System.ReadOnlySpan{System.Byte})">
- <summary>Writes multiple bytes to stream.</summary>
- <param name="buffer">Byte buffer.</param>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter.WriteManyBytesAsync(System.Threading.CancellationToken,System.ReadOnlyMemory{System.Byte})">
- <summary>Writes multiple bytes to stream.</summary>
- <param name="token">Cancellation token.</param>
- <param name="buffer">Byte buffer.</param>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter.GetBytesWritten">
- <summary>Gets number of bytes written.</summary>
- <returns>Total number of bytes (before compression).</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter.CloseFrame">
- <summary>
- Closes frame. Frame needs to be closed for stream to by valid, although
- this methods does not need to be called explicitly if stream is properly dispose.
- </summary>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter.CloseFrameAsync(System.Threading.CancellationToken)">
- <summary>
- Closes frame. Frame needs to be closed for stream to by valid, although
- this methods does not need to be called explicitly if stream is properly dispose.
- </summary>
- <param name="token">Cancellation token.</param>
- </member>
- <member name="T:K4os.Compression.LZ4.Streams.Abstractions.IStreamReader`1">
- <summary>
- Stream reader interface. It is an adapter for all stream-like structures.
- </summary>
- <typeparam name="TStreamState">Stream state.</typeparam>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Abstractions.IStreamReader`1.Read(`0@,System.Byte[],System.Int32,System.Int32)">
- <summary>
- Reads at-most <paramref name="length"/> bytes from given <paramref name="state"/>.
- </summary>
- <param name="state">Stream state.</param>
- <param name="buffer">Buffer to read bytes into.</param>
- <param name="offset">Offset in buffer.</param>
- <param name="length">Maximum number of bytes to read.</param>
- <returns>Number of bytes actually read.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Abstractions.IStreamReader`1.ReadAsync(`0,System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>
- Reads at-most <paramref name="length"/> bytes from given <paramref name="state"/>.
- </summary>
- <param name="state">Stream state.</param>
- <param name="buffer">Buffer to read bytes into.</param>
- <param name="offset">Offset in buffer.</param>
- <param name="length">Maximum number of bytes to read.</param>
- <param name="token">Cancellation token.</param>
- <returns><see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ReadResult`1"/> containing new stream state,
- and number of bytes actually read..</returns>
- </member>
- <member name="T:K4os.Compression.LZ4.Streams.Abstractions.IStreamWriter`1">
- <summary>
- Generic stream writer interface.
- When implementing custom compression target or decompression source you need to implement
- this adapter. Please note, that this adapter can be implemented as <c>class</c> or
- <c>readonly struct</c>. If implemented as <c>struct</c> it cannot have mutable state
- as it will be lost. Immutable state is allowed but strongly discouraged.
- Use <typeparamref name="TStreamState"/> instead.
- </summary>
- <typeparam name="TStreamState">Mutable part of stream state.</typeparam>
- </member>
- <member name="P:K4os.Compression.LZ4.Streams.Abstractions.IStreamWriter`1.CanFlush">
- <summary>Indicates that writer can and should flush after frame.
- Please note, flushing may have negative performance effect but may also lead to
- better interactivity between writer and reader, as reader will get new block
- available as soon as possible.</summary>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Abstractions.IStreamWriter`1.Write(`0@,System.Byte[],System.Int32,System.Int32)">
- <summary>Writes byte buffer to underlying stream.</summary>
- <param name="state">Stream state.</param>
- <param name="buffer">Byte buffer.</param>
- <param name="offset">Offset within buffer.</param>
- <param name="length">Number of bytes.</param>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Abstractions.IStreamWriter`1.WriteAsync(`0,System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>Writes byte buffer to underlying stream.</summary>
- <param name="state">Stream state.</param>
- <param name="buffer">Byte buffer.</param>
- <param name="offset">Offset within buffer.</param>
- <param name="length">Number of bytes.</param>
- <param name="token">Cancellation token.</param>
- <returns>New stream state (mutable part).</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Abstractions.IStreamWriter`1.Flush(`0@)">
- <summary>Flushes buffers to underlying storage. Called only when <see cref="P:K4os.Compression.LZ4.Streams.Abstractions.IStreamWriter`1.CanFlush"/></summary>
- <param name="state">Stream state.</param>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Abstractions.IStreamWriter`1.FlushAsync(`0,System.Threading.CancellationToken)">
- <summary>Flushes buffers to underlying storage. Called only when <see cref="P:K4os.Compression.LZ4.Streams.Abstractions.IStreamWriter`1.CanFlush"/></summary>
- <param name="state">Stream state.</param>
- <param name="token">Cancellation token.</param>
- <returns>New stream state (mutable part).</returns>
- </member>
- <member name="T:K4os.Compression.LZ4.Streams.Abstractions.ReadResult`1">
- <summary>
- Result of async read operation. Returns new state of the stream and number of bytes read.
- </summary>
- <param name="Stream">New stream state.</param>
- <param name="Bytes">Number of bytes read.</param>
- <typeparam name="TStreamState">Stream state.</typeparam>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Abstractions.ReadResult`1.#ctor(`0,System.Int32)">
- <summary>
- Result of async read operation. Returns new state of the stream and number of bytes read.
- </summary>
- <param name="Stream">New stream state.</param>
- <param name="Bytes">Number of bytes read.</param>
- <typeparam name="TStreamState">Stream state.</typeparam>
- </member>
- <member name="P:K4os.Compression.LZ4.Streams.Abstractions.ReadResult`1.Stream">
- <summary>New stream state.</summary>
- </member>
- <member name="P:K4os.Compression.LZ4.Streams.Abstractions.ReadResult`1.Bytes">
- <summary>Number of bytes read.</summary>
- </member>
- <member name="T:K4os.Compression.LZ4.Streams.Abstractions.ReadResult">
- <summary>
- Helper methods to create <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ReadResult`1"/>
- </summary>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Abstractions.ReadResult.Create``1(``0,System.Int32)">
- <summary>
- Creates read result, composed of new stream state and bytes read.
- </summary>
- <param name="stream">Stream state.</param>
- <param name="bytes">Bytes read.</param>
- <typeparam name="TStreamState">Stream state.</typeparam>
- <returns>Read result.</returns>
- </member>
- <member name="T:K4os.Compression.LZ4.Streams.Adapters.ByteBufferAdapter`1">
- <summary>
- Stream adapter for any class implementing <see cref="T:System.Buffers.IBufferWriter`1"/>.
- It takes actual class, not interface, so it can use struct implementations
- of <see cref="T:System.Buffers.IBufferWriter`1"/> for performance reasons.
- Please note, whole <c>K4os.Compression.LZ4.Streams.Adapters</c> namespace should be considered
- pubternal - exposed as public but still very likely to change.
- </summary>
- <typeparam name="TBufferWriter">Type implementing <see cref="T:System.Buffers.IBufferWriter`1"/></typeparam>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteBufferAdapter`1.Write(`0@,System.Byte[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteBufferAdapter`1.WriteAsync(`0,System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="P:K4os.Compression.LZ4.Streams.Adapters.ByteBufferAdapter`1.CanFlush">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteBufferAdapter`1.Flush(`0@)">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteBufferAdapter`1.FlushAsync(`0,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="T:K4os.Compression.LZ4.Streams.Adapters.ByteMemoryReadAdapter">
- <summary>
- Stream adapter for <see cref="T:System.ReadOnlyMemory`1"/> and <see cref="T:System.Memory`1"/>.
- This class implements <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.IStreamWriter`1"/> for <see cref="T:System.Memory`1"/>
- but should be used only in some niche situations, as it is not easy to find out
- how many bytes has been written, use <see cref="T:K4os.Compression.LZ4.Streams.Adapters.ByteBufferAdapter`1"/>
- instead.
- Please note, whole <c>K4os.Compression.LZ4.Streams.Adapters</c> namespace should be considered
- pubternal - exposed as public but still very likely to change.
- </summary>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteMemoryReadAdapter.#ctor(System.ReadOnlyMemory{System.Byte})">
- <summary>
-
- </summary>
- <param name="memory"></param>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteMemoryReadAdapter.CopyToBuffer(System.Int32,System.Byte[],System.Int32,System.Int32)">
- <summary>
- Copies bytes from span to buffer. Performs all length checks.
- </summary>
- <param name="head">Head offset of <see cref="T:System.ReadOnlyMemory`1"/>.</param>
- <param name="buffer">Target buffer.</param>
- <param name="offset">Offset in target buffer.</param>
- <param name="length">Number of bytes to copy.</param>
- <returns>Number of bytes actually copied.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteMemoryReadAdapter.Read(System.Int32@,System.Byte[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteMemoryReadAdapter.ReadAsync(System.Int32,System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="T:K4os.Compression.LZ4.Streams.Adapters.ByteMemoryWriteAdapter">
- <summary>
- Stream adapter for <see cref="T:System.ReadOnlyMemory`1"/> and <see cref="T:System.Memory`1"/>.
- This class implements <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.IStreamWriter`1"/> for <see cref="T:System.Memory`1"/>
- but should be used only in some niche situations, as it is not easy to find out
- how many bytes has been written, use <see cref="T:K4os.Compression.LZ4.Streams.Adapters.ByteBufferAdapter`1"/>
- instead.
- Please note, whole <c>K4os.Compression.LZ4.Streams.Adapters</c> namespace should be considered
- pubternal - exposed as public but still very likely to change.
- </summary>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteMemoryWriteAdapter.#ctor(System.Memory{System.Byte})">
- <summary>
- Initializes a new instance of the <see cref="T:K4os.Compression.LZ4.Streams.Adapters.ByteMemoryWriteAdapter"/> class.
- </summary>
- <param name="memory">Memory buffer.</param>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteMemoryWriteAdapter.Write(System.Int32@,System.Byte[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteMemoryWriteAdapter.WriteAsync(System.Int32,System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="P:K4os.Compression.LZ4.Streams.Adapters.ByteMemoryWriteAdapter.CanFlush">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteMemoryWriteAdapter.Flush(System.Int32@)">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteMemoryWriteAdapter.FlushAsync(System.Int32,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="T:K4os.Compression.LZ4.Streams.Adapters.ByteSequenceAdapter">
- <summary>
- Naive and simplistic implementation of adapter for <see cref="T:System.Buffers.ReadOnlySequence`1"/>.
- It might be improved in many ways I believe, but it gives some starting point.
- Please note, whole <c>K4os.Compression.LZ4.Streams.Adapters</c> namespace should be considered
- pubternal - exposed as public but still very likely to change.
- </summary>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteSequenceAdapter.Read(System.Buffers.ReadOnlySequence{System.Byte}@,System.Byte[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteSequenceAdapter.ReadAsync(System.Buffers.ReadOnlySequence{System.Byte},System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="T:K4os.Compression.LZ4.Streams.Adapters.ByteSpanAdapter">
- <summary>
- LZ4 stream reader/writer adapter for <see cref="T:K4os.Compression.LZ4.Streams.Adapters.UnsafeByteSpan"/>.
- </summary>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteSpanAdapter.#ctor(K4os.Compression.LZ4.Streams.Adapters.UnsafeByteSpan)">
- <summary>
- Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Adapters.ByteSpanAdapter"/>.
- </summary>
- <param name="span">Memory span.</param>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteSpanAdapter.Read(System.Int32@,System.Byte[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteSpanAdapter.ReadAsync(System.Int32,System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteSpanAdapter.Write(System.Int32@,System.Byte[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteSpanAdapter.WriteAsync(System.Int32,System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="P:K4os.Compression.LZ4.Streams.Adapters.ByteSpanAdapter.CanFlush">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteSpanAdapter.Flush(System.Int32@)">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteSpanAdapter.FlushAsync(System.Int32,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="T:K4os.Compression.LZ4.Streams.Adapters.EmptyState">
- <summary>
- Empty record equivalent to Unit/Void.
- Works as placeholder type used when working with generic interfaces which do require type,
- but implementation needs none.
- Please note, whole <c>K4os.Compression.LZ4.Streams.Adapters</c> namespace should be considered
- pubternal - exposed as public but still very likely to change.
- </summary>
- </member>
- <member name="T:K4os.Compression.LZ4.Streams.Adapters.PipeReaderAdapter">
- <summary>
- Stream adapter for <see cref="T:System.IO.Pipelines.PipeReader"/>.
- Please note, whole <c>K4os.Compression.LZ4.Streams.Adapters</c> namespace should be considered
- pubternal - exposed as public but still very likely to change.
- </summary>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Adapters.PipeReaderAdapter.#ctor(System.IO.Pipelines.PipeReader)">
- <summary>
- Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Adapters.PipeReaderAdapter"/>.
- </summary>
- <param name="reader">Pipe reader.</param>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Adapters.PipeReaderAdapter.Read(K4os.Compression.LZ4.Streams.Adapters.EmptyState@,System.Byte[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Adapters.PipeReaderAdapter.ReadAsync(K4os.Compression.LZ4.Streams.Adapters.EmptyState,System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="T:K4os.Compression.LZ4.Streams.Adapters.PipeWriterAdapter">
- <summary>
- LZ4 stream adapter for <see cref="T:System.IO.Pipelines.PipeReader"/>.
- Please note, whole <c>K4os.Compression.LZ4.Streams.Adapters</c> namespace should be considered
- pubternal - exposed as public but still very likely to change.
- </summary>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Adapters.PipeWriterAdapter.#ctor(System.IO.Pipelines.PipeWriter)">
- <summary>
- Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Adapters.PipeWriterAdapter"/>.
- </summary>
- <param name="writer">Pipe writer.</param>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Adapters.PipeWriterAdapter.Write(K4os.Compression.LZ4.Streams.Adapters.EmptyState@,System.Byte[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Adapters.PipeWriterAdapter.WriteAsync(K4os.Compression.LZ4.Streams.Adapters.EmptyState,System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="P:K4os.Compression.LZ4.Streams.Adapters.PipeWriterAdapter.CanFlush">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Adapters.PipeWriterAdapter.Flush(K4os.Compression.LZ4.Streams.Adapters.EmptyState@)">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Adapters.PipeWriterAdapter.FlushAsync(K4os.Compression.LZ4.Streams.Adapters.EmptyState,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="T:K4os.Compression.LZ4.Streams.Adapters.StreamAdapter">
- <summary>
- LZ4 stream reader/writer adapter for <see cref="T:System.IO.Stream"/>.
- Please note, whole <c>K4os.Compression.LZ4.Streams.Adapters</c> namespace should be considered
- pubternal - exposed as public but still very likely to change.
- </summary>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Adapters.StreamAdapter.#ctor(System.IO.Stream)">
- <summary>
- Creates new stream adapter for
- </summary>
- <param name="stream"></param>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Adapters.StreamAdapter.Read(K4os.Compression.LZ4.Streams.Adapters.EmptyState@,System.Byte[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Adapters.StreamAdapter.ReadAsync(K4os.Compression.LZ4.Streams.Adapters.EmptyState,System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Adapters.StreamAdapter.Write(K4os.Compression.LZ4.Streams.Adapters.EmptyState@,System.Byte[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Adapters.StreamAdapter.WriteAsync(K4os.Compression.LZ4.Streams.Adapters.EmptyState,System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="P:K4os.Compression.LZ4.Streams.Adapters.StreamAdapter.CanFlush">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Adapters.StreamAdapter.Flush(K4os.Compression.LZ4.Streams.Adapters.EmptyState@)">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Adapters.StreamAdapter.FlushAsync(K4os.Compression.LZ4.Streams.Adapters.EmptyState,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="T:K4os.Compression.LZ4.Streams.Adapters.UnsafeByteSpan">
- <summary>
- Unsafe version of <see cref="T:System.Span`1"/>. It is unsafe as it stores raw memory pointer
- so memory it points to must be pinned. It allows reading and writing straight to
- unmanaged memory but must be used carefully.
- NOTE: If you don't understand what has been said above - don't use it. Misuse of this
- struct may lead to unpredictable errors and memory corruption.
- </summary>
- </member>
- <member name="P:K4os.Compression.LZ4.Streams.Adapters.UnsafeByteSpan.Bytes">
- <summary>Pointer to the first byte of the span.</summary>
- </member>
- <member name="P:K4os.Compression.LZ4.Streams.Adapters.UnsafeByteSpan.Length">
- <summary>Length of the span in bytes.</summary>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Adapters.UnsafeByteSpan.#ctor(System.Void*,System.Int32)">
- <summary>
- Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Adapters.UnsafeByteSpan"/> from given pointer and length.
- </summary>
- <param name="bytes">Pointer to the first byte of the span.</param>
- <param name="length">Length of the span in bytes.</param>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Adapters.UnsafeByteSpan.Create(System.Void*,System.Int32)">
- <summary>
- Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Adapters.UnsafeByteSpan"/> from raw pointer.
- </summary>
- <param name="bytes">Pointer block of bytes.</param>
- <param name="length">Length of the block.</param>
- <returns>New <see cref="T:K4os.Compression.LZ4.Streams.Adapters.UnsafeByteSpan"/>.</returns>
- </member>
- <member name="P:K4os.Compression.LZ4.Streams.Adapters.UnsafeByteSpan.Span">
- <summary>
- Converted to <see cref="T:System.Span`1"/>.
- </summary>
- </member>
- <member name="T:K4os.Compression.LZ4.Streams.Extensions">
- <summary>
- Utility methods for LZ4 streams.
- </summary>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Extensions.CreateEncoder(K4os.Compression.LZ4.Streams.ILZ4Descriptor,K4os.Compression.LZ4.LZ4Level,System.Int32)">
- <summary>
- Creates <see cref="T:K4os.Compression.LZ4.Encoders.ILZ4Encoder"/> using <see cref="T:K4os.Compression.LZ4.Streams.ILZ4Descriptor"/>.
- </summary>
- <param name="descriptor">LZ4 descriptor.</param>
- <param name="level">Compression level.</param>
- <param name="extraMemory">Additional memory for encoder.</param>
- <returns>Encoder.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Extensions.CreateEncoder(K4os.Compression.LZ4.Streams.ILZ4Descriptor,K4os.Compression.LZ4.Streams.LZ4EncoderSettings)">
- <summary>
- Creates <see cref="T:K4os.Compression.LZ4.Encoders.ILZ4Encoder"/> using <see cref="T:K4os.Compression.LZ4.Streams.ILZ4Descriptor"/> and <see cref="T:K4os.Compression.LZ4.Streams.LZ4EncoderSettings"/>.
- </summary>
- <param name="descriptor">LZ4 descriptor.</param>
- <param name="settings">Encoder settings.</param>
- <returns>Encoder.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Extensions.CreateDecoder(K4os.Compression.LZ4.Streams.ILZ4Descriptor,System.Int32)">
- <summary>
- Create <see cref="T:K4os.Compression.LZ4.Encoders.ILZ4Decoder"/> using <see cref="T:K4os.Compression.LZ4.Streams.ILZ4Descriptor"/>.
- </summary>
- <param name="descriptor">Descriptor.</param>
- <param name="extraMemory">Extra memory (may improves speed, but creates memory pressure).</param>
- <returns><see cref="T:K4os.Compression.LZ4.Encoders.ILZ4Decoder"/>.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Extensions.CreateDecoder(K4os.Compression.LZ4.Streams.ILZ4Descriptor,K4os.Compression.LZ4.Streams.LZ4DecoderSettings)">
- <summary>
- Create <see cref="T:K4os.Compression.LZ4.Encoders.ILZ4Decoder"/> using <see cref="T:K4os.Compression.LZ4.Streams.ILZ4Descriptor"/> and <see cref="T:K4os.Compression.LZ4.Streams.LZ4DecoderSettings"/>.
- </summary>
- <param name="descriptor">Descriptor.</param>
- <param name="settings">Settings.</param>
- <returns><see cref="T:K4os.Compression.LZ4.Encoders.ILZ4Decoder"/>.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Extensions.CreateDescriptor(K4os.Compression.LZ4.Streams.LZ4EncoderSettings)">
- <summary>
- Creates <see cref="T:K4os.Compression.LZ4.Streams.ILZ4Descriptor"/> from <see cref="T:K4os.Compression.LZ4.Streams.LZ4DecoderSettings"/>.
- </summary>
- <param name="settings">Settings.</param>
- <returns>LZ4 Descriptor.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Extensions.OpenFrameAsync(K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader)">
- <summary>Async version of <see cref="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader.OpenFrame"/>.</summary>
- <param name="reader">Decoder.</param>
- <returns><c>true</c> if frame was just opened,
- <c>false</c> if it was opened before.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Extensions.GetFrameLengthAsync(K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader)">
- <summary>Async version of <see cref="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader.GetFrameLength"/>.</summary>
- <param name="reader">Decoder.</param>
- <returns>Frame length, or <c>null</c></returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Extensions.ReadOneByteAsync(K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader)">
- <summary>Reads one byte from LZ4 stream.</summary>
- <param name="reader">Decoder.</param>
- <returns>A byte, or -1 if end of stream.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Extensions.ReadManyBytesAsync(K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader,System.Memory{System.Byte},System.Boolean)">
- <summary>Reads many bytes from LZ4 stream. Return number of bytes actually read.</summary>
- <param name="reader">Decoder.</param>
- <param name="buffer">Byte buffer to read into.</param>
- <param name="interactive">if <c>true</c> then returns as soon as some bytes are read,
- if <c>false</c> then waits for all bytes being read or end of stream.</param>
- <returns>Number of bytes actually read.
- <c>0</c> means that end of stream has been reached.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Extensions.OpenFrameAsync(K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter)">
- <summary>
- Opens a stream by reading frame header. Please note, this methods can be called explicitly
- but does not need to be called, it will be called automatically if needed.
- </summary>
- <param name="writer">Encoder.</param>
- <returns><c>true</c> if frame has been opened, or <c>false</c> if it was opened before.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Extensions.WriteOneByteAsync(K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter,System.Byte)">
- <summary>Writes one byte to stream.</summary>
- <param name="writer">Encoder.</param>
- <param name="value">Byte to be written.</param>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Extensions.WriteManyBytesAsync(K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter,System.ReadOnlyMemory{System.Byte})">
- <summary>Writes multiple bytes to stream.</summary>
- <param name="writer">Encoder.</param>
- <param name="buffer">Byte buffer.</param>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Extensions.CloseFrameAsync(K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter)">
- <summary>
- Closes frame. Frame needs to be closed for stream to by valid, although
- this methods does not need to be called explicitly if stream is properly dispose.
- </summary>
- <param name="writer">Encoder.</param>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Extensions.CopyTo``1(K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader,``0,System.Int32)">
- <summary>
- Copies all bytes from <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader"/> into <see cref="T:System.Buffers.IBufferWriter`1"/>.
- </summary>
- <param name="source">Frame reader.</param>
- <param name="target">Buffer writer.</param>
- <param name="blockSize">Chunk size.</param>
- <typeparam name="TBufferWriter">Type of buffer writer.</typeparam>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Extensions.CopyToAsync``1(K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader,``0,System.Int32)">
- <summary>
- Copies all bytes from <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader"/> into <see cref="T:System.Buffers.IBufferWriter`1"/>.
- </summary>
- <param name="source">LZ4 frame reader.</param>
- <param name="target">Buffer writer.</param>
- <param name="blockSize">Chunk size.</param>
- <typeparam name="TBufferWriter">Type of buffer writer.</typeparam>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Extensions.CopyFrom(K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter,System.Buffers.ReadOnlySequence{System.Byte})">
- <summary>
- Copies all bytes from <see cref="T:System.Buffers.ReadOnlySequence`1"/> into <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter"/>.
- </summary>
- <param name="target">Frame writer.</param>
- <param name="source">Sequence of bytes.</param>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Extensions.CopyFromAsync(K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter,System.Buffers.ReadOnlySequence{System.Byte})">
- <summary>
- Copies all bytes from <see cref="T:System.Buffers.ReadOnlySequence`1"/> into <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter"/>.
- </summary>
- <param name="target">Frame writer.</param>
- <param name="source">Sequence of bytes.</param>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Extensions.AsStream(K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader,System.Boolean,System.Boolean)">
- <summary>
- Wraps <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader"/> as <see cref="T:System.IO.Stream"/>.
- </summary>
- <param name="reader">LZ4 frame reader.</param>
- <param name="leaveOpen">Indicates that frame reader should be left open even if stream is
- disposed.</param>
- <param name="interactive">Indicates that data should be provided to reader as quick as
- possible, instead of waiting for whole block to be read.</param>
- <returns><see cref="T:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReaderAsStream"/> stream wrapper.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Extensions.AsStream(K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter,System.Boolean)">
- <summary>
- Wraps <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter"/> as <see cref="T:System.IO.Stream"/>.
- </summary>
- <param name="writer">LZ4 frame writer.</param>
- <param name="leaveOpen">Indicates that frame writer should be left open even if stream is
- disposed.</param>
- <returns><see cref="T:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriterAsStream"/> stream wrapper.</returns>
- </member>
- <member name="T:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2">
- <summary>
- LZ4 Decompression stream handling.
- </summary>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.#ctor(`0,`1,System.Func{K4os.Compression.LZ4.Streams.ILZ4Descriptor,K4os.Compression.LZ4.Encoders.ILZ4Decoder})">
- <summary>Creates new instance <see cref="T:K4os.Compression.LZ4.Streams.LZ4DecoderStream"/>.</summary>
- <param name="reader">Inner stream.</param>
- <param name="stream">Inner stream initial state.</param>
- <param name="decoderFactory">Decoder factory.</param>
- </member>
- <member name="P:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.StreamState">
- <summary>
- Exposes internal stream state. Existence of this property is a hack,
- and it really shouldn't be here but it is needed for relatively low
- level operations (like writing directly to unmanaged memory).
- Please, do not use it directly, if don't know what you are doing.
- </summary>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.CloseFrame">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.AllocBuffer(System.Int32)">
- <summary>Allocate temporary buffer to store decompressed data.</summary>
- <param name="size">Minimum size of the buffer.</param>
- <returns>Allocated buffer.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.ReleaseBuffer(System.Byte[])">
- <summary>Releases allocated buffer. <see cref="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.AllocBuffer(System.Int32)"/></summary>
- <param name="buffer">Previously allocated buffer.</param>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.OpenFrame">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.OpenFrameAsync(System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.GetBytesRead">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.GetFrameLength">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.GetFrameLengthAsync(System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.ReadOneByte">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.ReadOneByteAsync(System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.ReadManyBytes(System.Span{System.Byte},System.Boolean)">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.ReadManyBytesAsync(System.Threading.CancellationToken,System.Memory{System.Byte},System.Boolean)">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.Dispose(System.Boolean)">
- <summary>
- Disposes the decoder. Consecutive attempts to read will fail.
- </summary>
- <param name="disposing"><c>true</c> is stream is being disposed by user,
- <c>true</c> is by garbage collector.</param>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.ReleaseResources">
- <summary>
- Releases unmanaged resources.
- </summary>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.ReleaseResourcesAsync">
- <summary>
- Releases unmanaged resources.
- </summary>
- <returns>Task indicating operation is finished.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.Dispose">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.DisposeAsync">
- <inheritdoc />
- </member>
- <member name="T:K4os.Compression.LZ4.Streams.Frames.ByteSpanLZ4FrameReader">
- <summary>
- <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader"/> implementation for <see cref="T:K4os.Compression.LZ4.Streams.Adapters.UnsafeByteSpan"/>.
- </summary>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.ByteSpanLZ4FrameReader.#ctor(K4os.Compression.LZ4.Streams.Adapters.UnsafeByteSpan,System.Func{K4os.Compression.LZ4.Streams.ILZ4Descriptor,K4os.Compression.LZ4.Encoders.ILZ4Decoder})">
- <summary>
- Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Frames.ByteSpanLZ4FrameReader"/>.
- </summary>
- <param name="span">Bytes span.</param>
- <param name="decoderFactory">LZ4 decoder factory.</param>
- </member>
- <member name="T:K4os.Compression.LZ4.Streams.Frames.ByteMemoryLZ4FrameReader">
- <summary>
- <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader"/> implementation for <see cref="T:System.ReadOnlyMemory`1"/>.
- </summary>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.ByteMemoryLZ4FrameReader.#ctor(System.ReadOnlyMemory{System.Byte},System.Func{K4os.Compression.LZ4.Streams.ILZ4Descriptor,K4os.Compression.LZ4.Encoders.ILZ4Decoder})">
- <summary>
- Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Frames.ByteMemoryLZ4FrameReader"/>.
- </summary>
- <param name="memory">Memory buffer.</param>
- <param name="decoderFactory">LZ4 decoder factory.</param>
- </member>
- <member name="T:K4os.Compression.LZ4.Streams.Frames.ByteSequenceLZ4FrameReader">
- <summary>
- <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader"/> implementation for <see cref="T:System.Buffers.ReadOnlySequence`1"/>.
- </summary>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.ByteSequenceLZ4FrameReader.#ctor(System.Buffers.ReadOnlySequence{System.Byte},System.Func{K4os.Compression.LZ4.Streams.ILZ4Descriptor,K4os.Compression.LZ4.Encoders.ILZ4Decoder})">
- <summary>
- Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Frames.ByteSequenceLZ4FrameReader"/>.
- </summary>
- <param name="sequence">Byte sequence.</param>
- <param name="decoderFactory">LZ4 decoder factory.</param>
- </member>
- <member name="T:K4os.Compression.LZ4.Streams.Frames.StreamLZ4FrameReader">
- <summary>
- <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader"/> implementation for <see cref="T:System.IO.Stream"/>.
- </summary>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.StreamLZ4FrameReader.#ctor(System.IO.Stream,System.Boolean,System.Func{K4os.Compression.LZ4.Streams.ILZ4Descriptor,K4os.Compression.LZ4.Encoders.ILZ4Decoder})">
- <summary>
- Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Frames.StreamLZ4FrameReader"/>.
- </summary>
- <param name="stream">Stream to read from.</param>
- <param name="leaveOpen">Leave stream open after reader is disposed.</param>
- <param name="decoderFactory">LZ4 decoder factory.</param>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.StreamLZ4FrameReader.Dispose(System.Boolean)">
- <summary>
- Disposes the reader.
- </summary>
- <param name="disposing"><c>true</c> if user is disposing it; <c>false</c> if it has been triggered by garbage collector</param>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.StreamLZ4FrameReader.DisposeAsync">
- <summary>
- Disposes the reader.
- </summary>
- </member>
- <member name="T:K4os.Compression.LZ4.Streams.Frames.PipeLZ4FrameReader">
- <summary>
- <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader"/> implementation for <see cref="T:System.IO.Pipelines.PipeReader"/>.
- </summary>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.PipeLZ4FrameReader.#ctor(System.IO.Pipelines.PipeReader,System.Boolean,System.Func{K4os.Compression.LZ4.Streams.ILZ4Descriptor,K4os.Compression.LZ4.Encoders.ILZ4Decoder})">
- <summary>
- Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Frames.PipeLZ4FrameReader"/>.
- </summary>
- <param name="pipe">Pipe to be read.</param>
- <param name="leaveOpen">Leave pipe open after reader is disposed.</param>
- <param name="decoderFactory">LZ4 decoder factory.</param>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.PipeLZ4FrameReader.ReleaseResources">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.PipeLZ4FrameReader.ReleaseResourcesAsync">
- <inheritdoc />
- </member>
- <member name="T:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReaderAsStream">
- <summary>
- <see cref="T:System.IO.Stream"/> wrapper for <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader"/>.
- </summary>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReaderAsStream.#ctor(K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader,System.Boolean,System.Boolean)">
- <summary>
- Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReaderAsStream"/>.
- </summary>
- <param name="reader">LZ4 frame reader.</param>
- <param name="leaveOpen">Leave underlying stream open after disposing this stream.</param>
- <param name="interactive">Use interactive mode; return bytes as soon as they available.</param>
- </member>
- <member name="P:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReaderAsStream.CanRead">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReaderAsStream.ReadByte">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReaderAsStream.Read(System.Byte[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReaderAsStream.ReadAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="P:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReaderAsStream.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>.
- It will also require synchronous stream access, so it wont work if AllowSynchronousIO
- is <c>false</c>.
- </summary>
- </member>
- <member name="P:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReaderAsStream.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="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReaderAsStream.Dispose(System.Boolean)">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReaderAsStream.Read(System.Span{System.Byte})">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReaderAsStream.ReadAsync(System.Memory{System.Byte},System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReaderAsStream.DisposeAsync">
- <inheritdoc />
- </member>
- <member name="T:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2">
- <summary>
- LZ4 stream encoder.
- </summary>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.#ctor(`0,`1,System.Func{K4os.Compression.LZ4.Streams.ILZ4Descriptor,K4os.Compression.LZ4.Encoders.ILZ4Encoder},K4os.Compression.LZ4.Streams.ILZ4Descriptor)">
- <summary>Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.LZ4EncoderStream"/>.</summary>
- <param name="writer">Inner stream.</param>
- <param name="stream">Inner stream initial state.</param>
- <param name="encoderFactory">LZ4 Encoder factory.</param>
- <param name="descriptor">LZ4 settings.</param>
- </member>
- <member name="P:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.StreamState">
- <summary>
- Exposes internal stream state. Existence of this field is a hack,
- and it really shouldn't be here but it is needed for relatively low
- level operations (like writing directly to unmanaged memory).
- Please, do not use it directly, if don't know what you are doing.
- </summary>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.AllocateBuffer(System.Int32)">
- <summary>Allocate temporary buffer to store decompressed data.</summary>
- <param name="size">Minimum size of the buffer.</param>
- <returns>Allocated buffer.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.ReleaseBuffer(System.Byte[])">
- <summary>Releases allocated buffer. <see cref="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.AllocateBuffer(System.Int32)"/></summary>
- <param name="buffer">Previously allocated buffer.</param>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.GetBytesWritten">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.WriteOneByte(System.Byte)">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.WriteOneByteAsync(System.Threading.CancellationToken,System.Byte)">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.WriteManyBytes(System.ReadOnlySpan{System.Byte})">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.WriteManyBytesAsync(System.Threading.CancellationToken,System.ReadOnlyMemory{System.Byte})">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.OpenFrame">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.OpenFrameAsync(System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.CloseFrame">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.CloseFrameAsync(System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.Dispose(System.Boolean)">
- <summary>
- Disposes the stream and releases all resources.
- </summary>
- <param name="disposing"><c>true</c> if called by user; <c>false</c> when called by garbag collector.</param>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.Dispose">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.ReleaseResources">
- <summary>
- Releases all unmanaged resources.
- </summary>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.ReleaseResourcesAsync">
- <summary>
- Releases all unmanaged resources.
- </summary>
- <returns>Task indicating completion of the operation.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.DisposeAsync">
- <inheritdoc />
- </member>
- <member name="T:K4os.Compression.LZ4.Streams.Frames.ByteBufferLZ4FrameWriter`1">
- <summary>
- <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter"/> implementation for <see cref="T:System.Buffers.IBufferWriter`1"/>
- </summary>
- <typeparam name="TBufferWriter">Type of buffer writer.</typeparam>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.ByteBufferLZ4FrameWriter`1.#ctor(`0,System.Func{K4os.Compression.LZ4.Streams.ILZ4Descriptor,K4os.Compression.LZ4.Encoders.ILZ4Encoder},K4os.Compression.LZ4.Streams.ILZ4Descriptor)">
- <summary>
- Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Frames.ByteBufferLZ4FrameWriter`1"/>.
- </summary>
- <param name="stream">Buffer writer to write to.</param>
- <param name="encoderFactory">Encoder factory.</param>
- <param name="descriptor">Frame descriptor.</param>
- </member>
- <member name="P:K4os.Compression.LZ4.Streams.Frames.ByteBufferLZ4FrameWriter`1.BufferWriter">
- <summary>Current state of buffer writer.</summary>
- </member>
- <member name="T:K4os.Compression.LZ4.Streams.Frames.ByteBufferLZ4FrameWriter">
- <summary>
- <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter"/> implementation for <see cref="T:System.Buffers.IBufferWriter`1"/>
- </summary>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.ByteBufferLZ4FrameWriter.#ctor(System.Buffers.IBufferWriter{System.Byte},System.Func{K4os.Compression.LZ4.Streams.ILZ4Descriptor,K4os.Compression.LZ4.Encoders.ILZ4Encoder},K4os.Compression.LZ4.Streams.ILZ4Descriptor)">
- <summary>
- Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Frames.ByteBufferLZ4FrameWriter"/>.
- </summary>
- <param name="stream">Buffer writer to write to.</param>
- <param name="encoderFactory">Encoder factory.</param>
- <param name="descriptor">Frame descriptor.</param>
- </member>
- <member name="T:K4os.Compression.LZ4.Streams.Frames.ByteMemoryLZ4FrameWriter">
- <summary>
- <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter"/> implementation for <see cref="T:System.Memory`1"/>
- </summary>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.ByteMemoryLZ4FrameWriter.#ctor(System.Memory{System.Byte},System.Func{K4os.Compression.LZ4.Streams.ILZ4Descriptor,K4os.Compression.LZ4.Encoders.ILZ4Encoder},K4os.Compression.LZ4.Streams.ILZ4Descriptor)">
- <summary>
- Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Frames.ByteMemoryLZ4FrameWriter"/>.
- </summary>
- <param name="memory">Memory block where data will be written.</param>
- <param name="encoderFactory">Encoder factory.</param>
- <param name="descriptor">Frame descriptor.</param>
- </member>
- <member name="P:K4os.Compression.LZ4.Streams.Frames.ByteMemoryLZ4FrameWriter.CompressedLength">
- <summary>Number of bytes written to the memory.</summary>
- </member>
- <member name="T:K4os.Compression.LZ4.Streams.Frames.ByteSpanLZ4FrameWriter">
- <summary>
- <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter"/> implementation for <see cref="T:K4os.Compression.LZ4.Streams.Adapters.UnsafeByteSpan"/>.
- <see cref="T:K4os.Compression.LZ4.Streams.Adapters.UnsafeByteSpan"/> is a wrapper around <see cref="T:System.Span`1"/> that
- can be stored in a field. Please note: it makes it unsafe and address needs to be pinned,
- one way or another.
- </summary>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.ByteSpanLZ4FrameWriter.#ctor(K4os.Compression.LZ4.Streams.Adapters.UnsafeByteSpan,System.Func{K4os.Compression.LZ4.Streams.ILZ4Descriptor,K4os.Compression.LZ4.Encoders.ILZ4Encoder},K4os.Compression.LZ4.Streams.ILZ4Descriptor)">
- <summary>
- Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Frames.ByteSpanLZ4FrameWriter"/>.
- </summary>
- <param name="span">Span to write to.</param>
- <param name="encoderFactory">Encoder factory.</param>
- <param name="descriptor">Frame descriptor.</param>
- </member>
- <member name="P:K4os.Compression.LZ4.Streams.Frames.ByteSpanLZ4FrameWriter.CompressedLength">
- <summary>Number of bytes written to the memory.</summary>
- </member>
- <member name="T:K4os.Compression.LZ4.Streams.Frames.StreamLZ4FrameWriter">
- <summary>
- <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter"/> implementation for <see cref="T:System.IO.Stream"/>.
- </summary>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.StreamLZ4FrameWriter.#ctor(System.IO.Stream,System.Boolean,System.Func{K4os.Compression.LZ4.Streams.ILZ4Descriptor,K4os.Compression.LZ4.Encoders.ILZ4Encoder},K4os.Compression.LZ4.Streams.ILZ4Descriptor)">
- <summary>
- Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Frames.StreamLZ4FrameWriter"/>.
- </summary>
- <param name="stream">Stream to write to.</param>
- <param name="leaveOpen">Leave stream open after disposing this writer.</param>
- <param name="encoderFactory">Encoder factory.</param>
- <param name="descriptor">Frame descriptor.</param>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.StreamLZ4FrameWriter.ReleaseResources">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.StreamLZ4FrameWriter.ReleaseResourcesAsync">
- <inheritdoc />
- </member>
- <member name="T:K4os.Compression.LZ4.Streams.Frames.PipeLZ4FrameWriter">
- <summary>
- <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter"/> implementation for <see cref="T:System.IO.Pipelines.PipeWriter"/>.
- </summary>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.PipeLZ4FrameWriter.#ctor(System.IO.Pipelines.PipeWriter,System.Boolean,System.Func{K4os.Compression.LZ4.Streams.ILZ4Descriptor,K4os.Compression.LZ4.Encoders.ILZ4Encoder},K4os.Compression.LZ4.Streams.ILZ4Descriptor)">
- <summary>
- Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Frames.PipeLZ4FrameWriter"/>.
- </summary>
- <param name="pipe">Pipe writer to write to.</param>
- <param name="leaveOpen">Leave pipe open after disposing this writer.</param>
- <param name="encoderFactory">Encoder factory.</param>
- <param name="descriptor">Frame descriptor.</param>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.PipeLZ4FrameWriter.ReleaseResources">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.PipeLZ4FrameWriter.ReleaseResourcesAsync">
- <inheritdoc />
- </member>
- <member name="T:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriterAsStream">
- <summary>
- Adapter to make <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter"/> look like <see cref="T:System.IO.Stream"/>.
- </summary>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriterAsStream.#ctor(K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter,System.Boolean)">
- <summary>Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.LZ4EncoderStream"/>.</summary>
- <param name="writer">Underlying frame encoder.</param>
- <param name="leaveOpen">Indicates <paramref name="writer"/> should be left
- open after disposing.</param>
- </member>
- <member name="P:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriterAsStream.CanWrite">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriterAsStream.WriteByte(System.Byte)">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriterAsStream.Write(System.Byte[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriterAsStream.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriterAsStream.Write(System.ReadOnlySpan{System.Byte})">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriterAsStream.WriteAsync(System.ReadOnlyMemory{System.Byte},System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="P:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriterAsStream.Length">
- <summary>Length of the stream and number of bytes written so far.</summary>
- </member>
- <member name="P:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriterAsStream.Position">
- <summary>Read-only position in the stream. Trying to set it will throw
- <see cref="T:System.InvalidOperationException"/>.</summary>
- </member>
- <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.Internal.EmptyToken">
- <summary>
- Completely empty class to do nothing.
- It is used internally instead of CancellationToken to make sure
- blocking operations are easily distinguishable from async ones
- (you cannot call blocking operation by accident as they *require* EmptyToken).
- </summary>
- </member>
- <member name="T:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1">
- <summary>
- Base class for all <see cref="T:System.IO.Stream"/> compatible adapters.
- </summary>
- <typeparam name="T">Type of resource stream adapter if for.</typeparam>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.#ctor(`0,System.Boolean)">
- <summary>
- Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1"/>.
- </summary>
- <param name="innerResource">Wrapped resource.</param>
- <param name="leaveOpen">Do not dispose inner resource after stream is disposed.</param>
- </member>
- <member name="P:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.InnerResource">
- <summary>Wrapped resource.</summary>
- </member>
- <member name="P:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.CanRead">
- <inheritdoc />
- </member>
- <member name="P:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.CanWrite">
- <inheritdoc />
- </member>
- <member name="P:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.CanTimeout">
- <inheritdoc />
- </member>
- <member name="P:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.ReadTimeout">
- <inheritdoc />
- </member>
- <member name="P:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.WriteTimeout">
- <inheritdoc />
- </member>
- <member name="P:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.CanSeek">
- <inheritdoc />
- </member>
- <member name="P:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.Position">
- <inheritdoc />
- </member>
- <member name="P:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.Length">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.Flush">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.FlushAsync(System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.Seek(System.Int64,System.IO.SeekOrigin)">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.SetLength(System.Int64)">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.ReadByte">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.Read(System.Byte[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.ReadAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.Dispose(System.Boolean)">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.WriteByte(System.Byte)">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.Write(System.Byte[],System.Int32,System.Int32)">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.Read(System.Span{System.Byte})">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.ReadAsync(System.Memory{System.Byte},System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.Write(System.ReadOnlySpan{System.Byte})">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.WriteAsync(System.ReadOnlyMemory{System.Byte},System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.DisposeAsync">
- <inheritdoc />
- </member>
- <member name="T:K4os.Compression.LZ4.Streams.Internal.LZ4StreamOnStreamEssentials">
- <summary>
- LZ4 stream essentials when wrapping another stream.
- You most likely should not use it but it needs to be public as it is inherited from.
- </summary>
- </member>
- <member name="P:K4os.Compression.LZ4.Streams.Internal.LZ4StreamOnStreamEssentials.CanRead">
- <inheritdoc />
- </member>
- <member name="P:K4os.Compression.LZ4.Streams.Internal.LZ4StreamOnStreamEssentials.CanWrite">
- <inheritdoc />
- </member>
- <member name="P:K4os.Compression.LZ4.Streams.Internal.LZ4StreamOnStreamEssentials.CanTimeout">
- <inheritdoc />
- </member>
- <member name="P:K4os.Compression.LZ4.Streams.Internal.LZ4StreamOnStreamEssentials.ReadTimeout">
- <inheritdoc />
- </member>
- <member name="P:K4os.Compression.LZ4.Streams.Internal.LZ4StreamOnStreamEssentials.WriteTimeout">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Internal.LZ4StreamOnStreamEssentials.Flush">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.Internal.LZ4StreamOnStreamEssentials.FlushAsync(System.Threading.CancellationToken)">
- <inheritdoc />
- </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 frame decoder stream.
- </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,System.Boolean)">
- <summary>
- Creates LZ4 decoder stream.
- </summary>
- <param name="inner">Inner stream, the stream compressed data is coming from..</param>
- <param name="decoderFactory">Decoder factory.</param>
- <param name="leaveOpen">Leave inner stream open after this stream is disposed.</param>
- <param name="interactive">Interactive mode, provide bytes as soon as they are available; don't wait for full block.</param>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.ReadByte">
- <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.ReadAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <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>.
- It will also require synchronous stream access, so it wont work if AllowSynchronousIO
- is <c>false</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="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.Dispose(System.Boolean)">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.Read(System.Span{System.Byte})">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.ReadAsync(System.Memory{System.Byte},System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.DisposeAsync">
- <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="M:K4os.Compression.LZ4.Streams.LZ4Descriptor.#ctor(K4os.Compression.LZ4.Streams.ILZ4Descriptor)">
- <summary>Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.LZ4Descriptor"/>.</summary>
- <param name="descriptor">Descriptor to copy.</param>
- </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 should be included.</summary>
- </member>
- <member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderSettings.BlockChecksum">
- <summary>Indicates if block checksum should be included.</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 frame encoder 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.Dispose(System.Boolean)">
- <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.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.DisposeAsync">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Write(System.ReadOnlySpan{System.Byte})">
- <inheritdoc />
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.WriteAsync(System.ReadOnlyMemory{System.Byte},System.Threading.CancellationToken)">
- <inheritdoc />
- </member>
- <member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderStream.CanRead">
- <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="T:K4os.Compression.LZ4.Streams.LZ4Frame">
- <summary>
- LZ4 factory methods to encode/decode anything which can be represented as a stream-like object.
- Please note, to avoid all the complexity of dealing with streams, it uses
- <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader"/> and <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter"/> as stream abstractions.
- </summary>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Decode``1(System.ReadOnlySpan{System.Byte},``0,System.Int32)">
- <summary>Creates decompression stream on top of inner stream.</summary>
- <param name="source">Span to read from.</param>
- <param name="target">Buffer to write to.</param>
- <param name="extraMemory">Extra memory used for decompression.</param>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Decode(System.ReadOnlyMemory{System.Byte},System.Int32)">
- <summary>Creates decompression stream on top of inner stream.</summary>
- <param name="memory">Stream to be decoded.</param>
- <param name="extraMemory">Extra memory used for decompression.</param>
- <returns>Decompression stream.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Decode(System.Buffers.ReadOnlySequence{System.Byte},System.Int32)">
- <summary>Creates decompression stream on top of inner stream.</summary>
- <param name="sequence">Stream to be decoded.</param>
- <param name="extraMemory">Extra memory used for decompression.</param>
- <returns>Decompression stream.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Decode(System.IO.Stream,System.Int32,System.Boolean)">
- <summary>Creates decompression stream on top of inner stream.</summary>
- <param name="stream">Stream to be decoded.</param>
- <param name="extraMemory">Extra memory used for decompression.</param>
- <param name="leaveOpen">Indicates if stream should stay open after disposing decoder.</param>
- <returns>Decompression stream.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Decode(System.IO.Pipelines.PipeReader,System.Int32,System.Boolean)">
- <summary>Creates decompression stream on top of inner stream.</summary>
- <param name="reader">Stream to be decoded.</param>
- <param name="extraMemory">Extra memory used for decompression.</param>
- <param name="leaveOpen">Indicates if stream should stay open after disposing decoder.</param>
- <returns>Decompression stream.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Encode``1(System.Buffers.ReadOnlySequence{System.Byte},``0,K4os.Compression.LZ4.Streams.LZ4EncoderSettings)">
- <summary>
- Compresses source bytes into target buffer. Returns number of bytes actually written.
- </summary>
- <param name="source">Source bytes.</param>
- <param name="target">Target buffer.</param>
- <param name="settings">Compression settings.</param>
- <returns>Number of bytes actually written.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Encode``1(System.ReadOnlySpan{System.Byte},``0,K4os.Compression.LZ4.Streams.LZ4EncoderSettings)">
- <summary>
- Compresses source bytes into target buffer. Returns number of bytes actually written.
- </summary>
- <param name="source">Source bytes.</param>
- <param name="target">Target buffer.</param>
- <param name="settings">Compression settings.</param>
- <returns>Number of bytes actually written.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Encode``1(System.Buffers.ReadOnlySequence{System.Byte},``0,K4os.Compression.LZ4.LZ4Level,System.Int32)">
- <summary>
- Compresses source bytes into target buffer. Returns number of bytes actually written.
- </summary>
- <param name="source">Source bytes.</param>
- <param name="target">Target buffer.</param>
- <param name="level">Compression level.</param>
- <param name="extraMemory">Extra memory.</param>
- <returns>Number of bytes actually written.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Encode``1(System.ReadOnlySpan{System.Byte},``0,K4os.Compression.LZ4.LZ4Level,System.Int32)">
- <summary>
- Compresses source bytes into target buffer. Returns number of bytes actually written.
- </summary>
- <param name="source">Source bytes.</param>
- <param name="target">Target buffer.</param>
- <param name="level">Compression level.</param>
- <param name="extraMemory">Extra memory.</param>
- <returns>Number of bytes actually written.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Encode(System.Buffers.ReadOnlySequence{System.Byte},System.Span{System.Byte},K4os.Compression.LZ4.Streams.LZ4EncoderSettings)">
- <summary>
- Compresses source bytes into target buffer. Returns number of bytes actually written.
- </summary>
- <param name="source">Source bytes.</param>
- <param name="target">Target buffer.</param>
- <param name="settings">Compression settings.</param>
- <returns>Number of bytes actually written.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Encode(System.Span{System.Byte},System.Span{System.Byte},K4os.Compression.LZ4.Streams.LZ4EncoderSettings)">
- <summary>
- Compresses source bytes into target buffer. Returns number of bytes actually written.
- </summary>
- <param name="source">Source bytes.</param>
- <param name="target">Target buffer.</param>
- <param name="settings">Compression settings.</param>
- <returns>Number of bytes actually written.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Encode(System.Action{K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter},System.Span{System.Byte},K4os.Compression.LZ4.Streams.LZ4EncoderSettings)">
- <summary>
- Writes bytes into target buffer. Returns number of bytes actually written.
- </summary>
- <param name="source">Source of bytes, a function which write to LZ4 encoder.</param>
- <param name="target">Target buffer.</param>
- <param name="settings">Compression settings.</param>
- <returns>Number of bytes actually written.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Encode(System.Buffers.ReadOnlySequence{System.Byte},System.Span{System.Byte},K4os.Compression.LZ4.LZ4Level,System.Int32)">
- <summary>
- Compresses source bytes into target buffer. Returns number of bytes actually written.
- </summary>
- <param name="source">Source bytes.</param>
- <param name="target">Target buffer.</param>
- <param name="level">Compression level.</param>
- <param name="extraMemory">Extra memory for encoder.</param>
- <returns>Number of bytes actually written.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Encode(System.Span{System.Byte},System.Span{System.Byte},K4os.Compression.LZ4.LZ4Level,System.Int32)">
- <summary>
- Compresses source bytes into target buffer. Returns number of bytes actually written.
- </summary>
- <param name="source">Source bytes.</param>
- <param name="target">Target buffer.</param>
- <param name="level">Compression level.</param>
- <param name="extraMemory">Extra memory for encoder.</param>
- <returns>Number of bytes actually written.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Encode(System.Action{K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter},System.Span{System.Byte},K4os.Compression.LZ4.LZ4Level,System.Int32)">
- <summary>
- Compresses source bytes into target buffer. Returns number of bytes actually written.
- </summary>
- <param name="source">Source of bytes, a function which write to LZ4 encoder.</param>
- <param name="target">Target buffer.</param>
- <param name="level">Compression level.</param>
- <param name="extraMemory">Extra memory for encoder.</param>
- <returns>Number of bytes actually written.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Encode(System.Byte*,System.Int32,K4os.Compression.LZ4.Streams.LZ4EncoderSettings)">
- <summary>
- Create LZ4 encoder that writes compressed data into target buffer.
- Please note, target buffer needs to be pinned for the whole time encoder is used.
- This is definitely very unsafe method, and if you don't understand what it does,
- don't use it.
- </summary>
- <param name="target">Pointer to target buffer.</param>
- <param name="length">Length of target buffer.</param>
- <param name="settings">Encoder settings.</param>
- <returns>LZ4 frame writer.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Encode(System.Byte*,System.Int32,K4os.Compression.LZ4.LZ4Level,System.Int32)">
- <summary>
- Create LZ4 encoder that writes compressed data into target buffer.
- Please note, target buffer needs to be pinned for the whole time encoder is used.
- This is definitely very unsafe method, and if you don't understand what it does,
- don't use it.
- </summary>
- <param name="target">Pointer to target buffer.</param>
- <param name="length">Length of target buffer.</param>
- <param name="level">Compression level.</param>
- <param name="extraMemory">Extra memory for encoder.</param>
- <returns>LZ4 frame writer.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Encode(System.Memory{System.Byte},K4os.Compression.LZ4.Streams.LZ4EncoderSettings)">
- <summary>
- Create LZ4 encoder that writes compressed data into target buffer.
- </summary>
- <param name="target">Target buffer.</param>
- <param name="settings">Encoder settings.</param>
- <returns>LZ4 frame writer.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Encode(System.Memory{System.Byte},K4os.Compression.LZ4.LZ4Level,System.Int32)">
- <summary>
- Create LZ4 encoder that writes compressed data into target buffer.
- </summary>
- <param name="target">Target buffer.</param>
- <param name="level">Compression level.</param>
- <param name="extraMemory">Extra memory for encoder.</param>
- <returns>LZ4 frame writer.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Encode``1(``0,K4os.Compression.LZ4.Streams.LZ4EncoderSettings)">
- <summary>
- Create LZ4 encoder that writes compressed data into target buffer.
- </summary>
- <param name="target">Target buffer.</param>
- <param name="settings">Encoder settings.</param>
- <typeparam name="TBufferWriter">Byte of buffer writer implementing <see cref="T:System.Buffers.IBufferWriter`1"/>.</typeparam>
- <returns>LZ4 frame writer.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Encode``1(``0,K4os.Compression.LZ4.LZ4Level,System.Int32)">
- <summary>
- Create LZ4 encoder that writes compressed data into target buffer.
- </summary>
- <param name="target">Target buffer.</param>
- <param name="level">Compression level.</param>
- <param name="extraMemory">Extra memory for encoder.</param>
- <typeparam name="TBufferWriter">Byte of buffer writer implementing <see cref="T:System.Buffers.IBufferWriter`1"/>.</typeparam>
- <returns>LZ4 frame writer.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Encode(System.Buffers.IBufferWriter{System.Byte},K4os.Compression.LZ4.Streams.LZ4EncoderSettings)">
- <summary>
- Create LZ4 encoder that writes compressed data into target buffer.
- </summary>
- <param name="target">Target buffer.</param>
- <param name="settings">Encoder settings.</param>
- <returns>LZ4 frame writer.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Encode(System.Buffers.IBufferWriter{System.Byte},K4os.Compression.LZ4.LZ4Level,System.Int32)">
- <summary>
- Create LZ4 encoder that writes compressed data into target buffer.
- </summary>
- <param name="target">Target buffer.</param>
- <param name="level">Compression level.</param>
- <param name="extraMemory">Extra memory for encoder.</param>
- <returns>LZ4 frame writer.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Encode(System.IO.Stream,K4os.Compression.LZ4.Streams.LZ4EncoderSettings,System.Boolean)">
- <summary>
- Create LZ4 encoder that writes compressed data into target stream.
- </summary>
- <param name="target">Target stream.</param>
- <param name="settings">Encoder settings.</param>
- <param name="leaveOpen">Leave target stream open after encoder is disposed.</param>
- <returns>LZ4 frame writer.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Encode(System.IO.Stream,K4os.Compression.LZ4.LZ4Level,System.Int32,System.Boolean)">
- <summary>
- Create LZ4 encoder that writes compressed data into target stream.
- </summary>
- <param name="target">Target stream.</param>
- <param name="level">Compression level.</param>
- <param name="extraMemory">Extra memory for encoder.</param>
- <param name="leaveOpen">Leave target stream open after encoder is disposed.</param>
- <returns></returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Encode(System.IO.Pipelines.PipeWriter,K4os.Compression.LZ4.Streams.LZ4EncoderSettings,System.Boolean)">
- <summary>
- Create LZ4 encoder that writes compressed data into target pipe.
- </summary>
- <param name="target">Target pipe.</param>
- <param name="settings">Encoder settings.</param>
- <param name="leaveOpen">Leave target pipe open after encoder is disposed.</param>
- <returns>LZ4 frame writer.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Encode(System.IO.Pipelines.PipeWriter,K4os.Compression.LZ4.LZ4Level,System.Int32,System.Boolean)">
- <summary>
- Create LZ4 encoder that writes compressed data into target pipe.
- </summary>
- <param name="target">Target pipe.</param>
- <param name="level">Compression level.</param>
- <param name="extraMemory">Extra memory for encoder.</param>
- <param name="leaveOpen">Leave target pipe open after encoder is disposed.</param>
- <returns>LZ4 frame writer.</returns>
- </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,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>
- <param name="interactive">If <c>true</c> reading from stream will be "interactive" allowing
- to read bytes as soon as possible, even if more data is expected.</param>
- <returns>Decompression stream.</returns>
- </member>
- <member name="M:K4os.Compression.LZ4.Streams.LZ4Stream.Decode(System.IO.Stream,System.Int32,System.Boolean,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>
- <param name="interactive">If <c>true</c> reading from stream will be "interactive" allowing
- to read bytes as soon as possible, even if more data is expected.</param>
- <returns>Decompression stream.</returns>
- </member>
- </members>
- </doc>
|