evan/ludum-dare-50
Archived
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
This repository has been archived on 2022-04-04. You can view files and clone it, but cannot push or open issues or pull requests.
ludum-dare-50/rustdoc/zstd_safe/index.html

87 lines
28 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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."><meta name="keywords" content="rust, rustlang, rust-lang, zstd_safe"><title>zstd_safe - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script src="../crates.js"></script><script defer src="../main.js"></script>
<noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.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]--><nav class="sidebar"><div class="sidebar-menu" role="button">&#9776;</div><a class="sidebar-logo" href="../zstd_safe/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.png" alt="logo"></div>
</a><h2 class="location">Crate zstd_safe</h2><div class="block version"><div class="narrow-helper"></div><p>Version 4.1.4+zstd.1.5.2</p></div><div class="sidebar-elems"><a id="all-types" href="all.html"><p>See all zstd_safe's items</p></a><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#constants">Constants</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li><li><a href="#types">Type Definitions</a></li></ul></div><div id="sidebar-vars" data-name="zstd_safe" data-ty="mod" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../zstd_safe/index.html"><img class="rust-logo" src="../rust-logo.png" alt="logo"></a><nav class="sub"><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><h1 class="fqn"><span class="in-band">Crate <a class="mod" href="#">zstd_safe</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span><a class="srclink" href="../src/zstd_safe/lib.rs.html#1-2123" title="goto source code">[src]</a></span></h1><details class="rustdoc-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> mentionned 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="small-section-header"><a href="#reexports">Re-exports</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left import-item"><code>pub use <a class="mod" href="../zstd_sys/index.html" title="mod zstd_sys">zstd_sys</a>;</code></div><div class="item-right docblock-short"></div></div></div><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.CCtx.html" title="zstd_safe::CCtx struct">CCtx</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.CDict.html" title="zstd_safe::CDict struct">CDict</a></div><div class="item-right docblock-short"><p>Compression dictionary.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.DCtx.html" title="zstd_safe::DCtx struct">DCtx</a></div><div class="item-right docblock-short"><p>A Decompression Context.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.DDict.html" title="zstd_safe::DDict struct">DDict</a></div><div class="item-right docblock-short"><p>A digested decompression dictionary.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.InBuffer.html" title="zstd_safe::InBuffer struct">InBuffer</a></div><div class="item-right docblock-short"><p>Wrapper around an input buffer.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.OutBuffer.html" title="zstd_safe::OutBuffer struct">OutBuffer</a></div><div class="item-right docblock-short"><p>Wrapper around an output buffer.</p>
</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.CParameter.html" title="zstd_safe::CParameter enum">CParameter</a></div><div class="item-right docblock-short"><p>A compression parameter.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.DParameter.html" title="zstd_safe::DParameter enum">DParameter</a></div><div class="item-right docblock-short"><p>A decompression parameter.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.ResetDirective.html" title="zstd_safe::ResetDirective enum">ResetDirective</a></div><div class="item-right docblock-short"><p>Reset directive.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Strategy.html" title="zstd_safe::Strategy enum">Strategy</a></div><div class="item-right docblock-short"><p>How to compress data.
Advanced compression API (Requires v1.4.0+)</p>
</div></div></div><h2 id="constants" class="small-section-header"><a href="#constants">Constants</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.BLOCKSIZELOG_MAX.html" title="zstd_safe::BLOCKSIZELOG_MAX constant">BLOCKSIZELOG_MAX</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.BLOCKSIZE_MAX.html" title="zstd_safe::BLOCKSIZE_MAX constant">BLOCKSIZE_MAX</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.CLEVEL_DEFAULT.html" title="zstd_safe::CLEVEL_DEFAULT constant">CLEVEL_DEFAULT</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.CONTENTSIZE_ERROR.html" title="zstd_safe::CONTENTSIZE_ERROR constant">CONTENTSIZE_ERROR</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.CONTENTSIZE_UNKNOWN.html" title="zstd_safe::CONTENTSIZE_UNKNOWN constant">CONTENTSIZE_UNKNOWN</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.MAGICNUMBER.html" title="zstd_safe::MAGICNUMBER constant">MAGICNUMBER</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.MAGIC_DICTIONARY.html" title="zstd_safe::MAGIC_DICTIONARY constant">MAGIC_DICTIONARY</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.MAGIC_SKIPPABLE_MASK.html" title="zstd_safe::MAGIC_SKIPPABLE_MASK constant">MAGIC_SKIPPABLE_MASK</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.MAGIC_SKIPPABLE_START.html" title="zstd_safe::MAGIC_SKIPPABLE_START constant">MAGIC_SKIPPABLE_START</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.VERSION_MAJOR.html" title="zstd_safe::VERSION_MAJOR constant">VERSION_MAJOR</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.VERSION_MINOR.html" title="zstd_safe::VERSION_MINOR constant">VERSION_MINOR</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.VERSION_NUMBER.html" title="zstd_safe::VERSION_NUMBER constant">VERSION_NUMBER</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.VERSION_RELEASE.html" title="zstd_safe::VERSION_RELEASE constant">VERSION_RELEASE</a></div><div class="item-right docblock-short"></div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.WriteBuf.html" title="zstd_safe::WriteBuf trait">WriteBuf</a></div><div class="item-right docblock-short"><p>Describe a resizeable bytes container like <code>Vec&lt;u8&gt;</code>.</p>
</div></div></div><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.cctx_load_dictionary.html" title="zstd_safe::cctx_load_dictionary fn">cctx_load_dictionary</a></div><div class="item-right docblock-short"><p>Wraps the <code>ZSTD_CCtx_loadDictionary()</code> function.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.cctx_ref_cdict.html" title="zstd_safe::cctx_ref_cdict fn">cctx_ref_cdict</a></div><div class="item-right docblock-short"><p>Wraps the <code>ZSTD_CCtx_refCDict()</code> function.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.cctx_ref_prefix.html" title="zstd_safe::cctx_ref_prefix fn">cctx_ref_prefix</a></div><div class="item-right docblock-short"><p>Wraps the <code>ZSTD_CCtx_refPrefix()</code> function.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.cctx_reset.html" title="zstd_safe::cctx_reset fn">cctx_reset</a></div><div class="item-right docblock-short"><p>Wraps the <code>ZSTD_CCtx_reset()</code> function.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.cctx_set_parameter.html" title="zstd_safe::cctx_set_parameter fn">cctx_set_parameter</a></div><div class="item-right docblock-short"><p>Wraps the <code>ZSTD_CCtx_setParameter()</code> function.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.cctx_set_pledged_src_size.html" title="zstd_safe::cctx_set_pledged_src_size fn">cctx_set_pledged_src_size</a></div><div class="item-right docblock-short"><p>Wraps the <code>ZSTD_CCtx_setPledgedSrcSize()</code> function.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.compress.html" title="zstd_safe::compress fn">compress</a></div><div class="item-right docblock-short"><p>Wraps the <code>ZSTD_compress</code> function.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.compress2.html" title="zstd_safe::compress2 fn">compress2</a></div><div class="item-right docblock-short"><p>Wraps the <code>ZSTD_compress2()</code> function.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.compress_bound.html" title="zstd_safe::compress_bound fn">compress_bound</a></div><div class="item-right docblock-short"><p>maximum compressed size in worst case single-pass scenario</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.compress_cctx.html" title="zstd_safe::compress_cctx fn">compress_cctx</a></div><div class="item-right docblock-short"><p>Wraps the <code>ZSTD_compressCCtx()</code> function</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.compress_stream.html" title="zstd_safe::compress_stream fn">compress_stream</a></div><div class="item-right docblock-short"><p>Wraps the <code>ZSTD_compressStream()</code> function.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.compress_stream2.html" title="zstd_safe::compress_stream2 fn">compress_stream2</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.compress_using_cdict.html" title="zstd_safe::compress_using_cdict fn">compress_using_cdict</a></div><div class="item-right docblock-short"><p>Wraps the <code>ZSTD_compress_usingCDict()</code> function.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.compress_using_dict.html" title="zstd_safe::compress_using_dict fn">compress_using_dict</a></div><div class="item-right docblock-short"><p>Wraps the <code>ZSTD_compress_usingDict()</code> function.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.create_cctx.html" title="zstd_safe::create_cctx fn">create_cctx</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.create_cdict.html" title="zstd_safe::create_cdict fn">create_cdict</a></div><div class="item-right docblock-short"><p>Wraps the <code>ZSTD_createCDict()</code> function.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.create_cstream.html" title="zstd_safe::create_cstream fn">create_cstream</a></div><div class="item-right docblock-short"><p>Allocates a new <code>CStream</code>.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.create_dctx.html" title="zstd_safe::create_dctx fn">create_dctx</a></div><div class="item-right docblock-short"><p>Prepares a new decompression context without dictionary.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.create_ddict.html" title="zstd_safe::create_ddict fn">create_ddict</a></div><div class="item-right docblock-short"><p>Wraps the <code>ZSTD_createDDict()</code> function.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.create_dstream.html" title="zstd_safe::create_dstream fn">create_dstream</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.cstream_in_size.html" title="zstd_safe::cstream_in_size fn">cstream_in_size</a></div><div class="item-right docblock-short"><p>Wraps <code>ZSTD_CStreamInSize()</code></p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.cstream_out_size.html" title="zstd_safe::cstream_out_size fn">cstream_out_size</a></div><div class="item-right docblock-short"><p>Wraps <code>ZSTD_CStreamOutSize()</code></p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.dctx_load_dictionary.html" title="zstd_safe::dctx_load_dictionary fn">dctx_load_dictionary</a></div><div class="item-right docblock-short"><p>Wraps the <code>ZSTD_DCtx_loadDictionary()</code> function.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.dctx_ref_ddict.html" title="zstd_safe::dctx_ref_ddict fn">dctx_ref_ddict</a></div><div class="item-right docblock-short"><p>Wraps the <code>ZSTD_DCtx_refDDict()</code> function.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.dctx_ref_prefix.html" title="zstd_safe::dctx_ref_prefix fn">dctx_ref_prefix</a></div><div class="item-right docblock-short"><p>Wraps the <code>ZSTD_DCtx_refPrefix()</code> function.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.dctx_reset.html" title="zstd_safe::dctx_reset fn">dctx_reset</a></div><div class="item-right docblock-short"><p>Wraps the <code>ZSTD_DCtx_reset()</code> function.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.dctx_set_parameter.html" title="zstd_safe::dctx_set_parameter fn">dctx_set_parameter</a></div><div class="item-right docblock-short"><p>Wraps the <code>ZSTD_DCtx_setParameter()</code> function.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.decompress.html" title="zstd_safe::decompress fn">decompress</a></div><div class="item-right docblock-short"><p>Wraps the <code>ZSTD_decompress</code> function.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.decompress_dctx.html" title="zstd_safe::decompress_dctx fn">decompress_dctx</a></div><div class="item-right docblock-short"><p>Wraps the <code>ZSTD_decompressDCtx()</code> function.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.decompress_stream.html" title="zstd_safe::decompress_stream fn">decompress_stream</a></div><div class="item-right docblock-short"><p>Wraps the <code>ZSTD_decompressStream()</code> function.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.decompress_using_ddict.html" title="zstd_safe::decompress_using_ddict fn">decompress_using_ddict</a></div><div class="item-right docblock-short"><p>Wraps the <code>ZSTD_decompress_usingDDict()</code> function.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.decompress_using_dict.html" title="zstd_safe::decompress_using_dict fn">decompress_using_dict</a></div><div class="item-right docblock-short"><p>Wraps the <code>ZSTD_decompress_usingDict()</code> function.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.dstream_in_size.html" title="zstd_safe::dstream_in_size fn">dstream_in_size</a></div><div class="item-right docblock-short"><p>Wraps the <code>ZSTD_DStreamInSize()</code> function.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.dstream_out_size.html" title="zstd_safe::dstream_out_size fn">dstream_out_size</a></div><div class="item-right docblock-short"><p>Wraps the <code>ZSTD_DStreamOutSize()</code> function.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.end_stream.html" title="zstd_safe::end_stream fn">end_stream</a></div><div class="item-right docblock-short"><p>Wraps the <code>ZSTD_endStream()</code> function.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.find_frame_compressed_size.html" title="zstd_safe::find_frame_compressed_size fn">find_frame_compressed_size</a></div><div class="item-right docblock-short"><p>Wraps the <code>ZSTD_findFrameCompressedSize()</code> function.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.flush_stream.html" title="zstd_safe::flush_stream fn">flush_stream</a></div><div class="item-right docblock-short"><p>Wraps the <code>ZSTD_flushStream()</code> function.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.get_decompressed_size.html" title="zstd_safe::get_decompressed_size fn">get_decompressed_size</a><span class="stab deprecated" title="">Deprecated</span></div><div class="item-right docblock-short"><p>Wraps the <code>ZSTD_getDecompressedSize</code> function.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.get_dict_id.html" title="zstd_safe::get_dict_id fn">get_dict_id</a></div><div class="item-right docblock-short"><p>Wraps the <code>ZSTD_getDictID_fromDict()</code> function.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.get_dict_id_from_ddict.html" title="zstd_safe::get_dict_id_from_ddict fn">get_dict_id_from_ddict</a></div><div class="item-right docblock-short"><p>Wraps the <code>ZSTD_getDictID_fromDDict()</code> function.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.get_dict_id_from_dict.html" title="zstd_safe::get_dict_id_from_dict fn">get_dict_id_from_dict</a></div><div class="item-right docblock-short"><p>Wraps the <code>ZSTD_getDictID_fromDict()</code> function.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.get_dict_id_from_frame.html" title="zstd_safe::get_dict_id_from_frame fn">get_dict_id_from_frame</a></div><div class="item-right docblock-short"><p>Wraps the <code>ZSTD_getDictID_fromFrame()</code> function.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.get_error_name.html" title="zstd_safe::get_error_name fn">get_error_name</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.get_frame_content_size.html" title="zstd_safe::get_frame_content_size fn">get_frame_content_size</a></div><div class="item-right docblock-short"><p>Wraps the <code>ZSTD_getFrameContentSize()</code> function.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.init_cstream.html" title="zstd_safe::init_cstream fn">init_cstream</a></div><div class="item-right docblock-short"><p>Prepares an existing <code>CStream</code> for compression at the given level.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.init_dstream.html" title="zstd_safe::init_dstream fn">init_dstream</a></div><div class="item-right docblock-short"><p>Wraps the <code>ZSTD_initCStream()</code> function.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.max_c_level.html" title="zstd_safe::max_c_level fn">max_c_level</a></div><div class="item-right docblock-short"><p>Returns the maximum (slowest) compression level supported.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.min_c_level.html" title="zstd_safe::min_c_level fn">min_c_level</a></div><div class="item-right docblock-short"><p>Returns the minimum (fastest) compression level supported.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.sizeof_cctx.html" title="zstd_safe::sizeof_cctx fn">sizeof_cctx</a></div><div class="item-right docblock-short"><p>Wraps the <code>ZSTD_sizeofCCtx()</code> function.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.sizeof_cdict.html" title="zstd_safe::sizeof_cdict fn">sizeof_cdict</a></div><div class="item-right docblock-short"><p>Wraps the <code>ZSTD_sizeof_CDict()</code> function.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.sizeof_cstream.html" title="zstd_safe::sizeof_cstream fn">sizeof_cstream</a></div><div class="item-right docblock-short"><p>Wraps the <code>ZSTD_sizeof_CStream()</code> function.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.sizeof_dctx.html" title="zstd_safe::sizeof_dctx fn">sizeof_dctx</a></div><div class="item-right docblock-short"><p>Wraps the <code>ZSTD_sizeof_DCtx()</code> function.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.sizeof_ddict.html" title="zstd_safe::sizeof_ddict fn">sizeof_ddict</a></div><div class="item-right docblock-short"><p>Wraps the <code>ZSTD_sizeof_DDict()</code> function.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.sizeof_dstream.html" title="zstd_safe::sizeof_dstream fn">sizeof_dstream</a></div><div class="item-right docblock-short"><p>Wraps the <code>ZSTD_sizeof_DStream()</code> function.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.train_from_buffer.html" title="zstd_safe::train_from_buffer fn">train_from_buffer</a></div><div class="item-right docblock-short"><p>Wraps the <code>ZDICT_trainFromBuffer()</code> function.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.version_number.html" title="zstd_safe::version_number fn">version_number</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.version_string.html" title="zstd_safe::version_string fn">version_string</a></div><div class="item-right docblock-short"></div></div></div><h2 id="types" class="small-section-header"><a href="#types">Type Definitions</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="type" href="type.CStream.html" title="zstd_safe::CStream type">CStream</a></div><div class="item-right docblock-short"><p>Compression stream.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="type" href="type.CompressionLevel.html" title="zstd_safe::CompressionLevel type">CompressionLevel</a></div><div class="item-right docblock-short"><p>Represents the compression level used by zstd.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="type" href="type.DStream.html" title="zstd_safe::DStream type">DStream</a></div><div class="item-right docblock-short"><p>A Decompression stream.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="type" href="type.ErrorCode.html" title="zstd_safe::ErrorCode type">ErrorCode</a></div><div class="item-right docblock-short"><p>Represents a possible error from the zstd library.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="type" href="type.SafeResult.html" title="zstd_safe::SafeResult type">SafeResult</a></div><div class="item-right docblock-short"><p>Wrapper result around most zstd functions.</p>
</div></div></div></section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="zstd_safe" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.59.0 (9d1b2106e 2022-02-23)" ></div>
</body></html>
Reference in New Issue View Git Blame Copy Permalink