K4os.Compression.LZ4.Streams.xml 103 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>K4os.Compression.LZ4.Streams</name>
  5. </assembly>
  6. <members>
  7. <member name="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader">
  8. <summary>
  9. Generic interface for frame/stream decoder for LZ4.
  10. </summary>
  11. </member>
  12. <member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader.OpenFrame">
  13. <summary>
  14. Opens frame for reading. Please note, this method is not needed as it will be
  15. called automatically, but it can be used to quickly check if frame is valid.
  16. </summary>
  17. <returns><c>true</c> if frame was just opened,
  18. <c>false</c> if it was opened before.</returns>
  19. </member>
  20. <member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader.OpenFrameAsync(System.Threading.CancellationToken)">
  21. <summary>Async version of <see cref="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader.OpenFrame"/>.</summary>
  22. <param name="token">Cancellation token.</param>
  23. <returns><c>true</c> if frame was just opened,
  24. <c>false</c> if it was opened before.</returns>
  25. </member>
  26. <member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader.GetFrameLength">
  27. <summary>Gets the length of the frame content if it was provided when content was encoded.</summary>
  28. <returns>Frame length, or <c>null</c></returns>
  29. </member>
  30. <member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader.GetFrameLengthAsync(System.Threading.CancellationToken)">
  31. <summary>Async version of <see cref="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader.GetFrameLength"/>.</summary>
  32. <param name="token">Cancellation token.</param>
  33. <returns>Frame length, or <c>null</c></returns>
  34. </member>
  35. <member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader.ReadOneByte">
  36. <summary>Reads one byte from LZ4 stream.</summary>
  37. <returns>A byte, or -1 if end of stream.</returns>
  38. </member>
  39. <member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader.ReadOneByteAsync(System.Threading.CancellationToken)">
  40. <summary>Reads one byte from LZ4 stream.</summary>
  41. <param name="token">Cancellation token.</param>
  42. <returns>A byte, or -1 if end of stream.</returns>
  43. </member>
  44. <member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader.ReadManyBytes(System.Span{System.Byte},System.Boolean)">
  45. <summary>Reads many bytes from LZ4 stream. Return number of bytes actually read.</summary>
  46. <param name="buffer">Byte buffer to read into.</param>
  47. <param name="interactive">if <c>true</c> then returns as soon as some bytes are read,
  48. if <c>false</c> then waits for all bytes being read or end of stream.</param>
  49. <returns>Number of bytes actually read.
  50. <c>0</c> means that end of stream has been reached.</returns>
  51. </member>
  52. <member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader.ReadManyBytesAsync(System.Threading.CancellationToken,System.Memory{System.Byte},System.Boolean)">
  53. <summary>Reads many bytes from LZ4 stream. Return number of bytes actually read.</summary>
  54. <param name="token">Cancellation token.</param>
  55. <param name="buffer">Byte buffer to read into.</param>
  56. <param name="interactive">if <c>true</c> then returns as soon as some bytes are read,
  57. if <c>false</c> then waits for all bytes being read or end of stream.</param>
  58. <returns>Number of bytes actually read.
  59. <c>0</c> means that end of stream has been reached.</returns>
  60. </member>
  61. <member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader.GetBytesRead">
  62. <summary>Returns how many bytes in has been read from stream so far.</summary>
  63. <returns>Number of bytes read in total.</returns>
  64. </member>
  65. <member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader.CloseFrame">
  66. <summary>Closes the stream, releases allocated memory.</summary>
  67. </member>
  68. <member name="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter">
  69. <summary>
  70. Generic interface for LZ4 frame/stream writer.
  71. </summary>
  72. </member>
  73. <member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter.OpenFrame">
  74. <summary>
  75. Opens a stream by reading frame header. Please note, this methods can be called explicitly
  76. but does not need to be called, it will be called automatically if needed.
  77. </summary>
  78. <returns><c>true</c> if frame has been opened,
  79. or <c>false</c> if it was opened before.</returns>
  80. </member>
  81. <member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter.OpenFrameAsync(System.Threading.CancellationToken)">
  82. <summary>
  83. Opens a stream by reading frame header. Please note, this methods can be called explicitly
  84. but does not need to be called, it will be called automatically if needed.
  85. </summary>
  86. <param name="token">Cancellation token.</param>
  87. <returns><c>true</c> if frame has been opened,
  88. or <c>false</c> if it was opened before.</returns>
  89. </member>
  90. <member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter.WriteOneByte(System.Byte)">
  91. <summary>Writes one byte to stream.</summary>
  92. <param name="value">Byte to be written.</param>
  93. </member>
  94. <member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter.WriteOneByteAsync(System.Threading.CancellationToken,System.Byte)">
  95. <summary>Writes one byte to stream.</summary>
  96. <param name="token">Cancellation token.</param>
  97. <param name="value">Byte to be written.</param>
  98. </member>
  99. <member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter.WriteManyBytes(System.ReadOnlySpan{System.Byte})">
  100. <summary>Writes multiple bytes to stream.</summary>
  101. <param name="buffer">Byte buffer.</param>
  102. </member>
  103. <member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter.WriteManyBytesAsync(System.Threading.CancellationToken,System.ReadOnlyMemory{System.Byte})">
  104. <summary>Writes multiple bytes to stream.</summary>
  105. <param name="token">Cancellation token.</param>
  106. <param name="buffer">Byte buffer.</param>
  107. </member>
  108. <member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter.GetBytesWritten">
  109. <summary>Gets number of bytes written.</summary>
  110. <returns>Total number of bytes (before compression).</returns>
  111. </member>
  112. <member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter.CloseFrame">
  113. <summary>
  114. Closes frame. Frame needs to be closed for stream to by valid, although
  115. this methods does not need to be called explicitly if stream is properly dispose.
  116. </summary>
  117. </member>
  118. <member name="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter.CloseFrameAsync(System.Threading.CancellationToken)">
  119. <summary>
  120. Closes frame. Frame needs to be closed for stream to by valid, although
  121. this methods does not need to be called explicitly if stream is properly dispose.
  122. </summary>
  123. <param name="token">Cancellation token.</param>
  124. </member>
  125. <member name="T:K4os.Compression.LZ4.Streams.Abstractions.IStreamReader`1">
  126. <summary>
  127. Stream reader interface. It is an adapter for all stream-like structures.
  128. </summary>
  129. <typeparam name="TStreamState">Stream state.</typeparam>
  130. </member>
  131. <member name="M:K4os.Compression.LZ4.Streams.Abstractions.IStreamReader`1.Read(`0@,System.Byte[],System.Int32,System.Int32)">
  132. <summary>
  133. Reads at-most <paramref name="length"/> bytes from given <paramref name="state"/>.
  134. </summary>
  135. <param name="state">Stream state.</param>
  136. <param name="buffer">Buffer to read bytes into.</param>
  137. <param name="offset">Offset in buffer.</param>
  138. <param name="length">Maximum number of bytes to read.</param>
  139. <returns>Number of bytes actually read.</returns>
  140. </member>
  141. <member name="M:K4os.Compression.LZ4.Streams.Abstractions.IStreamReader`1.ReadAsync(`0,System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
  142. <summary>
  143. Reads at-most <paramref name="length"/> bytes from given <paramref name="state"/>.
  144. </summary>
  145. <param name="state">Stream state.</param>
  146. <param name="buffer">Buffer to read bytes into.</param>
  147. <param name="offset">Offset in buffer.</param>
  148. <param name="length">Maximum number of bytes to read.</param>
  149. <param name="token">Cancellation token.</param>
  150. <returns><see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ReadResult`1"/> containing new stream state,
  151. and number of bytes actually read..</returns>
  152. </member>
  153. <member name="T:K4os.Compression.LZ4.Streams.Abstractions.IStreamWriter`1">
  154. <summary>
  155. Generic stream writer interface.
  156. When implementing custom compression target or decompression source you need to implement
  157. this adapter. Please note, that this adapter can be implemented as <c>class</c> or
  158. <c>readonly struct</c>. If implemented as <c>struct</c> it cannot have mutable state
  159. as it will be lost. Immutable state is allowed but strongly discouraged.
  160. Use <typeparamref name="TStreamState"/> instead.
  161. </summary>
  162. <typeparam name="TStreamState">Mutable part of stream state.</typeparam>
  163. </member>
  164. <member name="P:K4os.Compression.LZ4.Streams.Abstractions.IStreamWriter`1.CanFlush">
  165. <summary>Indicates that writer can and should flush after frame.
  166. Please note, flushing may have negative performance effect but may also lead to
  167. better interactivity between writer and reader, as reader will get new block
  168. available as soon as possible.</summary>
  169. </member>
  170. <member name="M:K4os.Compression.LZ4.Streams.Abstractions.IStreamWriter`1.Write(`0@,System.Byte[],System.Int32,System.Int32)">
  171. <summary>Writes byte buffer to underlying stream.</summary>
  172. <param name="state">Stream state.</param>
  173. <param name="buffer">Byte buffer.</param>
  174. <param name="offset">Offset within buffer.</param>
  175. <param name="length">Number of bytes.</param>
  176. </member>
  177. <member name="M:K4os.Compression.LZ4.Streams.Abstractions.IStreamWriter`1.WriteAsync(`0,System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
  178. <summary>Writes byte buffer to underlying stream.</summary>
  179. <param name="state">Stream state.</param>
  180. <param name="buffer">Byte buffer.</param>
  181. <param name="offset">Offset within buffer.</param>
  182. <param name="length">Number of bytes.</param>
  183. <param name="token">Cancellation token.</param>
  184. <returns>New stream state (mutable part).</returns>
  185. </member>
  186. <member name="M:K4os.Compression.LZ4.Streams.Abstractions.IStreamWriter`1.Flush(`0@)">
  187. <summary>Flushes buffers to underlying storage. Called only when <see cref="P:K4os.Compression.LZ4.Streams.Abstractions.IStreamWriter`1.CanFlush"/></summary>
  188. <param name="state">Stream state.</param>
  189. </member>
  190. <member name="M:K4os.Compression.LZ4.Streams.Abstractions.IStreamWriter`1.FlushAsync(`0,System.Threading.CancellationToken)">
  191. <summary>Flushes buffers to underlying storage. Called only when <see cref="P:K4os.Compression.LZ4.Streams.Abstractions.IStreamWriter`1.CanFlush"/></summary>
  192. <param name="state">Stream state.</param>
  193. <param name="token">Cancellation token.</param>
  194. <returns>New stream state (mutable part).</returns>
  195. </member>
  196. <member name="T:K4os.Compression.LZ4.Streams.Abstractions.ReadResult`1">
  197. <summary>
  198. Result of async read operation. Returns new state of the stream and number of bytes read.
  199. </summary>
  200. <param name="Stream">New stream state.</param>
  201. <param name="Bytes">Number of bytes read.</param>
  202. <typeparam name="TStreamState">Stream state.</typeparam>
  203. </member>
  204. <member name="M:K4os.Compression.LZ4.Streams.Abstractions.ReadResult`1.#ctor(`0,System.Int32)">
  205. <summary>
  206. Result of async read operation. Returns new state of the stream and number of bytes read.
  207. </summary>
  208. <param name="Stream">New stream state.</param>
  209. <param name="Bytes">Number of bytes read.</param>
  210. <typeparam name="TStreamState">Stream state.</typeparam>
  211. </member>
  212. <member name="P:K4os.Compression.LZ4.Streams.Abstractions.ReadResult`1.Stream">
  213. <summary>New stream state.</summary>
  214. </member>
  215. <member name="P:K4os.Compression.LZ4.Streams.Abstractions.ReadResult`1.Bytes">
  216. <summary>Number of bytes read.</summary>
  217. </member>
  218. <member name="T:K4os.Compression.LZ4.Streams.Abstractions.ReadResult">
  219. <summary>
  220. Helper methods to create <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ReadResult`1"/>
  221. </summary>
  222. </member>
  223. <member name="M:K4os.Compression.LZ4.Streams.Abstractions.ReadResult.Create``1(``0,System.Int32)">
  224. <summary>
  225. Creates read result, composed of new stream state and bytes read.
  226. </summary>
  227. <param name="stream">Stream state.</param>
  228. <param name="bytes">Bytes read.</param>
  229. <typeparam name="TStreamState">Stream state.</typeparam>
  230. <returns>Read result.</returns>
  231. </member>
  232. <member name="T:K4os.Compression.LZ4.Streams.Adapters.ByteBufferAdapter`1">
  233. <summary>
  234. Stream adapter for any class implementing <see cref="T:System.Buffers.IBufferWriter`1"/>.
  235. It takes actual class, not interface, so it can use struct implementations
  236. of <see cref="T:System.Buffers.IBufferWriter`1"/> for performance reasons.
  237. Please note, whole <c>K4os.Compression.LZ4.Streams.Adapters</c> namespace should be considered
  238. pubternal - exposed as public but still very likely to change.
  239. </summary>
  240. <typeparam name="TBufferWriter">Type implementing <see cref="T:System.Buffers.IBufferWriter`1"/></typeparam>
  241. </member>
  242. <member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteBufferAdapter`1.Write(`0@,System.Byte[],System.Int32,System.Int32)">
  243. <inheritdoc />
  244. </member>
  245. <member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteBufferAdapter`1.WriteAsync(`0,System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
  246. <inheritdoc />
  247. </member>
  248. <member name="P:K4os.Compression.LZ4.Streams.Adapters.ByteBufferAdapter`1.CanFlush">
  249. <inheritdoc />
  250. </member>
  251. <member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteBufferAdapter`1.Flush(`0@)">
  252. <inheritdoc />
  253. </member>
  254. <member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteBufferAdapter`1.FlushAsync(`0,System.Threading.CancellationToken)">
  255. <inheritdoc />
  256. </member>
  257. <member name="T:K4os.Compression.LZ4.Streams.Adapters.ByteMemoryReadAdapter">
  258. <summary>
  259. Stream adapter for <see cref="T:System.ReadOnlyMemory`1"/> and <see cref="T:System.Memory`1"/>.
  260. This class implements <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.IStreamWriter`1"/> for <see cref="T:System.Memory`1"/>
  261. but should be used only in some niche situations, as it is not easy to find out
  262. how many bytes has been written, use <see cref="T:K4os.Compression.LZ4.Streams.Adapters.ByteBufferAdapter`1"/>
  263. instead.
  264. Please note, whole <c>K4os.Compression.LZ4.Streams.Adapters</c> namespace should be considered
  265. pubternal - exposed as public but still very likely to change.
  266. </summary>
  267. </member>
  268. <member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteMemoryReadAdapter.#ctor(System.ReadOnlyMemory{System.Byte})">
  269. <summary>
  270. </summary>
  271. <param name="memory"></param>
  272. </member>
  273. <member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteMemoryReadAdapter.CopyToBuffer(System.Int32,System.Byte[],System.Int32,System.Int32)">
  274. <summary>
  275. Copies bytes from span to buffer. Performs all length checks.
  276. </summary>
  277. <param name="head">Head offset of <see cref="T:System.ReadOnlyMemory`1"/>.</param>
  278. <param name="buffer">Target buffer.</param>
  279. <param name="offset">Offset in target buffer.</param>
  280. <param name="length">Number of bytes to copy.</param>
  281. <returns>Number of bytes actually copied.</returns>
  282. </member>
  283. <member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteMemoryReadAdapter.Read(System.Int32@,System.Byte[],System.Int32,System.Int32)">
  284. <inheritdoc />
  285. </member>
  286. <member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteMemoryReadAdapter.ReadAsync(System.Int32,System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
  287. <inheritdoc />
  288. </member>
  289. <member name="T:K4os.Compression.LZ4.Streams.Adapters.ByteMemoryWriteAdapter">
  290. <summary>
  291. Stream adapter for <see cref="T:System.ReadOnlyMemory`1"/> and <see cref="T:System.Memory`1"/>.
  292. This class implements <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.IStreamWriter`1"/> for <see cref="T:System.Memory`1"/>
  293. but should be used only in some niche situations, as it is not easy to find out
  294. how many bytes has been written, use <see cref="T:K4os.Compression.LZ4.Streams.Adapters.ByteBufferAdapter`1"/>
  295. instead.
  296. Please note, whole <c>K4os.Compression.LZ4.Streams.Adapters</c> namespace should be considered
  297. pubternal - exposed as public but still very likely to change.
  298. </summary>
  299. </member>
  300. <member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteMemoryWriteAdapter.#ctor(System.Memory{System.Byte})">
  301. <summary>
  302. Initializes a new instance of the <see cref="T:K4os.Compression.LZ4.Streams.Adapters.ByteMemoryWriteAdapter"/> class.
  303. </summary>
  304. <param name="memory">Memory buffer.</param>
  305. </member>
  306. <member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteMemoryWriteAdapter.Write(System.Int32@,System.Byte[],System.Int32,System.Int32)">
  307. <inheritdoc />
  308. </member>
  309. <member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteMemoryWriteAdapter.WriteAsync(System.Int32,System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
  310. <inheritdoc />
  311. </member>
  312. <member name="P:K4os.Compression.LZ4.Streams.Adapters.ByteMemoryWriteAdapter.CanFlush">
  313. <inheritdoc />
  314. </member>
  315. <member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteMemoryWriteAdapter.Flush(System.Int32@)">
  316. <inheritdoc />
  317. </member>
  318. <member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteMemoryWriteAdapter.FlushAsync(System.Int32,System.Threading.CancellationToken)">
  319. <inheritdoc />
  320. </member>
  321. <member name="T:K4os.Compression.LZ4.Streams.Adapters.ByteSequenceAdapter">
  322. <summary>
  323. Naive and simplistic implementation of adapter for <see cref="T:System.Buffers.ReadOnlySequence`1"/>.
  324. It might be improved in many ways I believe, but it gives some starting point.
  325. Please note, whole <c>K4os.Compression.LZ4.Streams.Adapters</c> namespace should be considered
  326. pubternal - exposed as public but still very likely to change.
  327. </summary>
  328. </member>
  329. <member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteSequenceAdapter.Read(System.Buffers.ReadOnlySequence{System.Byte}@,System.Byte[],System.Int32,System.Int32)">
  330. <inheritdoc />
  331. </member>
  332. <member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteSequenceAdapter.ReadAsync(System.Buffers.ReadOnlySequence{System.Byte},System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
  333. <inheritdoc />
  334. </member>
  335. <member name="T:K4os.Compression.LZ4.Streams.Adapters.ByteSpanAdapter">
  336. <summary>
  337. LZ4 stream reader/writer adapter for <see cref="T:K4os.Compression.LZ4.Streams.Adapters.UnsafeByteSpan"/>.
  338. </summary>
  339. </member>
  340. <member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteSpanAdapter.#ctor(K4os.Compression.LZ4.Streams.Adapters.UnsafeByteSpan)">
  341. <summary>
  342. Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Adapters.ByteSpanAdapter"/>.
  343. </summary>
  344. <param name="span">Memory span.</param>
  345. </member>
  346. <member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteSpanAdapter.Read(System.Int32@,System.Byte[],System.Int32,System.Int32)">
  347. <inheritdoc />
  348. </member>
  349. <member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteSpanAdapter.ReadAsync(System.Int32,System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
  350. <inheritdoc />
  351. </member>
  352. <member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteSpanAdapter.Write(System.Int32@,System.Byte[],System.Int32,System.Int32)">
  353. <inheritdoc />
  354. </member>
  355. <member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteSpanAdapter.WriteAsync(System.Int32,System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
  356. <inheritdoc />
  357. </member>
  358. <member name="P:K4os.Compression.LZ4.Streams.Adapters.ByteSpanAdapter.CanFlush">
  359. <inheritdoc />
  360. </member>
  361. <member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteSpanAdapter.Flush(System.Int32@)">
  362. <inheritdoc />
  363. </member>
  364. <member name="M:K4os.Compression.LZ4.Streams.Adapters.ByteSpanAdapter.FlushAsync(System.Int32,System.Threading.CancellationToken)">
  365. <inheritdoc />
  366. </member>
  367. <member name="T:K4os.Compression.LZ4.Streams.Adapters.EmptyState">
  368. <summary>
  369. Empty record equivalent to Unit/Void.
  370. Works as placeholder type used when working with generic interfaces which do require type,
  371. but implementation needs none.
  372. Please note, whole <c>K4os.Compression.LZ4.Streams.Adapters</c> namespace should be considered
  373. pubternal - exposed as public but still very likely to change.
  374. </summary>
  375. </member>
  376. <member name="T:K4os.Compression.LZ4.Streams.Adapters.PipeReaderAdapter">
  377. <summary>
  378. Stream adapter for <see cref="T:System.IO.Pipelines.PipeReader"/>.
  379. Please note, whole <c>K4os.Compression.LZ4.Streams.Adapters</c> namespace should be considered
  380. pubternal - exposed as public but still very likely to change.
  381. </summary>
  382. </member>
  383. <member name="M:K4os.Compression.LZ4.Streams.Adapters.PipeReaderAdapter.#ctor(System.IO.Pipelines.PipeReader)">
  384. <summary>
  385. Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Adapters.PipeReaderAdapter"/>.
  386. </summary>
  387. <param name="reader">Pipe reader.</param>
  388. </member>
  389. <member name="M:K4os.Compression.LZ4.Streams.Adapters.PipeReaderAdapter.Read(K4os.Compression.LZ4.Streams.Adapters.EmptyState@,System.Byte[],System.Int32,System.Int32)">
  390. <inheritdoc />
  391. </member>
  392. <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)">
  393. <inheritdoc />
  394. </member>
  395. <member name="T:K4os.Compression.LZ4.Streams.Adapters.PipeWriterAdapter">
  396. <summary>
  397. LZ4 stream adapter for <see cref="T:System.IO.Pipelines.PipeReader"/>.
  398. Please note, whole <c>K4os.Compression.LZ4.Streams.Adapters</c> namespace should be considered
  399. pubternal - exposed as public but still very likely to change.
  400. </summary>
  401. </member>
  402. <member name="M:K4os.Compression.LZ4.Streams.Adapters.PipeWriterAdapter.#ctor(System.IO.Pipelines.PipeWriter)">
  403. <summary>
  404. Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Adapters.PipeWriterAdapter"/>.
  405. </summary>
  406. <param name="writer">Pipe writer.</param>
  407. </member>
  408. <member name="M:K4os.Compression.LZ4.Streams.Adapters.PipeWriterAdapter.Write(K4os.Compression.LZ4.Streams.Adapters.EmptyState@,System.Byte[],System.Int32,System.Int32)">
  409. <inheritdoc />
  410. </member>
  411. <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)">
  412. <inheritdoc />
  413. </member>
  414. <member name="P:K4os.Compression.LZ4.Streams.Adapters.PipeWriterAdapter.CanFlush">
  415. <inheritdoc />
  416. </member>
  417. <member name="M:K4os.Compression.LZ4.Streams.Adapters.PipeWriterAdapter.Flush(K4os.Compression.LZ4.Streams.Adapters.EmptyState@)">
  418. <inheritdoc />
  419. </member>
  420. <member name="M:K4os.Compression.LZ4.Streams.Adapters.PipeWriterAdapter.FlushAsync(K4os.Compression.LZ4.Streams.Adapters.EmptyState,System.Threading.CancellationToken)">
  421. <inheritdoc />
  422. </member>
  423. <member name="T:K4os.Compression.LZ4.Streams.Adapters.StreamAdapter">
  424. <summary>
  425. LZ4 stream reader/writer adapter for <see cref="T:System.IO.Stream"/>.
  426. Please note, whole <c>K4os.Compression.LZ4.Streams.Adapters</c> namespace should be considered
  427. pubternal - exposed as public but still very likely to change.
  428. </summary>
  429. </member>
  430. <member name="M:K4os.Compression.LZ4.Streams.Adapters.StreamAdapter.#ctor(System.IO.Stream)">
  431. <summary>
  432. Creates new stream adapter for
  433. </summary>
  434. <param name="stream"></param>
  435. </member>
  436. <member name="M:K4os.Compression.LZ4.Streams.Adapters.StreamAdapter.Read(K4os.Compression.LZ4.Streams.Adapters.EmptyState@,System.Byte[],System.Int32,System.Int32)">
  437. <inheritdoc />
  438. </member>
  439. <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)">
  440. <inheritdoc />
  441. </member>
  442. <member name="M:K4os.Compression.LZ4.Streams.Adapters.StreamAdapter.Write(K4os.Compression.LZ4.Streams.Adapters.EmptyState@,System.Byte[],System.Int32,System.Int32)">
  443. <inheritdoc />
  444. </member>
  445. <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)">
  446. <inheritdoc />
  447. </member>
  448. <member name="P:K4os.Compression.LZ4.Streams.Adapters.StreamAdapter.CanFlush">
  449. <inheritdoc />
  450. </member>
  451. <member name="M:K4os.Compression.LZ4.Streams.Adapters.StreamAdapter.Flush(K4os.Compression.LZ4.Streams.Adapters.EmptyState@)">
  452. <inheritdoc />
  453. </member>
  454. <member name="M:K4os.Compression.LZ4.Streams.Adapters.StreamAdapter.FlushAsync(K4os.Compression.LZ4.Streams.Adapters.EmptyState,System.Threading.CancellationToken)">
  455. <inheritdoc />
  456. </member>
  457. <member name="T:K4os.Compression.LZ4.Streams.Adapters.UnsafeByteSpan">
  458. <summary>
  459. Unsafe version of <see cref="T:System.Span`1"/>. It is unsafe as it stores raw memory pointer
  460. so memory it points to must be pinned. It allows reading and writing straight to
  461. unmanaged memory but must be used carefully.
  462. NOTE: If you don't understand what has been said above - don't use it. Misuse of this
  463. struct may lead to unpredictable errors and memory corruption.
  464. </summary>
  465. </member>
  466. <member name="P:K4os.Compression.LZ4.Streams.Adapters.UnsafeByteSpan.Bytes">
  467. <summary>Pointer to the first byte of the span.</summary>
  468. </member>
  469. <member name="P:K4os.Compression.LZ4.Streams.Adapters.UnsafeByteSpan.Length">
  470. <summary>Length of the span in bytes.</summary>
  471. </member>
  472. <member name="M:K4os.Compression.LZ4.Streams.Adapters.UnsafeByteSpan.#ctor(System.Void*,System.Int32)">
  473. <summary>
  474. Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Adapters.UnsafeByteSpan"/> from given pointer and length.
  475. </summary>
  476. <param name="bytes">Pointer to the first byte of the span.</param>
  477. <param name="length">Length of the span in bytes.</param>
  478. </member>
  479. <member name="M:K4os.Compression.LZ4.Streams.Adapters.UnsafeByteSpan.Create(System.Void*,System.Int32)">
  480. <summary>
  481. Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Adapters.UnsafeByteSpan"/> from raw pointer.
  482. </summary>
  483. <param name="bytes">Pointer block of bytes.</param>
  484. <param name="length">Length of the block.</param>
  485. <returns>New <see cref="T:K4os.Compression.LZ4.Streams.Adapters.UnsafeByteSpan"/>.</returns>
  486. </member>
  487. <member name="P:K4os.Compression.LZ4.Streams.Adapters.UnsafeByteSpan.Span">
  488. <summary>
  489. Converted to <see cref="T:System.Span`1"/>.
  490. </summary>
  491. </member>
  492. <member name="T:K4os.Compression.LZ4.Streams.Extensions">
  493. <summary>
  494. Utility methods for LZ4 streams.
  495. </summary>
  496. </member>
  497. <member name="M:K4os.Compression.LZ4.Streams.Extensions.CreateEncoder(K4os.Compression.LZ4.Streams.ILZ4Descriptor,K4os.Compression.LZ4.LZ4Level,System.Int32)">
  498. <summary>
  499. Creates <see cref="T:K4os.Compression.LZ4.Encoders.ILZ4Encoder"/> using <see cref="T:K4os.Compression.LZ4.Streams.ILZ4Descriptor"/>.
  500. </summary>
  501. <param name="descriptor">LZ4 descriptor.</param>
  502. <param name="level">Compression level.</param>
  503. <param name="extraMemory">Additional memory for encoder.</param>
  504. <returns>Encoder.</returns>
  505. </member>
  506. <member name="M:K4os.Compression.LZ4.Streams.Extensions.CreateEncoder(K4os.Compression.LZ4.Streams.ILZ4Descriptor,K4os.Compression.LZ4.Streams.LZ4EncoderSettings)">
  507. <summary>
  508. 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"/>.
  509. </summary>
  510. <param name="descriptor">LZ4 descriptor.</param>
  511. <param name="settings">Encoder settings.</param>
  512. <returns>Encoder.</returns>
  513. </member>
  514. <member name="M:K4os.Compression.LZ4.Streams.Extensions.CreateDecoder(K4os.Compression.LZ4.Streams.ILZ4Descriptor,System.Int32)">
  515. <summary>
  516. Create <see cref="T:K4os.Compression.LZ4.Encoders.ILZ4Decoder"/> using <see cref="T:K4os.Compression.LZ4.Streams.ILZ4Descriptor"/>.
  517. </summary>
  518. <param name="descriptor">Descriptor.</param>
  519. <param name="extraMemory">Extra memory (may improves speed, but creates memory pressure).</param>
  520. <returns><see cref="T:K4os.Compression.LZ4.Encoders.ILZ4Decoder"/>.</returns>
  521. </member>
  522. <member name="M:K4os.Compression.LZ4.Streams.Extensions.CreateDecoder(K4os.Compression.LZ4.Streams.ILZ4Descriptor,K4os.Compression.LZ4.Streams.LZ4DecoderSettings)">
  523. <summary>
  524. 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"/>.
  525. </summary>
  526. <param name="descriptor">Descriptor.</param>
  527. <param name="settings">Settings.</param>
  528. <returns><see cref="T:K4os.Compression.LZ4.Encoders.ILZ4Decoder"/>.</returns>
  529. </member>
  530. <member name="M:K4os.Compression.LZ4.Streams.Extensions.CreateDescriptor(K4os.Compression.LZ4.Streams.LZ4EncoderSettings)">
  531. <summary>
  532. Creates <see cref="T:K4os.Compression.LZ4.Streams.ILZ4Descriptor"/> from <see cref="T:K4os.Compression.LZ4.Streams.LZ4DecoderSettings"/>.
  533. </summary>
  534. <param name="settings">Settings.</param>
  535. <returns>LZ4 Descriptor.</returns>
  536. </member>
  537. <member name="M:K4os.Compression.LZ4.Streams.Extensions.OpenFrameAsync(K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader)">
  538. <summary>Async version of <see cref="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader.OpenFrame"/>.</summary>
  539. <param name="reader">Decoder.</param>
  540. <returns><c>true</c> if frame was just opened,
  541. <c>false</c> if it was opened before.</returns>
  542. </member>
  543. <member name="M:K4os.Compression.LZ4.Streams.Extensions.GetFrameLengthAsync(K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader)">
  544. <summary>Async version of <see cref="M:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader.GetFrameLength"/>.</summary>
  545. <param name="reader">Decoder.</param>
  546. <returns>Frame length, or <c>null</c></returns>
  547. </member>
  548. <member name="M:K4os.Compression.LZ4.Streams.Extensions.ReadOneByteAsync(K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader)">
  549. <summary>Reads one byte from LZ4 stream.</summary>
  550. <param name="reader">Decoder.</param>
  551. <returns>A byte, or -1 if end of stream.</returns>
  552. </member>
  553. <member name="M:K4os.Compression.LZ4.Streams.Extensions.ReadManyBytesAsync(K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader,System.Memory{System.Byte},System.Boolean)">
  554. <summary>Reads many bytes from LZ4 stream. Return number of bytes actually read.</summary>
  555. <param name="reader">Decoder.</param>
  556. <param name="buffer">Byte buffer to read into.</param>
  557. <param name="interactive">if <c>true</c> then returns as soon as some bytes are read,
  558. if <c>false</c> then waits for all bytes being read or end of stream.</param>
  559. <returns>Number of bytes actually read.
  560. <c>0</c> means that end of stream has been reached.</returns>
  561. </member>
  562. <member name="M:K4os.Compression.LZ4.Streams.Extensions.OpenFrameAsync(K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter)">
  563. <summary>
  564. Opens a stream by reading frame header. Please note, this methods can be called explicitly
  565. but does not need to be called, it will be called automatically if needed.
  566. </summary>
  567. <param name="writer">Encoder.</param>
  568. <returns><c>true</c> if frame has been opened, or <c>false</c> if it was opened before.</returns>
  569. </member>
  570. <member name="M:K4os.Compression.LZ4.Streams.Extensions.WriteOneByteAsync(K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter,System.Byte)">
  571. <summary>Writes one byte to stream.</summary>
  572. <param name="writer">Encoder.</param>
  573. <param name="value">Byte to be written.</param>
  574. </member>
  575. <member name="M:K4os.Compression.LZ4.Streams.Extensions.WriteManyBytesAsync(K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter,System.ReadOnlyMemory{System.Byte})">
  576. <summary>Writes multiple bytes to stream.</summary>
  577. <param name="writer">Encoder.</param>
  578. <param name="buffer">Byte buffer.</param>
  579. </member>
  580. <member name="M:K4os.Compression.LZ4.Streams.Extensions.CloseFrameAsync(K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter)">
  581. <summary>
  582. Closes frame. Frame needs to be closed for stream to by valid, although
  583. this methods does not need to be called explicitly if stream is properly dispose.
  584. </summary>
  585. <param name="writer">Encoder.</param>
  586. </member>
  587. <member name="M:K4os.Compression.LZ4.Streams.Extensions.CopyTo``1(K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader,``0,System.Int32)">
  588. <summary>
  589. Copies all bytes from <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader"/> into <see cref="T:System.Buffers.IBufferWriter`1"/>.
  590. </summary>
  591. <param name="source">Frame reader.</param>
  592. <param name="target">Buffer writer.</param>
  593. <param name="blockSize">Chunk size.</param>
  594. <typeparam name="TBufferWriter">Type of buffer writer.</typeparam>
  595. </member>
  596. <member name="M:K4os.Compression.LZ4.Streams.Extensions.CopyToAsync``1(K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader,``0,System.Int32)">
  597. <summary>
  598. Copies all bytes from <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader"/> into <see cref="T:System.Buffers.IBufferWriter`1"/>.
  599. </summary>
  600. <param name="source">LZ4 frame reader.</param>
  601. <param name="target">Buffer writer.</param>
  602. <param name="blockSize">Chunk size.</param>
  603. <typeparam name="TBufferWriter">Type of buffer writer.</typeparam>
  604. </member>
  605. <member name="M:K4os.Compression.LZ4.Streams.Extensions.CopyFrom(K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter,System.Buffers.ReadOnlySequence{System.Byte})">
  606. <summary>
  607. Copies all bytes from <see cref="T:System.Buffers.ReadOnlySequence`1"/> into <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter"/>.
  608. </summary>
  609. <param name="target">Frame writer.</param>
  610. <param name="source">Sequence of bytes.</param>
  611. </member>
  612. <member name="M:K4os.Compression.LZ4.Streams.Extensions.CopyFromAsync(K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter,System.Buffers.ReadOnlySequence{System.Byte})">
  613. <summary>
  614. Copies all bytes from <see cref="T:System.Buffers.ReadOnlySequence`1"/> into <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter"/>.
  615. </summary>
  616. <param name="target">Frame writer.</param>
  617. <param name="source">Sequence of bytes.</param>
  618. </member>
  619. <member name="M:K4os.Compression.LZ4.Streams.Extensions.AsStream(K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader,System.Boolean,System.Boolean)">
  620. <summary>
  621. Wraps <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader"/> as <see cref="T:System.IO.Stream"/>.
  622. </summary>
  623. <param name="reader">LZ4 frame reader.</param>
  624. <param name="leaveOpen">Indicates that frame reader should be left open even if stream is
  625. disposed.</param>
  626. <param name="interactive">Indicates that data should be provided to reader as quick as
  627. possible, instead of waiting for whole block to be read.</param>
  628. <returns><see cref="T:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReaderAsStream"/> stream wrapper.</returns>
  629. </member>
  630. <member name="M:K4os.Compression.LZ4.Streams.Extensions.AsStream(K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter,System.Boolean)">
  631. <summary>
  632. Wraps <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter"/> as <see cref="T:System.IO.Stream"/>.
  633. </summary>
  634. <param name="writer">LZ4 frame writer.</param>
  635. <param name="leaveOpen">Indicates that frame writer should be left open even if stream is
  636. disposed.</param>
  637. <returns><see cref="T:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriterAsStream"/> stream wrapper.</returns>
  638. </member>
  639. <member name="T:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2">
  640. <summary>
  641. LZ4 Decompression stream handling.
  642. </summary>
  643. </member>
  644. <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})">
  645. <summary>Creates new instance <see cref="T:K4os.Compression.LZ4.Streams.LZ4DecoderStream"/>.</summary>
  646. <param name="reader">Inner stream.</param>
  647. <param name="stream">Inner stream initial state.</param>
  648. <param name="decoderFactory">Decoder factory.</param>
  649. </member>
  650. <member name="P:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.StreamState">
  651. <summary>
  652. Exposes internal stream state. Existence of this property is a hack,
  653. and it really shouldn't be here but it is needed for relatively low
  654. level operations (like writing directly to unmanaged memory).
  655. Please, do not use it directly, if don't know what you are doing.
  656. </summary>
  657. </member>
  658. <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.CloseFrame">
  659. <inheritdoc />
  660. </member>
  661. <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.AllocBuffer(System.Int32)">
  662. <summary>Allocate temporary buffer to store decompressed data.</summary>
  663. <param name="size">Minimum size of the buffer.</param>
  664. <returns>Allocated buffer.</returns>
  665. </member>
  666. <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.ReleaseBuffer(System.Byte[])">
  667. <summary>Releases allocated buffer. <see cref="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.AllocBuffer(System.Int32)"/></summary>
  668. <param name="buffer">Previously allocated buffer.</param>
  669. </member>
  670. <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.OpenFrame">
  671. <inheritdoc />
  672. </member>
  673. <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.OpenFrameAsync(System.Threading.CancellationToken)">
  674. <inheritdoc />
  675. </member>
  676. <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.GetBytesRead">
  677. <inheritdoc />
  678. </member>
  679. <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.GetFrameLength">
  680. <inheritdoc />
  681. </member>
  682. <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.GetFrameLengthAsync(System.Threading.CancellationToken)">
  683. <inheritdoc />
  684. </member>
  685. <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.ReadOneByte">
  686. <inheritdoc />
  687. </member>
  688. <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.ReadOneByteAsync(System.Threading.CancellationToken)">
  689. <inheritdoc />
  690. </member>
  691. <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.ReadManyBytes(System.Span{System.Byte},System.Boolean)">
  692. <inheritdoc />
  693. </member>
  694. <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.ReadManyBytesAsync(System.Threading.CancellationToken,System.Memory{System.Byte},System.Boolean)">
  695. <inheritdoc />
  696. </member>
  697. <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.Dispose(System.Boolean)">
  698. <summary>
  699. Disposes the decoder. Consecutive attempts to read will fail.
  700. </summary>
  701. <param name="disposing"><c>true</c> is stream is being disposed by user,
  702. <c>true</c> is by garbage collector.</param>
  703. </member>
  704. <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.ReleaseResources">
  705. <summary>
  706. Releases unmanaged resources.
  707. </summary>
  708. </member>
  709. <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.ReleaseResourcesAsync">
  710. <summary>
  711. Releases unmanaged resources.
  712. </summary>
  713. <returns>Task indicating operation is finished.</returns>
  714. </member>
  715. <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.Dispose">
  716. <inheritdoc />
  717. </member>
  718. <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReader`2.DisposeAsync">
  719. <inheritdoc />
  720. </member>
  721. <member name="T:K4os.Compression.LZ4.Streams.Frames.ByteSpanLZ4FrameReader">
  722. <summary>
  723. <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader"/> implementation for <see cref="T:K4os.Compression.LZ4.Streams.Adapters.UnsafeByteSpan"/>.
  724. </summary>
  725. </member>
  726. <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})">
  727. <summary>
  728. Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Frames.ByteSpanLZ4FrameReader"/>.
  729. </summary>
  730. <param name="span">Bytes span.</param>
  731. <param name="decoderFactory">LZ4 decoder factory.</param>
  732. </member>
  733. <member name="T:K4os.Compression.LZ4.Streams.Frames.ByteMemoryLZ4FrameReader">
  734. <summary>
  735. <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader"/> implementation for <see cref="T:System.ReadOnlyMemory`1"/>.
  736. </summary>
  737. </member>
  738. <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})">
  739. <summary>
  740. Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Frames.ByteMemoryLZ4FrameReader"/>.
  741. </summary>
  742. <param name="memory">Memory buffer.</param>
  743. <param name="decoderFactory">LZ4 decoder factory.</param>
  744. </member>
  745. <member name="T:K4os.Compression.LZ4.Streams.Frames.ByteSequenceLZ4FrameReader">
  746. <summary>
  747. <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader"/> implementation for <see cref="T:System.Buffers.ReadOnlySequence`1"/>.
  748. </summary>
  749. </member>
  750. <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})">
  751. <summary>
  752. Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Frames.ByteSequenceLZ4FrameReader"/>.
  753. </summary>
  754. <param name="sequence">Byte sequence.</param>
  755. <param name="decoderFactory">LZ4 decoder factory.</param>
  756. </member>
  757. <member name="T:K4os.Compression.LZ4.Streams.Frames.StreamLZ4FrameReader">
  758. <summary>
  759. <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader"/> implementation for <see cref="T:System.IO.Stream"/>.
  760. </summary>
  761. </member>
  762. <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})">
  763. <summary>
  764. Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Frames.StreamLZ4FrameReader"/>.
  765. </summary>
  766. <param name="stream">Stream to read from.</param>
  767. <param name="leaveOpen">Leave stream open after reader is disposed.</param>
  768. <param name="decoderFactory">LZ4 decoder factory.</param>
  769. </member>
  770. <member name="M:K4os.Compression.LZ4.Streams.Frames.StreamLZ4FrameReader.Dispose(System.Boolean)">
  771. <summary>
  772. Disposes the reader.
  773. </summary>
  774. <param name="disposing"><c>true</c> if user is disposing it; <c>false</c> if it has been triggered by garbage collector</param>
  775. </member>
  776. <member name="M:K4os.Compression.LZ4.Streams.Frames.StreamLZ4FrameReader.DisposeAsync">
  777. <summary>
  778. Disposes the reader.
  779. </summary>
  780. </member>
  781. <member name="T:K4os.Compression.LZ4.Streams.Frames.PipeLZ4FrameReader">
  782. <summary>
  783. <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader"/> implementation for <see cref="T:System.IO.Pipelines.PipeReader"/>.
  784. </summary>
  785. </member>
  786. <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})">
  787. <summary>
  788. Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Frames.PipeLZ4FrameReader"/>.
  789. </summary>
  790. <param name="pipe">Pipe to be read.</param>
  791. <param name="leaveOpen">Leave pipe open after reader is disposed.</param>
  792. <param name="decoderFactory">LZ4 decoder factory.</param>
  793. </member>
  794. <member name="M:K4os.Compression.LZ4.Streams.Frames.PipeLZ4FrameReader.ReleaseResources">
  795. <inheritdoc />
  796. </member>
  797. <member name="M:K4os.Compression.LZ4.Streams.Frames.PipeLZ4FrameReader.ReleaseResourcesAsync">
  798. <inheritdoc />
  799. </member>
  800. <member name="T:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReaderAsStream">
  801. <summary>
  802. <see cref="T:System.IO.Stream"/> wrapper for <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader"/>.
  803. </summary>
  804. </member>
  805. <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReaderAsStream.#ctor(K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader,System.Boolean,System.Boolean)">
  806. <summary>
  807. Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReaderAsStream"/>.
  808. </summary>
  809. <param name="reader">LZ4 frame reader.</param>
  810. <param name="leaveOpen">Leave underlying stream open after disposing this stream.</param>
  811. <param name="interactive">Use interactive mode; return bytes as soon as they available.</param>
  812. </member>
  813. <member name="P:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReaderAsStream.CanRead">
  814. <inheritdoc />
  815. </member>
  816. <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReaderAsStream.ReadByte">
  817. <inheritdoc />
  818. </member>
  819. <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReaderAsStream.Read(System.Byte[],System.Int32,System.Int32)">
  820. <inheritdoc />
  821. </member>
  822. <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReaderAsStream.ReadAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
  823. <inheritdoc />
  824. </member>
  825. <member name="P:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReaderAsStream.Length">
  826. <summary>
  827. Length of stream. Please note, this will only work if original LZ4 stream has
  828. <c>ContentLength</c> field set in descriptor. Otherwise returned value will be <c>-1</c>.
  829. It will also require synchronous stream access, so it wont work if AllowSynchronousIO
  830. is <c>false</c>.
  831. </summary>
  832. </member>
  833. <member name="P:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReaderAsStream.Position">
  834. <summary>
  835. Position within the stream. Position can be read, but cannot be set as LZ4 stream does
  836. not have <c>Seek</c> capability.
  837. </summary>
  838. </member>
  839. <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReaderAsStream.Dispose(System.Boolean)">
  840. <inheritdoc />
  841. </member>
  842. <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReaderAsStream.Read(System.Span{System.Byte})">
  843. <inheritdoc />
  844. </member>
  845. <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReaderAsStream.ReadAsync(System.Memory{System.Byte},System.Threading.CancellationToken)">
  846. <inheritdoc />
  847. </member>
  848. <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameReaderAsStream.DisposeAsync">
  849. <inheritdoc />
  850. </member>
  851. <member name="T:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2">
  852. <summary>
  853. LZ4 stream encoder.
  854. </summary>
  855. </member>
  856. <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)">
  857. <summary>Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.LZ4EncoderStream"/>.</summary>
  858. <param name="writer">Inner stream.</param>
  859. <param name="stream">Inner stream initial state.</param>
  860. <param name="encoderFactory">LZ4 Encoder factory.</param>
  861. <param name="descriptor">LZ4 settings.</param>
  862. </member>
  863. <member name="P:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.StreamState">
  864. <summary>
  865. Exposes internal stream state. Existence of this field is a hack,
  866. and it really shouldn't be here but it is needed for relatively low
  867. level operations (like writing directly to unmanaged memory).
  868. Please, do not use it directly, if don't know what you are doing.
  869. </summary>
  870. </member>
  871. <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.AllocateBuffer(System.Int32)">
  872. <summary>Allocate temporary buffer to store decompressed data.</summary>
  873. <param name="size">Minimum size of the buffer.</param>
  874. <returns>Allocated buffer.</returns>
  875. </member>
  876. <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.ReleaseBuffer(System.Byte[])">
  877. <summary>Releases allocated buffer. <see cref="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.AllocateBuffer(System.Int32)"/></summary>
  878. <param name="buffer">Previously allocated buffer.</param>
  879. </member>
  880. <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.GetBytesWritten">
  881. <inheritdoc />
  882. </member>
  883. <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.WriteOneByte(System.Byte)">
  884. <inheritdoc />
  885. </member>
  886. <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.WriteOneByteAsync(System.Threading.CancellationToken,System.Byte)">
  887. <inheritdoc />
  888. </member>
  889. <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.WriteManyBytes(System.ReadOnlySpan{System.Byte})">
  890. <inheritdoc />
  891. </member>
  892. <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.WriteManyBytesAsync(System.Threading.CancellationToken,System.ReadOnlyMemory{System.Byte})">
  893. <inheritdoc />
  894. </member>
  895. <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.OpenFrame">
  896. <inheritdoc />
  897. </member>
  898. <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.OpenFrameAsync(System.Threading.CancellationToken)">
  899. <inheritdoc />
  900. </member>
  901. <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.CloseFrame">
  902. <inheritdoc />
  903. </member>
  904. <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.CloseFrameAsync(System.Threading.CancellationToken)">
  905. <inheritdoc />
  906. </member>
  907. <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.Dispose(System.Boolean)">
  908. <summary>
  909. Disposes the stream and releases all resources.
  910. </summary>
  911. <param name="disposing"><c>true</c> if called by user; <c>false</c> when called by garbag collector.</param>
  912. </member>
  913. <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.Dispose">
  914. <inheritdoc />
  915. </member>
  916. <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.ReleaseResources">
  917. <summary>
  918. Releases all unmanaged resources.
  919. </summary>
  920. </member>
  921. <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.ReleaseResourcesAsync">
  922. <summary>
  923. Releases all unmanaged resources.
  924. </summary>
  925. <returns>Task indicating completion of the operation.</returns>
  926. </member>
  927. <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriter`2.DisposeAsync">
  928. <inheritdoc />
  929. </member>
  930. <member name="T:K4os.Compression.LZ4.Streams.Frames.ByteBufferLZ4FrameWriter`1">
  931. <summary>
  932. <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter"/> implementation for <see cref="T:System.Buffers.IBufferWriter`1"/>
  933. </summary>
  934. <typeparam name="TBufferWriter">Type of buffer writer.</typeparam>
  935. </member>
  936. <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)">
  937. <summary>
  938. Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Frames.ByteBufferLZ4FrameWriter`1"/>.
  939. </summary>
  940. <param name="stream">Buffer writer to write to.</param>
  941. <param name="encoderFactory">Encoder factory.</param>
  942. <param name="descriptor">Frame descriptor.</param>
  943. </member>
  944. <member name="P:K4os.Compression.LZ4.Streams.Frames.ByteBufferLZ4FrameWriter`1.BufferWriter">
  945. <summary>Current state of buffer writer.</summary>
  946. </member>
  947. <member name="T:K4os.Compression.LZ4.Streams.Frames.ByteBufferLZ4FrameWriter">
  948. <summary>
  949. <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter"/> implementation for <see cref="T:System.Buffers.IBufferWriter`1"/>
  950. </summary>
  951. </member>
  952. <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)">
  953. <summary>
  954. Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Frames.ByteBufferLZ4FrameWriter"/>.
  955. </summary>
  956. <param name="stream">Buffer writer to write to.</param>
  957. <param name="encoderFactory">Encoder factory.</param>
  958. <param name="descriptor">Frame descriptor.</param>
  959. </member>
  960. <member name="T:K4os.Compression.LZ4.Streams.Frames.ByteMemoryLZ4FrameWriter">
  961. <summary>
  962. <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter"/> implementation for <see cref="T:System.Memory`1"/>
  963. </summary>
  964. </member>
  965. <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)">
  966. <summary>
  967. Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Frames.ByteMemoryLZ4FrameWriter"/>.
  968. </summary>
  969. <param name="memory">Memory block where data will be written.</param>
  970. <param name="encoderFactory">Encoder factory.</param>
  971. <param name="descriptor">Frame descriptor.</param>
  972. </member>
  973. <member name="P:K4os.Compression.LZ4.Streams.Frames.ByteMemoryLZ4FrameWriter.CompressedLength">
  974. <summary>Number of bytes written to the memory.</summary>
  975. </member>
  976. <member name="T:K4os.Compression.LZ4.Streams.Frames.ByteSpanLZ4FrameWriter">
  977. <summary>
  978. <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter"/> implementation for <see cref="T:K4os.Compression.LZ4.Streams.Adapters.UnsafeByteSpan"/>.
  979. <see cref="T:K4os.Compression.LZ4.Streams.Adapters.UnsafeByteSpan"/> is a wrapper around <see cref="T:System.Span`1"/> that
  980. can be stored in a field. Please note: it makes it unsafe and address needs to be pinned,
  981. one way or another.
  982. </summary>
  983. </member>
  984. <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)">
  985. <summary>
  986. Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Frames.ByteSpanLZ4FrameWriter"/>.
  987. </summary>
  988. <param name="span">Span to write to.</param>
  989. <param name="encoderFactory">Encoder factory.</param>
  990. <param name="descriptor">Frame descriptor.</param>
  991. </member>
  992. <member name="P:K4os.Compression.LZ4.Streams.Frames.ByteSpanLZ4FrameWriter.CompressedLength">
  993. <summary>Number of bytes written to the memory.</summary>
  994. </member>
  995. <member name="T:K4os.Compression.LZ4.Streams.Frames.StreamLZ4FrameWriter">
  996. <summary>
  997. <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter"/> implementation for <see cref="T:System.IO.Stream"/>.
  998. </summary>
  999. </member>
  1000. <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)">
  1001. <summary>
  1002. Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Frames.StreamLZ4FrameWriter"/>.
  1003. </summary>
  1004. <param name="stream">Stream to write to.</param>
  1005. <param name="leaveOpen">Leave stream open after disposing this writer.</param>
  1006. <param name="encoderFactory">Encoder factory.</param>
  1007. <param name="descriptor">Frame descriptor.</param>
  1008. </member>
  1009. <member name="M:K4os.Compression.LZ4.Streams.Frames.StreamLZ4FrameWriter.ReleaseResources">
  1010. <inheritdoc />
  1011. </member>
  1012. <member name="M:K4os.Compression.LZ4.Streams.Frames.StreamLZ4FrameWriter.ReleaseResourcesAsync">
  1013. <inheritdoc />
  1014. </member>
  1015. <member name="T:K4os.Compression.LZ4.Streams.Frames.PipeLZ4FrameWriter">
  1016. <summary>
  1017. <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter"/> implementation for <see cref="T:System.IO.Pipelines.PipeWriter"/>.
  1018. </summary>
  1019. </member>
  1020. <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)">
  1021. <summary>
  1022. Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Frames.PipeLZ4FrameWriter"/>.
  1023. </summary>
  1024. <param name="pipe">Pipe writer to write to.</param>
  1025. <param name="leaveOpen">Leave pipe open after disposing this writer.</param>
  1026. <param name="encoderFactory">Encoder factory.</param>
  1027. <param name="descriptor">Frame descriptor.</param>
  1028. </member>
  1029. <member name="M:K4os.Compression.LZ4.Streams.Frames.PipeLZ4FrameWriter.ReleaseResources">
  1030. <inheritdoc />
  1031. </member>
  1032. <member name="M:K4os.Compression.LZ4.Streams.Frames.PipeLZ4FrameWriter.ReleaseResourcesAsync">
  1033. <inheritdoc />
  1034. </member>
  1035. <member name="T:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriterAsStream">
  1036. <summary>
  1037. Adapter to make <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter"/> look like <see cref="T:System.IO.Stream"/>.
  1038. </summary>
  1039. </member>
  1040. <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriterAsStream.#ctor(K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter,System.Boolean)">
  1041. <summary>Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.LZ4EncoderStream"/>.</summary>
  1042. <param name="writer">Underlying frame encoder.</param>
  1043. <param name="leaveOpen">Indicates <paramref name="writer"/> should be left
  1044. open after disposing.</param>
  1045. </member>
  1046. <member name="P:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriterAsStream.CanWrite">
  1047. <inheritdoc />
  1048. </member>
  1049. <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriterAsStream.WriteByte(System.Byte)">
  1050. <inheritdoc />
  1051. </member>
  1052. <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriterAsStream.Write(System.Byte[],System.Int32,System.Int32)">
  1053. <inheritdoc />
  1054. </member>
  1055. <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriterAsStream.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
  1056. <inheritdoc />
  1057. </member>
  1058. <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriterAsStream.Write(System.ReadOnlySpan{System.Byte})">
  1059. <inheritdoc />
  1060. </member>
  1061. <member name="M:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriterAsStream.WriteAsync(System.ReadOnlyMemory{System.Byte},System.Threading.CancellationToken)">
  1062. <inheritdoc />
  1063. </member>
  1064. <member name="P:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriterAsStream.Length">
  1065. <summary>Length of the stream and number of bytes written so far.</summary>
  1066. </member>
  1067. <member name="P:K4os.Compression.LZ4.Streams.Frames.LZ4FrameWriterAsStream.Position">
  1068. <summary>Read-only position in the stream. Trying to set it will throw
  1069. <see cref="T:System.InvalidOperationException"/>.</summary>
  1070. </member>
  1071. <member name="T:K4os.Compression.LZ4.Streams.ILZ4Descriptor">
  1072. <summary>
  1073. LZ4 Frame descriptor.
  1074. </summary>
  1075. </member>
  1076. <member name="P:K4os.Compression.LZ4.Streams.ILZ4Descriptor.ContentLength">
  1077. <summary>Content length. Not always known.</summary>
  1078. </member>
  1079. <member name="P:K4os.Compression.LZ4.Streams.ILZ4Descriptor.ContentChecksum">
  1080. <summary>Indicates if content checksum is provided.</summary>
  1081. </member>
  1082. <member name="P:K4os.Compression.LZ4.Streams.ILZ4Descriptor.Chaining">
  1083. <summary>Indicates if blocks are chained (dependent) or not (independent).</summary>
  1084. </member>
  1085. <member name="P:K4os.Compression.LZ4.Streams.ILZ4Descriptor.BlockChecksum">
  1086. <summary>Indicates if block checksums are provided.</summary>
  1087. </member>
  1088. <member name="P:K4os.Compression.LZ4.Streams.ILZ4Descriptor.Dictionary">
  1089. <summary>Dictionary id. May be null.</summary>
  1090. </member>
  1091. <member name="P:K4os.Compression.LZ4.Streams.ILZ4Descriptor.BlockSize">
  1092. <summary>Block size.</summary>
  1093. </member>
  1094. <member name="T:K4os.Compression.LZ4.Streams.Internal.EmptyToken">
  1095. <summary>
  1096. Completely empty class to do nothing.
  1097. It is used internally instead of CancellationToken to make sure
  1098. blocking operations are easily distinguishable from async ones
  1099. (you cannot call blocking operation by accident as they *require* EmptyToken).
  1100. </summary>
  1101. </member>
  1102. <member name="T:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1">
  1103. <summary>
  1104. Base class for all <see cref="T:System.IO.Stream"/> compatible adapters.
  1105. </summary>
  1106. <typeparam name="T">Type of resource stream adapter if for.</typeparam>
  1107. </member>
  1108. <member name="M:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.#ctor(`0,System.Boolean)">
  1109. <summary>
  1110. Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1"/>.
  1111. </summary>
  1112. <param name="innerResource">Wrapped resource.</param>
  1113. <param name="leaveOpen">Do not dispose inner resource after stream is disposed.</param>
  1114. </member>
  1115. <member name="P:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.InnerResource">
  1116. <summary>Wrapped resource.</summary>
  1117. </member>
  1118. <member name="P:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.CanRead">
  1119. <inheritdoc />
  1120. </member>
  1121. <member name="P:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.CanWrite">
  1122. <inheritdoc />
  1123. </member>
  1124. <member name="P:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.CanTimeout">
  1125. <inheritdoc />
  1126. </member>
  1127. <member name="P:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.ReadTimeout">
  1128. <inheritdoc />
  1129. </member>
  1130. <member name="P:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.WriteTimeout">
  1131. <inheritdoc />
  1132. </member>
  1133. <member name="P:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.CanSeek">
  1134. <inheritdoc />
  1135. </member>
  1136. <member name="P:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.Position">
  1137. <inheritdoc />
  1138. </member>
  1139. <member name="P:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.Length">
  1140. <inheritdoc />
  1141. </member>
  1142. <member name="M:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.Flush">
  1143. <inheritdoc />
  1144. </member>
  1145. <member name="M:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.FlushAsync(System.Threading.CancellationToken)">
  1146. <inheritdoc />
  1147. </member>
  1148. <member name="M:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.Seek(System.Int64,System.IO.SeekOrigin)">
  1149. <inheritdoc />
  1150. </member>
  1151. <member name="M:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.SetLength(System.Int64)">
  1152. <inheritdoc />
  1153. </member>
  1154. <member name="M:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.ReadByte">
  1155. <inheritdoc />
  1156. </member>
  1157. <member name="M:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.Read(System.Byte[],System.Int32,System.Int32)">
  1158. <inheritdoc />
  1159. </member>
  1160. <member name="M:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.ReadAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
  1161. <inheritdoc />
  1162. </member>
  1163. <member name="M:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.Dispose(System.Boolean)">
  1164. <inheritdoc />
  1165. </member>
  1166. <member name="M:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.WriteByte(System.Byte)">
  1167. <inheritdoc />
  1168. </member>
  1169. <member name="M:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.Write(System.Byte[],System.Int32,System.Int32)">
  1170. <inheritdoc />
  1171. </member>
  1172. <member name="M:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
  1173. <inheritdoc />
  1174. </member>
  1175. <member name="M:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.Read(System.Span{System.Byte})">
  1176. <inheritdoc />
  1177. </member>
  1178. <member name="M:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.ReadAsync(System.Memory{System.Byte},System.Threading.CancellationToken)">
  1179. <inheritdoc />
  1180. </member>
  1181. <member name="M:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.Write(System.ReadOnlySpan{System.Byte})">
  1182. <inheritdoc />
  1183. </member>
  1184. <member name="M:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.WriteAsync(System.ReadOnlyMemory{System.Byte},System.Threading.CancellationToken)">
  1185. <inheritdoc />
  1186. </member>
  1187. <member name="M:K4os.Compression.LZ4.Streams.Internal.LZ4StreamEssentials`1.DisposeAsync">
  1188. <inheritdoc />
  1189. </member>
  1190. <member name="T:K4os.Compression.LZ4.Streams.Internal.LZ4StreamOnStreamEssentials">
  1191. <summary>
  1192. LZ4 stream essentials when wrapping another stream.
  1193. You most likely should not use it but it needs to be public as it is inherited from.
  1194. </summary>
  1195. </member>
  1196. <member name="P:K4os.Compression.LZ4.Streams.Internal.LZ4StreamOnStreamEssentials.CanRead">
  1197. <inheritdoc />
  1198. </member>
  1199. <member name="P:K4os.Compression.LZ4.Streams.Internal.LZ4StreamOnStreamEssentials.CanWrite">
  1200. <inheritdoc />
  1201. </member>
  1202. <member name="P:K4os.Compression.LZ4.Streams.Internal.LZ4StreamOnStreamEssentials.CanTimeout">
  1203. <inheritdoc />
  1204. </member>
  1205. <member name="P:K4os.Compression.LZ4.Streams.Internal.LZ4StreamOnStreamEssentials.ReadTimeout">
  1206. <inheritdoc />
  1207. </member>
  1208. <member name="P:K4os.Compression.LZ4.Streams.Internal.LZ4StreamOnStreamEssentials.WriteTimeout">
  1209. <inheritdoc />
  1210. </member>
  1211. <member name="M:K4os.Compression.LZ4.Streams.Internal.LZ4StreamOnStreamEssentials.Flush">
  1212. <inheritdoc />
  1213. </member>
  1214. <member name="M:K4os.Compression.LZ4.Streams.Internal.LZ4StreamOnStreamEssentials.FlushAsync(System.Threading.CancellationToken)">
  1215. <inheritdoc />
  1216. </member>
  1217. <member name="T:K4os.Compression.LZ4.Streams.LZ4DecoderSettings">
  1218. <summary>
  1219. Decoder settings.
  1220. </summary>
  1221. </member>
  1222. <member name="P:K4os.Compression.LZ4.Streams.LZ4DecoderSettings.ExtraMemory">
  1223. <summary>Extra memory for decompression.</summary>
  1224. </member>
  1225. <member name="T:K4os.Compression.LZ4.Streams.LZ4DecoderStream">
  1226. <summary>
  1227. LZ4 frame decoder stream.
  1228. </summary>
  1229. </member>
  1230. <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)">
  1231. <summary>
  1232. Creates LZ4 decoder stream.
  1233. </summary>
  1234. <param name="inner">Inner stream, the stream compressed data is coming from..</param>
  1235. <param name="decoderFactory">Decoder factory.</param>
  1236. <param name="leaveOpen">Leave inner stream open after this stream is disposed.</param>
  1237. <param name="interactive">Interactive mode, provide bytes as soon as they are available; don't wait for full block.</param>
  1238. </member>
  1239. <member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.ReadByte">
  1240. <inheritdoc />
  1241. </member>
  1242. <member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.Read(System.Byte[],System.Int32,System.Int32)">
  1243. <inheritdoc />
  1244. </member>
  1245. <member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.ReadAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
  1246. <inheritdoc />
  1247. </member>
  1248. <member name="P:K4os.Compression.LZ4.Streams.LZ4DecoderStream.CanWrite">
  1249. <inheritdoc />
  1250. </member>
  1251. <member name="P:K4os.Compression.LZ4.Streams.LZ4DecoderStream.Length">
  1252. <summary>
  1253. Length of stream. Please note, this will only work if original LZ4 stream has
  1254. <c>ContentLength</c> field set in descriptor. Otherwise returned value will be <c>-1</c>.
  1255. It will also require synchronous stream access, so it wont work if AllowSynchronousIO
  1256. is <c>false</c>.
  1257. </summary>
  1258. </member>
  1259. <member name="P:K4os.Compression.LZ4.Streams.LZ4DecoderStream.Position">
  1260. <summary>
  1261. Position within the stream. Position can be read, but cannot be set as LZ4 stream does
  1262. not have <c>Seek</c> capability.
  1263. </summary>
  1264. </member>
  1265. <member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.Dispose(System.Boolean)">
  1266. <inheritdoc />
  1267. </member>
  1268. <member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.Read(System.Span{System.Byte})">
  1269. <inheritdoc />
  1270. </member>
  1271. <member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.ReadAsync(System.Memory{System.Byte},System.Threading.CancellationToken)">
  1272. <inheritdoc />
  1273. </member>
  1274. <member name="M:K4os.Compression.LZ4.Streams.LZ4DecoderStream.DisposeAsync">
  1275. <inheritdoc />
  1276. </member>
  1277. <member name="T:K4os.Compression.LZ4.Streams.LZ4Descriptor">
  1278. <summary>
  1279. LZ4 frame descriptor.
  1280. </summary>
  1281. </member>
  1282. <member name="P:K4os.Compression.LZ4.Streams.LZ4Descriptor.ContentLength">
  1283. <summary>Content length (if available).</summary>
  1284. </member>
  1285. <member name="P:K4os.Compression.LZ4.Streams.LZ4Descriptor.ContentChecksum">
  1286. <summary>Indicates if content checksum if present.</summary>
  1287. </member>
  1288. <member name="P:K4os.Compression.LZ4.Streams.LZ4Descriptor.Chaining">
  1289. <summary>Indicates if blocks are chained.</summary>
  1290. </member>
  1291. <member name="P:K4os.Compression.LZ4.Streams.LZ4Descriptor.BlockChecksum">
  1292. <summary>Indicates if block checksums are present.</summary>
  1293. </member>
  1294. <member name="P:K4os.Compression.LZ4.Streams.LZ4Descriptor.Dictionary">
  1295. <summary>Dictionary id (or null).</summary>
  1296. </member>
  1297. <member name="P:K4os.Compression.LZ4.Streams.LZ4Descriptor.BlockSize">
  1298. <summary>Block size.</summary>
  1299. </member>
  1300. <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)">
  1301. <summary>Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.LZ4Descriptor"/>.</summary>
  1302. <param name="contentLength">Content length.</param>
  1303. <param name="contentChecksum">Content checksum flag.</param>
  1304. <param name="chaining">Chaining flag.</param>
  1305. <param name="blockChecksum">Block checksum flag.</param>
  1306. <param name="dictionary">Dictionary id.</param>
  1307. <param name="blockSize">Block size.</param>
  1308. </member>
  1309. <member name="M:K4os.Compression.LZ4.Streams.LZ4Descriptor.#ctor(K4os.Compression.LZ4.Streams.ILZ4Descriptor)">
  1310. <summary>Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.LZ4Descriptor"/>.</summary>
  1311. <param name="descriptor">Descriptor to copy.</param>
  1312. </member>
  1313. <member name="T:K4os.Compression.LZ4.Streams.LZ4EncoderSettings">
  1314. <summary>
  1315. LZ4 encoder settings.
  1316. </summary>
  1317. </member>
  1318. <member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderSettings.ContentLength">
  1319. <summary>
  1320. Content length. It is not enforced, it can be set to any value, but it will be
  1321. written to the stream so it can be used while decoding. If you don't know the length
  1322. just leave default value.
  1323. </summary>
  1324. </member>
  1325. <member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderSettings.ChainBlocks">
  1326. <summary>
  1327. Indicates if blocks should be chained (dependent) or not (independent). Dependent blocks
  1328. (with chaining) provide better compression ratio but are a little but slower and take
  1329. more memory.
  1330. </summary>
  1331. </member>
  1332. <member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderSettings.BlockSize">
  1333. <summary>
  1334. Block size. You can use any block size, but default values for LZ4 are 64k, 256k, 1m,
  1335. and 4m. 64k is good enough for dependent blocks, but for independent blocks bigger is
  1336. better.
  1337. </summary>
  1338. </member>
  1339. <member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderSettings.ContentChecksum">
  1340. <summary>Indicates is content checksum should be included.</summary>
  1341. </member>
  1342. <member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderSettings.BlockChecksum">
  1343. <summary>Indicates if block checksum should be included.</summary>
  1344. </member>
  1345. <member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderSettings.Dictionary">
  1346. <summary>Dictionary id. Not implemented yet.</summary>
  1347. </member>
  1348. <member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderSettings.CompressionLevel">
  1349. <summary>Compression level.</summary>
  1350. </member>
  1351. <member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderSettings.ExtraMemory">
  1352. <summary>Extra memory (for the process, more is usually better).</summary>
  1353. </member>
  1354. <member name="T:K4os.Compression.LZ4.Streams.LZ4EncoderStream">
  1355. <summary>
  1356. LZ4 frame encoder stream.
  1357. </summary>
  1358. </member>
  1359. <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)">
  1360. <summary>Creates new instance of <see cref="T:K4os.Compression.LZ4.Streams.LZ4EncoderStream"/>.</summary>
  1361. <param name="inner">Inner stream.</param>
  1362. <param name="descriptor">LZ4 Descriptor.</param>
  1363. <param name="encoderFactory">Function which will take descriptor and return
  1364. appropriate encoder.</param>
  1365. <param name="leaveOpen">Indicates if <paramref name="inner"/> stream should be left
  1366. open after disposing.</param>
  1367. </member>
  1368. <member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Dispose(System.Boolean)">
  1369. <inheritdoc />
  1370. </member>
  1371. <member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.WriteByte(System.Byte)">
  1372. <inheritdoc />
  1373. </member>
  1374. <member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Write(System.Byte[],System.Int32,System.Int32)">
  1375. <inheritdoc />
  1376. </member>
  1377. <member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
  1378. <inheritdoc />
  1379. </member>
  1380. <member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.DisposeAsync">
  1381. <inheritdoc />
  1382. </member>
  1383. <member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Write(System.ReadOnlySpan{System.Byte})">
  1384. <inheritdoc />
  1385. </member>
  1386. <member name="M:K4os.Compression.LZ4.Streams.LZ4EncoderStream.WriteAsync(System.ReadOnlyMemory{System.Byte},System.Threading.CancellationToken)">
  1387. <inheritdoc />
  1388. </member>
  1389. <member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderStream.CanRead">
  1390. <inheritdoc />
  1391. </member>
  1392. <member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Length">
  1393. <summary>Length of the stream and number of bytes written so far.</summary>
  1394. </member>
  1395. <member name="P:K4os.Compression.LZ4.Streams.LZ4EncoderStream.Position">
  1396. <summary>Read-only position in the stream. Trying to set it will throw
  1397. <see cref="T:System.InvalidOperationException"/>.</summary>
  1398. </member>
  1399. <member name="T:K4os.Compression.LZ4.Streams.LZ4Frame">
  1400. <summary>
  1401. LZ4 factory methods to encode/decode anything which can be represented as a stream-like object.
  1402. Please note, to avoid all the complexity of dealing with streams, it uses
  1403. <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameReader"/> and <see cref="T:K4os.Compression.LZ4.Streams.Abstractions.ILZ4FrameWriter"/> as stream abstractions.
  1404. </summary>
  1405. </member>
  1406. <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Decode``1(System.ReadOnlySpan{System.Byte},``0,System.Int32)">
  1407. <summary>Creates decompression stream on top of inner stream.</summary>
  1408. <param name="source">Span to read from.</param>
  1409. <param name="target">Buffer to write to.</param>
  1410. <param name="extraMemory">Extra memory used for decompression.</param>
  1411. </member>
  1412. <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Decode(System.ReadOnlyMemory{System.Byte},System.Int32)">
  1413. <summary>Creates decompression stream on top of inner stream.</summary>
  1414. <param name="memory">Stream to be decoded.</param>
  1415. <param name="extraMemory">Extra memory used for decompression.</param>
  1416. <returns>Decompression stream.</returns>
  1417. </member>
  1418. <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Decode(System.Buffers.ReadOnlySequence{System.Byte},System.Int32)">
  1419. <summary>Creates decompression stream on top of inner stream.</summary>
  1420. <param name="sequence">Stream to be decoded.</param>
  1421. <param name="extraMemory">Extra memory used for decompression.</param>
  1422. <returns>Decompression stream.</returns>
  1423. </member>
  1424. <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Decode(System.IO.Stream,System.Int32,System.Boolean)">
  1425. <summary>Creates decompression stream on top of inner stream.</summary>
  1426. <param name="stream">Stream to be decoded.</param>
  1427. <param name="extraMemory">Extra memory used for decompression.</param>
  1428. <param name="leaveOpen">Indicates if stream should stay open after disposing decoder.</param>
  1429. <returns>Decompression stream.</returns>
  1430. </member>
  1431. <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Decode(System.IO.Pipelines.PipeReader,System.Int32,System.Boolean)">
  1432. <summary>Creates decompression stream on top of inner stream.</summary>
  1433. <param name="reader">Stream to be decoded.</param>
  1434. <param name="extraMemory">Extra memory used for decompression.</param>
  1435. <param name="leaveOpen">Indicates if stream should stay open after disposing decoder.</param>
  1436. <returns>Decompression stream.</returns>
  1437. </member>
  1438. <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Encode``1(System.Buffers.ReadOnlySequence{System.Byte},``0,K4os.Compression.LZ4.Streams.LZ4EncoderSettings)">
  1439. <summary>
  1440. Compresses source bytes into target buffer. Returns number of bytes actually written.
  1441. </summary>
  1442. <param name="source">Source bytes.</param>
  1443. <param name="target">Target buffer.</param>
  1444. <param name="settings">Compression settings.</param>
  1445. <returns>Number of bytes actually written.</returns>
  1446. </member>
  1447. <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Encode``1(System.ReadOnlySpan{System.Byte},``0,K4os.Compression.LZ4.Streams.LZ4EncoderSettings)">
  1448. <summary>
  1449. Compresses source bytes into target buffer. Returns number of bytes actually written.
  1450. </summary>
  1451. <param name="source">Source bytes.</param>
  1452. <param name="target">Target buffer.</param>
  1453. <param name="settings">Compression settings.</param>
  1454. <returns>Number of bytes actually written.</returns>
  1455. </member>
  1456. <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Encode``1(System.Buffers.ReadOnlySequence{System.Byte},``0,K4os.Compression.LZ4.LZ4Level,System.Int32)">
  1457. <summary>
  1458. Compresses source bytes into target buffer. Returns number of bytes actually written.
  1459. </summary>
  1460. <param name="source">Source bytes.</param>
  1461. <param name="target">Target buffer.</param>
  1462. <param name="level">Compression level.</param>
  1463. <param name="extraMemory">Extra memory.</param>
  1464. <returns>Number of bytes actually written.</returns>
  1465. </member>
  1466. <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Encode``1(System.ReadOnlySpan{System.Byte},``0,K4os.Compression.LZ4.LZ4Level,System.Int32)">
  1467. <summary>
  1468. Compresses source bytes into target buffer. Returns number of bytes actually written.
  1469. </summary>
  1470. <param name="source">Source bytes.</param>
  1471. <param name="target">Target buffer.</param>
  1472. <param name="level">Compression level.</param>
  1473. <param name="extraMemory">Extra memory.</param>
  1474. <returns>Number of bytes actually written.</returns>
  1475. </member>
  1476. <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Encode(System.Buffers.ReadOnlySequence{System.Byte},System.Span{System.Byte},K4os.Compression.LZ4.Streams.LZ4EncoderSettings)">
  1477. <summary>
  1478. Compresses source bytes into target buffer. Returns number of bytes actually written.
  1479. </summary>
  1480. <param name="source">Source bytes.</param>
  1481. <param name="target">Target buffer.</param>
  1482. <param name="settings">Compression settings.</param>
  1483. <returns>Number of bytes actually written.</returns>
  1484. </member>
  1485. <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Encode(System.Span{System.Byte},System.Span{System.Byte},K4os.Compression.LZ4.Streams.LZ4EncoderSettings)">
  1486. <summary>
  1487. Compresses source bytes into target buffer. Returns number of bytes actually written.
  1488. </summary>
  1489. <param name="source">Source bytes.</param>
  1490. <param name="target">Target buffer.</param>
  1491. <param name="settings">Compression settings.</param>
  1492. <returns>Number of bytes actually written.</returns>
  1493. </member>
  1494. <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)">
  1495. <summary>
  1496. Writes bytes into target buffer. Returns number of bytes actually written.
  1497. </summary>
  1498. <param name="source">Source of bytes, a function which write to LZ4 encoder.</param>
  1499. <param name="target">Target buffer.</param>
  1500. <param name="settings">Compression settings.</param>
  1501. <returns>Number of bytes actually written.</returns>
  1502. </member>
  1503. <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Encode(System.Buffers.ReadOnlySequence{System.Byte},System.Span{System.Byte},K4os.Compression.LZ4.LZ4Level,System.Int32)">
  1504. <summary>
  1505. Compresses source bytes into target buffer. Returns number of bytes actually written.
  1506. </summary>
  1507. <param name="source">Source bytes.</param>
  1508. <param name="target">Target buffer.</param>
  1509. <param name="level">Compression level.</param>
  1510. <param name="extraMemory">Extra memory for encoder.</param>
  1511. <returns>Number of bytes actually written.</returns>
  1512. </member>
  1513. <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Encode(System.Span{System.Byte},System.Span{System.Byte},K4os.Compression.LZ4.LZ4Level,System.Int32)">
  1514. <summary>
  1515. Compresses source bytes into target buffer. Returns number of bytes actually written.
  1516. </summary>
  1517. <param name="source">Source bytes.</param>
  1518. <param name="target">Target buffer.</param>
  1519. <param name="level">Compression level.</param>
  1520. <param name="extraMemory">Extra memory for encoder.</param>
  1521. <returns>Number of bytes actually written.</returns>
  1522. </member>
  1523. <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)">
  1524. <summary>
  1525. Compresses source bytes into target buffer. Returns number of bytes actually written.
  1526. </summary>
  1527. <param name="source">Source of bytes, a function which write to LZ4 encoder.</param>
  1528. <param name="target">Target buffer.</param>
  1529. <param name="level">Compression level.</param>
  1530. <param name="extraMemory">Extra memory for encoder.</param>
  1531. <returns>Number of bytes actually written.</returns>
  1532. </member>
  1533. <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Encode(System.Byte*,System.Int32,K4os.Compression.LZ4.Streams.LZ4EncoderSettings)">
  1534. <summary>
  1535. Create LZ4 encoder that writes compressed data into target buffer.
  1536. Please note, target buffer needs to be pinned for the whole time encoder is used.
  1537. This is definitely very unsafe method, and if you don't understand what it does,
  1538. don't use it.
  1539. </summary>
  1540. <param name="target">Pointer to target buffer.</param>
  1541. <param name="length">Length of target buffer.</param>
  1542. <param name="settings">Encoder settings.</param>
  1543. <returns>LZ4 frame writer.</returns>
  1544. </member>
  1545. <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Encode(System.Byte*,System.Int32,K4os.Compression.LZ4.LZ4Level,System.Int32)">
  1546. <summary>
  1547. Create LZ4 encoder that writes compressed data into target buffer.
  1548. Please note, target buffer needs to be pinned for the whole time encoder is used.
  1549. This is definitely very unsafe method, and if you don't understand what it does,
  1550. don't use it.
  1551. </summary>
  1552. <param name="target">Pointer to target buffer.</param>
  1553. <param name="length">Length of target buffer.</param>
  1554. <param name="level">Compression level.</param>
  1555. <param name="extraMemory">Extra memory for encoder.</param>
  1556. <returns>LZ4 frame writer.</returns>
  1557. </member>
  1558. <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Encode(System.Memory{System.Byte},K4os.Compression.LZ4.Streams.LZ4EncoderSettings)">
  1559. <summary>
  1560. Create LZ4 encoder that writes compressed data into target buffer.
  1561. </summary>
  1562. <param name="target">Target buffer.</param>
  1563. <param name="settings">Encoder settings.</param>
  1564. <returns>LZ4 frame writer.</returns>
  1565. </member>
  1566. <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Encode(System.Memory{System.Byte},K4os.Compression.LZ4.LZ4Level,System.Int32)">
  1567. <summary>
  1568. Create LZ4 encoder that writes compressed data into target buffer.
  1569. </summary>
  1570. <param name="target">Target buffer.</param>
  1571. <param name="level">Compression level.</param>
  1572. <param name="extraMemory">Extra memory for encoder.</param>
  1573. <returns>LZ4 frame writer.</returns>
  1574. </member>
  1575. <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Encode``1(``0,K4os.Compression.LZ4.Streams.LZ4EncoderSettings)">
  1576. <summary>
  1577. Create LZ4 encoder that writes compressed data into target buffer.
  1578. </summary>
  1579. <param name="target">Target buffer.</param>
  1580. <param name="settings">Encoder settings.</param>
  1581. <typeparam name="TBufferWriter">Byte of buffer writer implementing <see cref="T:System.Buffers.IBufferWriter`1"/>.</typeparam>
  1582. <returns>LZ4 frame writer.</returns>
  1583. </member>
  1584. <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Encode``1(``0,K4os.Compression.LZ4.LZ4Level,System.Int32)">
  1585. <summary>
  1586. Create LZ4 encoder that writes compressed data into target buffer.
  1587. </summary>
  1588. <param name="target">Target buffer.</param>
  1589. <param name="level">Compression level.</param>
  1590. <param name="extraMemory">Extra memory for encoder.</param>
  1591. <typeparam name="TBufferWriter">Byte of buffer writer implementing <see cref="T:System.Buffers.IBufferWriter`1"/>.</typeparam>
  1592. <returns>LZ4 frame writer.</returns>
  1593. </member>
  1594. <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Encode(System.Buffers.IBufferWriter{System.Byte},K4os.Compression.LZ4.Streams.LZ4EncoderSettings)">
  1595. <summary>
  1596. Create LZ4 encoder that writes compressed data into target buffer.
  1597. </summary>
  1598. <param name="target">Target buffer.</param>
  1599. <param name="settings">Encoder settings.</param>
  1600. <returns>LZ4 frame writer.</returns>
  1601. </member>
  1602. <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Encode(System.Buffers.IBufferWriter{System.Byte},K4os.Compression.LZ4.LZ4Level,System.Int32)">
  1603. <summary>
  1604. Create LZ4 encoder that writes compressed data into target buffer.
  1605. </summary>
  1606. <param name="target">Target buffer.</param>
  1607. <param name="level">Compression level.</param>
  1608. <param name="extraMemory">Extra memory for encoder.</param>
  1609. <returns>LZ4 frame writer.</returns>
  1610. </member>
  1611. <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Encode(System.IO.Stream,K4os.Compression.LZ4.Streams.LZ4EncoderSettings,System.Boolean)">
  1612. <summary>
  1613. Create LZ4 encoder that writes compressed data into target stream.
  1614. </summary>
  1615. <param name="target">Target stream.</param>
  1616. <param name="settings">Encoder settings.</param>
  1617. <param name="leaveOpen">Leave target stream open after encoder is disposed.</param>
  1618. <returns>LZ4 frame writer.</returns>
  1619. </member>
  1620. <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Encode(System.IO.Stream,K4os.Compression.LZ4.LZ4Level,System.Int32,System.Boolean)">
  1621. <summary>
  1622. Create LZ4 encoder that writes compressed data into target stream.
  1623. </summary>
  1624. <param name="target">Target stream.</param>
  1625. <param name="level">Compression level.</param>
  1626. <param name="extraMemory">Extra memory for encoder.</param>
  1627. <param name="leaveOpen">Leave target stream open after encoder is disposed.</param>
  1628. <returns></returns>
  1629. </member>
  1630. <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Encode(System.IO.Pipelines.PipeWriter,K4os.Compression.LZ4.Streams.LZ4EncoderSettings,System.Boolean)">
  1631. <summary>
  1632. Create LZ4 encoder that writes compressed data into target pipe.
  1633. </summary>
  1634. <param name="target">Target pipe.</param>
  1635. <param name="settings">Encoder settings.</param>
  1636. <param name="leaveOpen">Leave target pipe open after encoder is disposed.</param>
  1637. <returns>LZ4 frame writer.</returns>
  1638. </member>
  1639. <member name="M:K4os.Compression.LZ4.Streams.LZ4Frame.Encode(System.IO.Pipelines.PipeWriter,K4os.Compression.LZ4.LZ4Level,System.Int32,System.Boolean)">
  1640. <summary>
  1641. Create LZ4 encoder that writes compressed data into target pipe.
  1642. </summary>
  1643. <param name="target">Target pipe.</param>
  1644. <param name="level">Compression level.</param>
  1645. <param name="extraMemory">Extra memory for encoder.</param>
  1646. <param name="leaveOpen">Leave target pipe open after encoder is disposed.</param>
  1647. <returns>LZ4 frame writer.</returns>
  1648. </member>
  1649. <member name="T:K4os.Compression.LZ4.Streams.LZ4Stream">
  1650. <summary>
  1651. Utility class with factory methods to create LZ4 compression and decompression streams.
  1652. </summary>
  1653. </member>
  1654. <member name="M:K4os.Compression.LZ4.Streams.LZ4Stream.Encode(System.IO.Stream,K4os.Compression.LZ4.Streams.LZ4EncoderSettings,System.Boolean)">
  1655. <summary>Created compression stream on top of inner stream.</summary>
  1656. <param name="stream">Inner stream.</param>
  1657. <param name="settings">Compression settings.</param>
  1658. <param name="leaveOpen">Leave inner stream open after disposing.</param>
  1659. <returns>Compression stream.</returns>
  1660. </member>
  1661. <member name="M:K4os.Compression.LZ4.Streams.LZ4Stream.Encode(System.IO.Stream,K4os.Compression.LZ4.LZ4Level,System.Int32,System.Boolean)">
  1662. <summary>Created compression stream on top of inner stream.</summary>
  1663. <param name="stream">Inner stream.</param>
  1664. <param name="level">Compression level.</param>
  1665. <param name="extraMemory">Extra memory used for compression.</param>
  1666. <param name="leaveOpen">Leave inner stream open after disposing.</param>
  1667. <returns>Compression stream.</returns>
  1668. </member>
  1669. <member name="M:K4os.Compression.LZ4.Streams.LZ4Stream.Decode(System.IO.Stream,K4os.Compression.LZ4.Streams.LZ4DecoderSettings,System.Boolean,System.Boolean)">
  1670. <summary>Creates decompression stream on top of inner stream.</summary>
  1671. <param name="stream">Inner stream.</param>
  1672. <param name="settings">Decompression settings.</param>
  1673. <param name="leaveOpen">Leave inner stream open after disposing.</param>
  1674. <param name="interactive">If <c>true</c> reading from stream will be "interactive" allowing
  1675. to read bytes as soon as possible, even if more data is expected.</param>
  1676. <returns>Decompression stream.</returns>
  1677. </member>
  1678. <member name="M:K4os.Compression.LZ4.Streams.LZ4Stream.Decode(System.IO.Stream,System.Int32,System.Boolean,System.Boolean)">
  1679. <summary>Creates decompression stream on top of inner stream.</summary>
  1680. <param name="stream">Inner stream.</param>
  1681. <param name="extraMemory">Extra memory used for decompression.</param>
  1682. <param name="leaveOpen">Leave inner stream open after disposing.</param>
  1683. <param name="interactive">If <c>true</c> reading from stream will be "interactive" allowing
  1684. to read bytes as soon as possible, even if more data is expected.</param>
  1685. <returns>Decompression stream.</returns>
  1686. </member>
  1687. </members>
  1688. </doc>