1 line
16 KiB
HTML
1 line
16 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `enc` mod in crate `brotli`."><title>brotli::enc - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="brotli" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">Module enc</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../brotli/index.html">brotli</a><span class="version">8.0.2</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module enc</a></h2><h3><a href="#reexports">Module Items</a></h3><ul class="block"><li><a href="#reexports" title="Re-exports">Re-exports</a></li><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#traits" title="Traits">Traits</a></li><li><a href="#functions" title="Functions">Functions</a></li><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate brotli</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">brotli</a></div><h1>Module <span>enc</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/brotli/enc/mod.rs.html#1-344">Source</a> </span></div><h2 id="reexports" class="section-header">Re-exports<a href="#reexports" class="anchor">§</a></h2><dl class="item-table reexports"><dt id="reexport.InputPair"><code>pub use interface::<a class="struct" href="input_pair/struct.InputPair.html" title="struct brotli::enc::input_pair::InputPair">InputPair</a>;</code></dt><dt id="reexport.InputReference"><code>pub use interface::<a class="struct" href="input_pair/struct.InputReference.html" title="struct brotli::enc::input_pair::InputReference">InputReference</a>;</code></dt><dt id="reexport.InputReferenceMut"><code>pub use interface::<a class="struct" href="input_pair/struct.InputReferenceMut.html" title="struct brotli::enc::input_pair::InputReferenceMut">InputReferenceMut</a>;</code></dt><dt id="reexport.hash_to_binary_tree"><code>pub use self::backward_references::<a class="mod" href="backward_references/hash_to_binary_tree/index.html" title="mod brotli::enc::backward_references::hash_to_binary_tree">hash_to_binary_tree</a>;</code></dt><dt id="reexport.backward_references_hq"><code>pub use self::backward_references::<a class="mod" href="backward_references/hq/index.html" title="mod brotli::enc::backward_references::hq">hq</a> as backward_references_hq;</code></dt><dt id="reexport.BrotliEncoderParams"><code>pub use self::backward_references::<a class="struct" href="backward_references/struct.BrotliEncoderParams.html" title="struct brotli::enc::backward_references::BrotliEncoderParams">BrotliEncoderParams</a>;</code></dt><dt id="reexport.UnionHasher"><code>pub use self::backward_references::<a class="enum" href="backward_references/enum.UnionHasher.html" title="enum brotli::enc::backward_references::UnionHasher">UnionHasher</a>;</code></dt><dt id="reexport.BrotliAlloc"><code>pub use self::combined_alloc::<a class="trait" href="combined_alloc/trait.BrotliAlloc.html" title="trait brotli::enc::combined_alloc::BrotliAlloc">BrotliAlloc</a>;</code></dt><dt id="reexport.CombiningAllocator"><code>pub use self::combined_alloc::<a class="struct" href="combined_alloc/struct.CombiningAllocator.html" title="struct brotli::enc::combined_alloc::CombiningAllocator">CombiningAllocator</a>;</code></dt><dt id="reexport.BrotliEncoderInitParams"><code>pub use self::encode::<a class="fn" href="encode/fn.BrotliEncoderInitParams.html" title="fn brotli::enc::encode::BrotliEncoderInitParams">BrotliEncoderInitParams</a>;</code></dt><dt id="reexport.BrotliEncoderMaxCompressedSize"><code>pub use self::encode::<a class="fn" href="encode/fn.BrotliEncoderMaxCompressedSize.html" title="fn brotli::enc::encode::BrotliEncoderMaxCompressedSize">BrotliEncoderMaxCompressedSize</a>;</code></dt><dt id="reexport.BrotliEncoderMaxCompressedSizeMulti"><code>pub use self::encode::<a class="fn" href="encode/fn.BrotliEncoderMaxCompressedSizeMulti.html" title="fn brotli::enc::encode::BrotliEncoderMaxCompressedSizeMulti">BrotliEncoderMaxCompressedSizeMulti</a>;</code></dt><dt id="reexport.ZopfliNode"><code>pub use self::hash_to_binary_tree::<a class="struct" href="backward_references/hash_to_binary_tree/struct.ZopfliNode.html" title="struct brotli::enc::backward_references::hash_to_binary_tree::ZopfliNode">ZopfliNode</a>;</code></dt><dt id="reexport.StaticCommand"><code>pub use self::interface::<a class="type" href="interface/type.StaticCommand.html" title="type brotli::enc::interface::StaticCommand">StaticCommand</a>;</code></dt><dt id="reexport.PDF"><code>pub use self::pdf::<a class="struct" href="pdf/struct.PDF.html" title="struct brotli::enc::pdf::PDF">PDF</a>;</code></dt><dt id="reexport.BatchSpawnableLite"><code>pub use self::threading::<a class="trait" href="threading/trait.BatchSpawnableLite.html" title="trait brotli::enc::threading::BatchSpawnableLite">BatchSpawnableLite</a>;</code></dt><dt id="reexport.BrotliEncoderThreadError"><code>pub use self::threading::<a class="enum" href="threading/enum.BrotliEncoderThreadError.html" title="enum brotli::enc::threading::BrotliEncoderThreadError">BrotliEncoderThreadError</a>;</code></dt><dt id="reexport.CompressionThreadResult"><code>pub use self::threading::<a class="struct" href="threading/struct.CompressionThreadResult.html" title="struct brotli::enc::threading::CompressionThreadResult">CompressionThreadResult</a>;</code></dt><dt id="reexport.Owned"><code>pub use self::threading::<a class="struct" href="threading/struct.Owned.html" title="struct brotli::enc::threading::Owned">Owned</a>;</code></dt><dt id="reexport.SendAlloc"><code>pub use self::threading::<a class="struct" href="threading/struct.SendAlloc.html" title="struct brotli::enc::threading::SendAlloc">SendAlloc</a>;</code></dt><dt id="reexport.floatX"><code>pub use self::util::<a class="type" href="util/type.floatX.html" title="type brotli::enc::util::floatX">floatX</a>;</code></dt><dt id="reexport.v256"><code>pub use self::vectorization::<a class="type" href="vectorization/type.v256.html" title="type brotli::enc::vectorization::v256">v256</a>;</code></dt><dt id="reexport.v256i"><code>pub use self::vectorization::<a class="type" href="vectorization/type.v256i.html" title="type brotli::enc::vectorization::v256i">v256i</a>;</code></dt><dt id="reexport.Mem256f"><code>pub use self::vectorization::<a class="type" href="vectorization/type.Mem256f.html" title="type brotli::enc::vectorization::Mem256f">Mem256f</a>;</code></dt><dt id="reexport.compress_worker_pool"><code>pub use self::worker_pool::<a class="fn" href="worker_pool/fn.compress_worker_pool.html" title="fn brotli::enc::worker_pool::compress_worker_pool">compress_worker_pool</a>;</code></dt><dt id="reexport.new_work_pool"><code>pub use self::worker_pool::<a class="fn" href="worker_pool/fn.new_work_pool.html" title="fn brotli::enc::worker_pool::new_work_pool">new_work_pool</a>;</code></dt><dt id="reexport.WorkerPool"><code>pub use self::worker_pool::<a class="struct" href="worker_pool/struct.WorkerPool.html" title="struct brotli::enc::worker_pool::WorkerPool">WorkerPool</a>;</code></dt><dt id="reexport.compress_multi_no_threadpool"><code>pub use self::multithreading::<a class="fn" href="multithreading/fn.compress_multi.html" title="fn brotli::enc::multithreading::compress_multi">compress_multi</a> as compress_multi_no_threadpool;</code></dt></dl><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><dl class="item-table"><dt><a class="mod" href="backward_references/index.html" title="mod brotli::enc::backward_references">backward_<wbr>references</a></dt><dt><a class="mod" href="bit_cost/index.html" title="mod brotli::enc::bit_cost">bit_<wbr>cost</a></dt><dt><a class="mod" href="block_split/index.html" title="mod brotli::enc::block_split">block_<wbr>split</a></dt><dt><a class="mod" href="block_splitter/index.html" title="mod brotli::enc::block_splitter">block_<wbr>splitter</a></dt><dt><a class="mod" href="brotli_bit_stream/index.html" title="mod brotli::enc::brotli_bit_stream">brotli_<wbr>bit_<wbr>stream</a></dt><dt><a class="mod" href="cluster/index.html" title="mod brotli::enc::cluster">cluster</a></dt><dt><a class="mod" href="combined_alloc/index.html" title="mod brotli::enc::combined_alloc">combined_<wbr>alloc</a></dt><dt><a class="mod" href="command/index.html" title="mod brotli::enc::command">command</a></dt><dt><a class="mod" href="compress_fragment/index.html" title="mod brotli::enc::compress_fragment">compress_<wbr>fragment</a></dt><dt><a class="mod" href="compress_fragment_two_pass/index.html" title="mod brotli::enc::compress_fragment_two_pass">compress_<wbr>fragment_<wbr>two_<wbr>pass</a></dt><dt><a class="mod" href="constants/index.html" title="mod brotli::enc::constants">constants</a></dt><dt><a class="mod" href="context_map_entropy/index.html" title="mod brotli::enc::context_map_entropy">context_<wbr>map_<wbr>entropy</a></dt><dt><a class="mod" href="dictionary_hash/index.html" title="mod brotli::enc::dictionary_hash">dictionary_<wbr>hash</a></dt><dt><a class="mod" href="encode/index.html" title="mod brotli::enc::encode">encode</a></dt><dt><a class="mod" href="entropy_encode/index.html" title="mod brotli::enc::entropy_encode">entropy_<wbr>encode</a></dt><dt><a class="mod" href="find_stride/index.html" title="mod brotli::enc::find_stride">find_<wbr>stride</a></dt><dt><a class="mod" href="fixed_queue/index.html" title="mod brotli::enc::fixed_queue">fixed_<wbr>queue</a></dt><dt><a class="mod" href="histogram/index.html" title="mod brotli::enc::histogram">histogram</a></dt><dt><a class="mod" href="input_pair/index.html" title="mod brotli::enc::input_pair">input_<wbr>pair</a></dt><dt><a class="mod" href="interface/index.html" title="mod brotli::enc::interface">interface</a></dt><dt><a class="mod" href="ir_interpret/index.html" title="mod brotli::enc::ir_interpret">ir_<wbr>interpret</a></dt><dt><a class="mod" href="literal_cost/index.html" title="mod brotli::enc::literal_cost">literal_<wbr>cost</a></dt><dt><a class="mod" href="metablock/index.html" title="mod brotli::enc::metablock">metablock</a></dt><dt><a class="mod" href="multithreading/index.html" title="mod brotli::enc::multithreading">multithreading</a></dt><dt><a class="mod" href="pdf/index.html" title="mod brotli::enc::pdf">pdf</a></dt><dt><a class="mod" href="prior_eval/index.html" title="mod brotli::enc::prior_eval">prior_<wbr>eval</a></dt><dt><a class="mod" href="reader/index.html" title="mod brotli::enc::reader">reader</a></dt><dt><a class="mod" href="singlethreading/index.html" title="mod brotli::enc::singlethreading">singlethreading</a></dt><dt><a class="mod" href="static_dict/index.html" title="mod brotli::enc::static_dict">static_<wbr>dict</a></dt><dt><a class="mod" href="static_dict_lut/index.html" title="mod brotli::enc::static_dict_lut">static_<wbr>dict_<wbr>lut</a></dt><dt><a class="mod" href="stride_eval/index.html" title="mod brotli::enc::stride_eval">stride_<wbr>eval</a></dt><dt><a class="mod" href="threading/index.html" title="mod brotli::enc::threading">threading</a></dt><dt><a class="mod" href="utf8_util/index.html" title="mod brotli::enc::utf8_util">utf8_<wbr>util</a></dt><dt><a class="mod" href="util/index.html" title="mod brotli::enc::util">util</a></dt><dt><a class="mod" href="vectorization/index.html" title="mod brotli::enc::vectorization">vectorization</a></dt><dt><a class="mod" href="worker_pool/index.html" title="mod brotli::enc::worker_pool">worker_<wbr>pool</a></dt><dt><a class="mod" href="writer/index.html" title="mod brotli::enc::writer">writer</a></dt></dl><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.AllocatedStackMemory.html" title="struct brotli::enc::AllocatedStackMemory">Allocated<wbr>Stack<wbr>Memory</a></dt><dt><a class="struct" href="struct.IntoIoReader.html" title="struct brotli::enc::IntoIoReader">Into<wbr>IoReader</a></dt><dt><a class="struct" href="struct.IoReaderWrapper.html" title="struct brotli::enc::IoReaderWrapper">IoReader<wbr>Wrapper</a></dt><dt><a class="struct" href="struct.IoWriterWrapper.html" title="struct brotli::enc::IoWriterWrapper">IoWriter<wbr>Wrapper</a></dt><dt><a class="struct" href="struct.StackAllocator.html" title="struct brotli::enc::StackAllocator">Stack<wbr>Allocator</a></dt><dt><a class="struct" href="struct.StandardAlloc.html" title="struct brotli::enc::StandardAlloc">Standard<wbr>Alloc</a></dt></dl><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><dl class="item-table"><dt><a class="trait" href="trait.Allocator.html" title="trait brotli::enc::Allocator">Allocator</a></dt><dt><a class="trait" href="trait.SliceWrapper.html" title="trait brotli::enc::SliceWrapper">Slice<wbr>Wrapper</a></dt><dt><a class="trait" href="trait.SliceWrapperMut.html" title="trait brotli::enc::SliceWrapperMut">Slice<wbr>Wrapper<wbr>Mut</a></dt></dl><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><dl class="item-table"><dt><a class="fn" href="fn.BrotliCompress.html" title="fn brotli::enc::BrotliCompress">Brotli<wbr>Compress</a></dt><dt><a class="fn" href="fn.BrotliCompressCustomAlloc.html" title="fn brotli::enc::BrotliCompressCustomAlloc">Brotli<wbr>Compress<wbr>Custom<wbr>Alloc</a></dt><dt><a class="fn" href="fn.BrotliCompressCustomIo.html" title="fn brotli::enc::BrotliCompressCustomIo">Brotli<wbr>Compress<wbr>Custom<wbr>Io</a></dt><dt><a class="fn" href="fn.BrotliCompressCustomIoCustomDict.html" title="fn brotli::enc::BrotliCompressCustomIoCustomDict">Brotli<wbr>Compress<wbr>Custom<wbr>IoCustom<wbr>Dict</a></dt><dt><a class="fn" href="fn.compress_multi.html" title="fn brotli::enc::compress_multi">compress_<wbr>multi</a></dt></dl><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><dl class="item-table"><dt><a class="type" href="type.s8.html" title="type brotli::enc::s8">s8</a></dt><dt><a class="type" href="type.s16.html" title="type brotli::enc::s16">s16</a></dt><dt><a class="type" href="type.v8.html" title="type brotli::enc::v8">v8</a></dt></dl></section></div></main></body></html> |