Files
phy/ruzstd/index.html
Orion Kindel 0ce894e6b0 doc
2025-03-18 10:30:23 -05:00

4 lines
5.6 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="API documentation for the Rust `ruzstd` crate."><title>ruzstd - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.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" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="ruzstd" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.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]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../ruzstd/index.html">ruzstd</a><span class="version">0.7.3</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="#modules" title="Modules">Modules</a></li><li><a href="#constants" title="Constants">Constants</a></li></ul></section><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Crate <span>ruzstd</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/ruzstd/lib.rs.html#1-42">Source</a> </span></div><h2 id="reexports" class="section-header">Re-exports<a href="#reexports" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name" id="reexport.BlockDecodingStrategy"><code>pub use frame_decoder::<a class="enum" href="frame_decoder/enum.BlockDecodingStrategy.html" title="enum ruzstd::frame_decoder::BlockDecodingStrategy">BlockDecodingStrategy</a>;</code></div></li><li><div class="item-name" id="reexport.FrameDecoder"><code>pub use frame_decoder::<a class="struct" href="frame_decoder/struct.FrameDecoder.html" title="struct ruzstd::frame_decoder::FrameDecoder">FrameDecoder</a>;</code></div></li><li><div class="item-name" id="reexport.StreamingDecoder"><code>pub use streaming_decoder::<a class="struct" href="streaming_decoder/struct.StreamingDecoder.html" title="struct ruzstd::streaming_decoder::StreamingDecoder">StreamingDecoder</a>;</code></div></li></ul><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="blocks/index.html" title="mod ruzstd::blocks">blocks</a></div><div class="desc docblock-short">In a Zstandard frame, theres a frame header, followed by one or more <em>blocks</em>.</div></li><li><div class="item-name"><a class="mod" href="decoding/index.html" title="mod ruzstd::decoding">decoding</a></div><div class="desc docblock-short">Structures and utilities used for reading from data, decoding that data
and storing the output.</div></li><li><div class="item-name"><a class="mod" href="frame/index.html" title="mod ruzstd::frame">frame</a></div></li><li><div class="item-name"><a class="mod" href="frame_decoder/index.html" title="mod ruzstd::frame_decoder">frame_<wbr>decoder</a></div><div class="desc docblock-short">Framedecoder is the man struct users interact with to decode zstd frames</div></li><li><div class="item-name"><a class="mod" href="fse/index.html" title="mod ruzstd::fse">fse</a></div><div class="desc docblock-short">FSE, short for Finite State Entropy, is an encoding technique
that assigns shorter codes to symbols that appear more frequently in data,
and longer codes to less frequent symbols.</div></li><li><div class="item-name"><a class="mod" href="huff0/index.html" title="mod ruzstd::huff0">huff0</a></div></li><li><div class="item-name"><a class="mod" href="io/index.html" title="mod ruzstd::io">io</a></div><div class="desc docblock-short">Re-exports of std values for when the std is available.</div></li><li><div class="item-name"><a class="mod" href="streaming_decoder/index.html" title="mod ruzstd::streaming_decoder">streaming_<wbr>decoder</a></div></li></ul><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="constant" href="constant.VERBOSE.html" title="constant ruzstd::VERBOSE">VERBOSE</a></div></li></ul></section></div></main></body></html>