18 lines
5.3 KiB
HTML
18 lines
5.3 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_CCtx_setPledgedSrcSize() : Total input data size to be compressed as a single frame. Value will be written in frame header, unless if explicitly forbidden using ZSTD_c_contentSizeFlag. This value will also be controlled at end of frame, and trigger an error if not respected. @result : 0, or an error code (which can be tested with ZSTD_isError()). Note 1 : pledgedSrcSize==0 actually means zero, aka an empty frame. In order to mean “unknown content size”, pass constant ZSTD_CONTENTSIZE_UNKNOWN. ZSTD_CONTENTSIZE_UNKNOWN is default value for any new frame. Note 2 : pledgedSrcSize is only valid once, for the next frame. It’s discarded at the end of the frame, and replaced by ZSTD_CONTENTSIZE_UNKNOWN. Note 3 : Whenever all input data is provided and consumed in a single round, for example with ZSTD_compress2(), or invoking immediately ZSTD_compressStream2(,,,ZSTD_e_end), this value is automatically overridden by srcSize instead."><title>ZSTD_CCtx_setPledgedSrcSize 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_CCtx_setPledgedSrcSize</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>CCtx_<wbr>setPledged<wbr>SrcSize</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#288-291">Source</a> </span></div><pre class="rust item-decl"><code>pub unsafe extern "C" fn ZSTD_CCtx_setPledgedSrcSize(
|
||
cctx: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.pointer.html">*mut </a><a class="type" href="type.ZSTD_CCtx.html" title="type zstd_sys::ZSTD_CCtx">ZSTD_CCtx</a>,
|
||
pledgedSrcSize: <a class="type" href="https://doc.rust-lang.org/1.93.1/core/ffi/primitives/type.c_ulonglong.html" title="type core::ffi::primitives::c_ulonglong">c_ulonglong</a>,
|
||
) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.usize.html">usize</a></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>ZSTD_CCtx_setPledgedSrcSize() :
|
||
Total input data size to be compressed as a single frame.
|
||
Value will be written in frame header, unless if explicitly forbidden using ZSTD_c_contentSizeFlag.
|
||
This value will also be controlled at end of frame, and trigger an error if not respected.
|
||
@result : 0, or an error code (which can be tested with ZSTD_isError()).
|
||
Note 1 : pledgedSrcSize==0 actually means zero, aka an empty frame.
|
||
In order to mean “unknown content size”, pass constant ZSTD_CONTENTSIZE_UNKNOWN.
|
||
ZSTD_CONTENTSIZE_UNKNOWN is default value for any new frame.
|
||
Note 2 : pledgedSrcSize is only valid once, for the next frame.
|
||
It’s discarded at the end of the frame, and replaced by ZSTD_CONTENTSIZE_UNKNOWN.
|
||
Note 3 : Whenever all input data is provided and consumed in a single round,
|
||
for example with ZSTD_compress2(),
|
||
or invoking immediately ZSTD_compressStream2(,,,ZSTD_e_end),
|
||
this value is automatically overridden by srcSize instead.</p>
|
||
</div></details></section></div></main></body></html> |