hobokenchicken/GopherGate
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
82d4e3ff6597b062dd0ba1d6a6c78342cd1ec387
GopherGate/target/doc/zstd_safe/index.html
hobokenchicken 49701c85ad Adding large folders
2026-02-26 12:00:21 -05:00

11 lines
13 KiB
HTML
Raw Blame History

<!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="Minimal safe wrapper around zstd-sys."><title>zstd_safe - 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="zstd_safe" 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="../crates.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 crate"><!--[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="#">Crate zstd_safe</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../zstd_safe/index.html">zstd_<wbr>safe</a><span class="version">7.2.4</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#reexports">Crate Items</a></h3><ul class="block"><li><a href="#reexports" title="Re-exports">Re-exports</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#constants" title="Constants">Constants</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"></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"><h1>Crate <span>zstd_<wbr>safe</span>&nbsp;<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/zstd_safe/lib.rs.html#1-2360">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Minimal safe wrapper around zstd-sys.</p>
<p>This crates provides a minimal translation of the <a href="https://crates.io/crates/zstd-sys">zstd-sys</a> methods.
For a more comfortable high-level library, see the <a href="https://crates.io/crates/zstd">zstd</a> crate.</p>
<p>Most of the functions here map 1-for-1 to a function from
<a href="https://facebook.github.io/zstd/">the C zstd library</a> mentioned in their descriptions.
Check the <a href="https://facebook.github.io/zstd/zstd_manual.html">source documentation</a> for more information on their
behaviour.</p>
<p>Features denoted as experimental in the C library are hidden behind an
<code>experimental</code> feature.</p>
</div></details><h2 id="reexports" class="section-header">Re-exports<a href="#reexports" class="anchor">§</a></h2><dl class="item-table reexports"><dt id="reexport.zstd_sys"><code>pub use <a class="mod" href="../zstd_sys/index.html" title="mod zstd_sys">zstd_sys</a>;</code></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.CCtx.html" title="struct zstd_safe::CCtx">CCtx</a></dt><dd>Compression context</dd><dt><a class="struct" href="struct.CDict.html" title="struct zstd_safe::CDict">CDict</a></dt><dd>Compression dictionary.</dd><dt><a class="struct" href="struct.ContentSizeError.html" title="struct zstd_safe::ContentSizeError">Content<wbr>Size<wbr>Error</a></dt><dd>Indicates an error happened when parsing the frame content size.</dd><dt><a class="struct" href="struct.DCtx.html" title="struct zstd_safe::DCtx">DCtx</a></dt><dd>A Decompression Context.</dd><dt><a class="struct" href="struct.DDict.html" title="struct zstd_safe::DDict">DDict</a></dt><dd>A digested decompression dictionary.</dd><dt><a class="struct" href="struct.InBuffer.html" title="struct zstd_safe::InBuffer">InBuffer</a></dt><dd>Wrapper around an input buffer.</dd><dt><a class="struct" href="struct.OutBuffer.html" title="struct zstd_safe::OutBuffer">OutBuffer</a></dt><dd>Wrapper around an output buffer.</dd></dl><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.CParameter.html" title="enum zstd_safe::CParameter">CParameter</a></dt><dd>A compression parameter.</dd><dt><a class="enum" href="enum.DParameter.html" title="enum zstd_safe::DParameter">DParameter</a></dt><dd>A decompression parameter.</dd><dt><a class="enum" href="enum.ResetDirective.html" title="enum zstd_safe::ResetDirective">Reset<wbr>Directive</a></dt><dd>What kind of context reset should be applied.</dd><dt><a class="enum" href="enum.Strategy.html" title="enum zstd_safe::Strategy">Strategy</a></dt><dd>How to compress data.
Advanced compression API (Requires v1.4.0+)</dd></dl><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><dl class="item-table"><dt><a class="constant" href="constant.BLOCKSIZELOG_MAX.html" title="constant zstd_safe::BLOCKSIZELOG_MAX">BLOCKSIZELOG_<wbr>MAX</a></dt><dt><a class="constant" href="constant.BLOCKSIZE_MAX.html" title="constant zstd_safe::BLOCKSIZE_MAX">BLOCKSIZE_<wbr>MAX</a></dt><dt><a class="constant" href="constant.CLEVEL_DEFAULT.html" title="constant zstd_safe::CLEVEL_DEFAULT">CLEVEL_<wbr>DEFAULT</a></dt><dt><a class="constant" href="constant.CONTENTSIZE_ERROR.html" title="constant zstd_safe::CONTENTSIZE_ERROR">CONTENTSIZE_<wbr>ERROR</a></dt><dt><a class="constant" href="constant.CONTENTSIZE_UNKNOWN.html" title="constant zstd_safe::CONTENTSIZE_UNKNOWN">CONTENTSIZE_<wbr>UNKNOWN</a></dt><dt><a class="constant" href="constant.MAGICNUMBER.html" title="constant zstd_safe::MAGICNUMBER">MAGICNUMBER</a></dt><dt><a class="constant" href="constant.MAGIC_DICTIONARY.html" title="constant zstd_safe::MAGIC_DICTIONARY">MAGIC_<wbr>DICTIONARY</a></dt><dt><a class="constant" href="constant.MAGIC_SKIPPABLE_MASK.html" title="constant zstd_safe::MAGIC_SKIPPABLE_MASK">MAGIC_<wbr>SKIPPABLE_<wbr>MASK</a></dt><dt><a class="constant" href="constant.MAGIC_SKIPPABLE_START.html" title="constant zstd_safe::MAGIC_SKIPPABLE_START">MAGIC_<wbr>SKIPPABLE_<wbr>START</a></dt><dt><a class="constant" href="constant.VERSION_MAJOR.html" title="constant zstd_safe::VERSION_MAJOR">VERSION_<wbr>MAJOR</a></dt><dt><a class="constant" href="constant.VERSION_MINOR.html" title="constant zstd_safe::VERSION_MINOR">VERSION_<wbr>MINOR</a></dt><dt><a class="constant" href="constant.VERSION_NUMBER.html" title="constant zstd_safe::VERSION_NUMBER">VERSION_<wbr>NUMBER</a></dt><dt><a class="constant" href="constant.VERSION_RELEASE.html" title="constant zstd_safe::VERSION_RELEASE">VERSION_<wbr>RELEASE</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.WriteBuf.html" title="trait zstd_safe::WriteBuf">Write<wbr>Buf</a></dt><dd>Describe a bytes container, like <code>Vec&lt;u8&gt;</code>.</dd></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.compress.html" title="fn zstd_safe::compress">compress</a></dt><dd>Wraps the <code>ZSTD_compress</code> function.</dd><dt><a class="fn" href="fn.compress_bound.html" title="fn zstd_safe::compress_bound">compress_<wbr>bound</a></dt><dd>Maximum compressed size in worst case single-pass scenario</dd><dt><a class="fn" href="fn.compress_using_cdict.html" title="fn zstd_safe::compress_using_cdict">compress_<wbr>using_<wbr>cdict</a></dt><dd>Wraps the <code>ZSTD_compress_usingCDict()</code> function.</dd><dt><a class="fn" href="fn.create_cdict.html" title="fn zstd_safe::create_cdict">create_<wbr>cdict</a></dt><dd>Wraps the <code>ZSTD_createCDict()</code> function.</dd><dt><a class="fn" href="fn.create_cstream.html" title="fn zstd_safe::create_cstream">create_<wbr>cstream</a></dt><dd>Allocates a new <code>CStream</code>.</dd><dt><a class="fn" href="fn.create_ddict.html" title="fn zstd_safe::create_ddict">create_<wbr>ddict</a></dt><dd>Wraps the <code>ZSTD_createDDict()</code> function.</dd><dt><a class="fn" href="fn.decompress.html" title="fn zstd_safe::decompress">decompress</a></dt><dd>Wraps the <code>ZSTD_decompress</code> function.</dd><dt><a class="fn" href="fn.decompress_using_ddict.html" title="fn zstd_safe::decompress_using_ddict">decompress_<wbr>using_<wbr>ddict</a></dt><dd>Wraps the <code>ZSTD_decompress_usingDDict()</code> function.</dd><dt><a class="fn" href="fn.find_frame_compressed_size.html" title="fn zstd_safe::find_frame_compressed_size">find_<wbr>frame_<wbr>compressed_<wbr>size</a></dt><dd>Wraps the <code>ZSTD_findFrameCompressedSize()</code> function.</dd><dt><a class="fn" href="fn.get_decompressed_size.html" title="fn zstd_safe::get_decompressed_size">get_<wbr>decompressed_<wbr>size</a><wbr><span class="stab deprecated" title="">Deprecated</span></dt><dd>Wraps the <code>ZSTD_getDecompressedSize</code> function.</dd><dt><a class="fn" href="fn.get_dict_id_from_dict.html" title="fn zstd_safe::get_dict_id_from_dict">get_<wbr>dict_<wbr>id_<wbr>from_<wbr>dict</a></dt><dd>Wraps the <code>ZSTD_getDictID_fromDict()</code> function.</dd><dt><a class="fn" href="fn.get_dict_id_from_frame.html" title="fn zstd_safe::get_dict_id_from_frame">get_<wbr>dict_<wbr>id_<wbr>from_<wbr>frame</a></dt><dd>Wraps the <code>ZSTD_getDictID_fromFrame()</code> function.</dd><dt><a class="fn" href="fn.get_error_name.html" title="fn zstd_safe::get_error_name">get_<wbr>error_<wbr>name</a></dt><dd>Returns the error string associated with an error code.</dd><dt><a class="fn" href="fn.get_frame_content_size.html" title="fn zstd_safe::get_frame_content_size">get_<wbr>frame_<wbr>content_<wbr>size</a></dt><dd>Wraps the <code>ZSTD_getFrameContentSize()</code> function.</dd><dt><a class="fn" href="fn.init_cstream.html" title="fn zstd_safe::init_cstream">init_<wbr>cstream</a></dt><dd>Prepares an existing <code>CStream</code> for compression at the given level.</dd><dt><a class="fn" href="fn.max_c_level.html" title="fn zstd_safe::max_c_level">max_<wbr>c_<wbr>level</a></dt><dd>Returns the maximum (slowest) compression level supported.</dd><dt><a class="fn" href="fn.min_c_level.html" title="fn zstd_safe::min_c_level">min_<wbr>c_<wbr>level</a></dt><dd>Returns the minimum (fastest) compression level supported.</dd><dt><a class="fn" href="fn.version_number.html" title="fn zstd_safe::version_number">version_<wbr>number</a></dt><dd>Returns the ZSTD version.</dd><dt><a class="fn" href="fn.version_string.html" title="fn zstd_safe::version_string">version_<wbr>string</a></dt><dd>Returns a string representation of the ZSTD version.</dd></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.CStream.html" title="type zstd_safe::CStream">CStream</a></dt><dd>Compression stream.</dd><dt><a class="type" href="type.CompressionLevel.html" title="type zstd_safe::CompressionLevel">Compression<wbr>Level</a></dt><dd>Represents the compression level used by zstd.</dd><dt><a class="type" href="type.DStream.html" title="type zstd_safe::DStream">DStream</a></dt><dd>A Decompression stream.</dd><dt><a class="type" href="type.ErrorCode.html" title="type zstd_safe::ErrorCode">Error<wbr>Code</a></dt><dd>Represents a possible error from the zstd library.</dd><dt><a class="type" href="type.SafeResult.html" title="type zstd_safe::SafeResult">Safe<wbr>Result</a></dt><dd>Wrapper result around most zstd functions.</dd></dl></section></div></main></body></html>
Reference in New Issue View Git Blame Copy Permalink