| <!DOCTYPE html> |
| <html> |
| <head> |
| <meta charset="utf-8"> |
| <title>Class Compressor | Official DotPulsar Documentation </title> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| <meta name="title" content="Class Compressor | Official DotPulsar Documentation "> |
| |
| |
| <link rel="icon" href="../assets/favicon.ico"> |
| <link rel="stylesheet" href="../public/docfx.min.css"> |
| <link rel="stylesheet" href="../public/main.css"> |
| <meta name="docfx:navrel" content="../toc.html"> |
| <meta name="docfx:tocrel" content="toc.html"> |
| |
| |
| |
| |
| <meta name="docfx:docurl" content="https://github.com/apache/pulsar-dotpulsar/new/3.2.1-rc.1/apiSpec/new?filename=DotPulsar_Internal_Compression_Compressor.md&value=---%0Auid%3A%20DotPulsar.Internal.Compression.Compressor%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A"> |
| <meta name="loc:inThisArticle" content="In this article"> |
| <meta name="loc:searchResultsCount" content="{count} results for "{query}""> |
| <meta name="loc:searchNoResults" content="No results for "{query}""> |
| <meta name="loc:tocFilter" content="Filter by title"> |
| <meta name="loc:nextArticle" content="Next"> |
| <meta name="loc:prevArticle" content="Previous"> |
| <meta name="loc:themeLight" content="Light"> |
| <meta name="loc:themeDark" content="Dark"> |
| <meta name="loc:themeAuto" content="Auto"> |
| <meta name="loc:changeTheme" content="Change theme"> |
| <meta name="loc:copy" content="Copy"> |
| <meta name="loc:downloadPdf" content="Download PDF"> |
| |
| <script type="module" src="./../public/docfx.min.js"></script> |
| |
| <script> |
| const theme = localStorage.getItem('theme') || 'auto' |
| document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme) |
| </script> |
| |
| </head> |
| |
| <body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference"> |
| <header class="bg-body border-bottom"> |
| <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> |
| <div class="container-xxl flex-nowrap"> |
| <a class="navbar-brand" href="../index.html"> |
| <img id="logo" class="svg" src="../assets/pulsar.svg" alt=""> |
| |
| </a> |
| <button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation"> |
| <i class="bi bi-three-dots"></i> |
| </button> |
| <div class="collapse navbar-collapse" id="navpanel"> |
| <div id="navbar"> |
| </div> |
| </div> |
| </div> |
| </nav> |
| </header> |
| |
| <main class="container-xxl"> |
| <div class="toc-offcanvas"> |
| <div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel"> |
| <div class="offcanvas-header"> |
| <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5> |
| <button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button> |
| </div> |
| <div class="offcanvas-body"> |
| <nav class="toc" id="toc"></nav> |
| </div> |
| </div> |
| </div> |
| |
| <div class="content"> |
| <div class="actionbar"> |
| <button class="btn btn-lg border-0 d-md-none" style="margin-top: -.65em; margin-left: -.8em" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents"> |
| <i class="bi bi-list"></i> |
| </button> |
| |
| <nav id="breadcrumb"></nav> |
| </div> |
| |
| <article data-uid="DotPulsar.Internal.Compression.Compressor"> |
| |
| |
| |
| <h1 id="DotPulsar_Internal_Compression_Compressor" data-uid="DotPulsar.Internal.Compression.Compressor" class="text-break"> |
| Class Compressor <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.2.1-rc.1/src/DotPulsar/Internal/Compression/Compressor.cs/#L20"><i class="bi bi-code-slash"></i></a> |
| </h1> |
| |
| <div class="facts text-secondary"> |
| <dl><dt>Namespace</dt><dd><a class="xref" href="DotPulsar.html">DotPulsar</a>.<a class="xref" href="DotPulsar.Internal.html">Internal</a>.<a class="xref" href="DotPulsar.Internal.Compression.html">Compression</a></dd></dl> |
| <dl><dt>Assembly</dt><dd>DotPulsar.dll</dd></dl> |
| </div> |
| |
| <div class="markdown summary"></div> |
| <div class="markdown conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public sealed class Compressor : ICompress, IDisposable</code></pre> |
| </div> |
| |
| |
| |
| |
| <dl class="typelist inheritance"> |
| <dt>Inheritance</dt> |
| <dd> |
| <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div> |
| <div><span class="xref">Compressor</span></div> |
| </dd> |
| </dl> |
| |
| <dl class="typelist implements"> |
| <dt>Implements</dt> |
| <dd> |
| <div><a class="xref" href="DotPulsar.Internal.Abstractions.ICompress.html">ICompress</a></div> |
| <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.idisposable">IDisposable</a></div> |
| </dd> |
| </dl> |
| |
| |
| <dl class="typelist inheritedMembers"> |
| <dt>Inherited Members</dt> |
| <dd> |
| <div> |
| <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a> |
| </div> |
| <div> |
| <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a> |
| </div> |
| <div> |
| <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a> |
| </div> |
| <div> |
| <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a> |
| </div> |
| <div> |
| <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a> |
| </div> |
| <div> |
| <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a> |
| </div> |
| </dd></dl> |
| |
| <dl class="typelist extensionMethods"> |
| <dt>Extension Methods</dt> |
| <dd> |
| <div> |
| <a class="xref" href="DotPulsar.Extensions.StateExtensions.html#DotPulsar_Extensions_StateExtensions_DelayedStateMonitor__2___0___1_System_TimeSpan_System_Action___0___1__System_Action___0___1__System_Threading_CancellationToken_">StateExtensions.DelayedStateMonitor<TEntity, TState>(TEntity, TState, TimeSpan, Action<TEntity, TState>, Action<TEntity, TState>, CancellationToken)</a> |
| </div> |
| <div> |
| <a class="xref" href="DotPulsar.Extensions.StateExtensions.html#DotPulsar_Extensions_StateExtensions_DelayedStateMonitor__2___0___1_System_TimeSpan_System_Func___0___1_System_Threading_CancellationToken_System_Threading_Tasks_ValueTask__System_Func___0___1_System_Threading_CancellationToken_System_Threading_Tasks_ValueTask__System_Threading_CancellationToken_">StateExtensions.DelayedStateMonitor<TEntity, TState>(TEntity, TState, TimeSpan, Func<TEntity, TState, CancellationToken, ValueTask>, Func<TEntity, TState, CancellationToken, ValueTask>, CancellationToken)</a> |
| </div> |
| <div> |
| <a class="xref" href="DotPulsar.Extensions.StateExtensions.html#DotPulsar_Extensions_StateExtensions_DelayedStateMonitor__3___0___1_System_TimeSpan_System_Func___0___1_System_Threading_CancellationToken_System_Threading_Tasks_ValueTask___2___System_Func___0___1___2_System_Threading_CancellationToken_System_Threading_Tasks_ValueTask__System_Threading_CancellationToken_">StateExtensions.DelayedStateMonitor<TEntity, TState, TFaultContext>(TEntity, TState, TimeSpan, Func<TEntity, TState, CancellationToken, ValueTask<TFaultContext>>, Func<TEntity, TState, TFaultContext, CancellationToken, ValueTask>, CancellationToken)</a> |
| </div> |
| </dd></dl> |
| |
| |
| |
| |
| |
| <h2 class="section" id="constructors">Constructors |
| </h2> |
| |
| |
| <a id="DotPulsar_Internal_Compression_Compressor__ctor_" data-uid="DotPulsar.Internal.Compression.Compressor.#ctor*"></a> |
| |
| <h3 id="DotPulsar_Internal_Compression_Compressor__ctor_System_Func_System_Buffers_ReadOnlySequence_System_Byte__System_Buffers_ReadOnlySequence_System_Byte___" data-uid="DotPulsar.Internal.Compression.Compressor.#ctor(System.Func{System.Buffers.ReadOnlySequence{System.Byte},System.Buffers.ReadOnlySequence{System.Byte}})"> |
| Compressor(Func<ReadOnlySequence<byte>, ReadOnlySequence<byte>>) |
| <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.2.1-rc.1/src/DotPulsar/Internal/Compression/Compressor.cs/#L31"><i class="bi bi-code-slash"></i></a> |
| </h3> |
| |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public Compressor(Func<ReadOnlySequence<byte>, ReadOnlySequence<byte>> compress)</code></pre> |
| </div> |
| |
| <h4 class="section">Parameters</h4> |
| <dl class="parameters"> |
| <dt><code>compress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.buffers.readonlysequence-1">ReadOnlySequence</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>>, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.buffers.readonlysequence-1">ReadOnlySequence</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>>></dt> |
| <dd></dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <a id="DotPulsar_Internal_Compression_Compressor__ctor_" data-uid="DotPulsar.Internal.Compression.Compressor.#ctor*"></a> |
| |
| <h3 id="DotPulsar_Internal_Compression_Compressor__ctor_System_Func_System_Buffers_ReadOnlySequence_System_Byte__System_Buffers_ReadOnlySequence_System_Byte___System_IDisposable_" data-uid="DotPulsar.Internal.Compression.Compressor.#ctor(System.Func{System.Buffers.ReadOnlySequence{System.Byte},System.Buffers.ReadOnlySequence{System.Byte}},System.IDisposable)"> |
| Compressor(Func<ReadOnlySequence<byte>, ReadOnlySequence<byte>>, IDisposable?) |
| <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.2.1-rc.1/src/DotPulsar/Internal/Compression/Compressor.cs/#L25"><i class="bi bi-code-slash"></i></a> |
| </h3> |
| |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public Compressor(Func<ReadOnlySequence<byte>, ReadOnlySequence<byte>> compress, IDisposable? disposable = null)</code></pre> |
| </div> |
| |
| <h4 class="section">Parameters</h4> |
| <dl class="parameters"> |
| <dt><code>compress</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.buffers.readonlysequence-1">ReadOnlySequence</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>>, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.buffers.readonlysequence-1">ReadOnlySequence</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>>></dt> |
| <dd></dd> |
| <dt><code>disposable</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.idisposable">IDisposable</a></dt> |
| <dd></dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <h2 class="section" id="methods">Methods |
| </h2> |
| |
| |
| <a id="DotPulsar_Internal_Compression_Compressor_Compress_" data-uid="DotPulsar.Internal.Compression.Compressor.Compress*"></a> |
| |
| <h3 id="DotPulsar_Internal_Compression_Compressor_Compress_System_Buffers_ReadOnlySequence_System_Byte__" data-uid="DotPulsar.Internal.Compression.Compressor.Compress(System.Buffers.ReadOnlySequence{System.Byte})"> |
| Compress(ReadOnlySequence<byte>) |
| <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.2.1-rc.1/src/DotPulsar/Internal/Compression/Compressor.cs/#L34"><i class="bi bi-code-slash"></i></a> |
| </h3> |
| |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public ReadOnlySequence<byte> Compress(ReadOnlySequence<byte> data)</code></pre> |
| </div> |
| |
| <h4 class="section">Parameters</h4> |
| <dl class="parameters"> |
| <dt><code>data</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.buffers.readonlysequence-1">ReadOnlySequence</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>></dt> |
| <dd></dd> |
| </dl> |
| |
| <h4 class="section">Returns</h4> |
| <dl class="parameters"> |
| <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.buffers.readonlysequence-1">ReadOnlySequence</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>></dt> |
| <dd></dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <a id="DotPulsar_Internal_Compression_Compressor_Dispose_" data-uid="DotPulsar.Internal.Compression.Compressor.Dispose*"></a> |
| |
| <h3 id="DotPulsar_Internal_Compression_Compressor_Dispose" data-uid="DotPulsar.Internal.Compression.Compressor.Dispose"> |
| Dispose() |
| <a class="header-action link-secondary" title="View source" href="https://github.com/apache/pulsar-dotpulsar/blob/3.2.1-rc.1/src/DotPulsar/Internal/Compression/Compressor.cs/#L37"><i class="bi bi-code-slash"></i></a> |
| </h3> |
| |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public void Dispose()</code></pre> |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </article> |
| |
| <div class="contribution d-print-none"> |
| <a href="https://github.com/apache/pulsar-dotpulsar/blob/3.2.1-rc.1/src/DotPulsar/Internal/Compression/Compressor.cs/#L20" class="edit-link">Edit this page</a> |
| </div> |
| |
| |
| </div> |
| |
| <div class="affix"> |
| <nav id="affix"></nav> |
| </div> |
| </main> |
| |
| |
| <footer class="border-top text-secondary"> |
| <div class="container-xxl"> |
| <div class="flex-fill"> |
| Copyright © 2019-2024 The Apache Software Foundation. All Rights Reserved. Apache, Pulsar, Apache Pulsar, and the Apache feather logo are trademarks or registered trademarks of The Apache Software Foundation. |
| </div> |
| </div> |
| </footer> |
| </body> |
| </html> |
