16 lines
4.5 KiB
HTML
16 lines
4.5 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="ZSTD_getDictID_fromFrame() : Requires v1.4.0+ Provides the dictID required to decompressed the frame stored within `src`. If @return == 0, the dictID could not be decoded. This could for one of the following reasons :"><title>ZSTD_getDictID_fromFrame in zstd_sys - 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_sys" 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 fn"><!--[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="#">ZSTD_getDictID_fromFrame</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../zstd_sys/index.html">zstd_<wbr>sys</a><span class="version">2.0.16+zstd.1.5.7</span></h2></div><div class="sidebar-elems"><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"><div class="rustdoc-breadcrumbs"><a href="index.html">zstd_sys</a></div><h1>Function <span class="fn">ZSTD_<wbr>getDictID_<wbr>from<wbr>Frame</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/zstd_sys/bindings_zstd.rs.html#559-562">Source</a> </span></div><pre class="rust item-decl"><code>pub unsafe extern "C" fn ZSTD_getDictID_fromFrame(
|
||
src: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.pointer.html">*const </a><a class="enum" href="https://doc.rust-lang.org/1.93.1/core/ffi/enum.c_void.html" title="enum core::ffi::c_void">c_void</a>,
|
||
srcSize: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.usize.html">usize</a>,
|
||
) -> <a class="type" href="https://doc.rust-lang.org/1.93.1/core/ffi/primitives/type.c_uint.html" title="type core::ffi::primitives::c_uint">c_uint</a></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>ZSTD_getDictID_fromFrame() : Requires v1.4.0+
|
||
Provides the dictID required to decompressed the frame stored within <code>src</code>.
|
||
If @return == 0, the dictID could not be decoded.
|
||
This could for one of the following reasons :</p>
|
||
<ul>
|
||
<li>The frame does not require a dictionary to be decoded (most common case).</li>
|
||
<li>The frame was built with dictID intentionally removed. Whatever dictionary is necessary is a hidden piece of information.
|
||
Note : this use case also happens when using a non-conformant dictionary.</li>
|
||
<li><code>srcSize</code> is too small, and as a result, the frame header could not be decoded (only possible if <code>srcSize < ZSTD_FRAMEHEADERSIZE_MAX</code>).</li>
|
||
<li>This is not a Zstandard frame.
|
||
When identifying the exact failure cause, it’s possible to use ZSTD_getFrameHeader(), which will provide a more precise error code.</li>
|
||
</ul>
|
||
</div></details></section></div></main></body></html> |