Files
trussed/cipher/trait.AsyncStreamCipher.html
2026-03-09 11:41:19 +00:00

44 lines
13 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="Marker trait for block-level asynchronous stream ciphers"><title>AsyncStreamCipher in cipher - 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-77263533.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="cipher" data-themes="" data-resource-suffix="" data-rustdoc-version="1.94.0 (4a4ef493e 2026-03-02)" data-channel="1.94.0" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-b897f86f.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-7bab91a1.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-ffcac47a.css"></noscript><link rel="icon" href="https://raw.githubusercontent.com/RustCrypto/media/6ee8e381/logo.svg"></head><body class="rustdoc trait"><!--[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="#">AsyncStreamCipher</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../cipher/index.html"><img src="https://raw.githubusercontent.com/RustCrypto/media/6ee8e381/logo.svg" alt="logo"></a><h2><a href="../cipher/index.html">cipher</a><span class="version">0.4.4</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Async<wbr>Stream<wbr>Cipher</a></h2><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.decrypt" title="decrypt">decrypt</a></li><li><a href="#method.decrypt_b2b" title="decrypt_b2b">decrypt_b2b</a></li><li><a href="#method.decrypt_inout" title="decrypt_inout">decrypt_inout</a></li><li><a href="#method.encrypt" title="encrypt">encrypt</a></li><li><a href="#method.encrypt_b2b" title="encrypt_b2b">encrypt_b2b</a></li><li><a href="#method.encrypt_inout" title="encrypt_inout">encrypt_inout</a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate cipher</a></h2></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">cipher</a></div><h1>Trait <span class="trait">Async<wbr>Stream<wbr>Cipher</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/cipher/stream.rs.html#12-75">Source</a> </span></div><pre class="rust item-decl"><code>pub trait AsyncStreamCipher: <a class="trait" href="https://doc.rust-lang.org/1.94.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
// Provided methods
fn <a href="#method.encrypt_inout" class="fn">encrypt_inout</a>(self, data: <a class="struct" href="../inout/inout_buf/struct.InOutBuf.html" title="struct inout::inout_buf::InOutBuf">InOutBuf</a>&lt;'_, '_, <a class="primitive" href="https://doc.rust-lang.org/1.94.0/core/primitive.u8.html">u8</a>&gt;)
<span class="where">where Self: <a class="trait" href="trait.BlockEncryptMut.html" title="trait cipher::BlockEncryptMut">BlockEncryptMut</a></span> { ... }
<span class="item-spacer"></span> fn <a href="#method.decrypt_inout" class="fn">decrypt_inout</a>(self, data: <a class="struct" href="../inout/inout_buf/struct.InOutBuf.html" title="struct inout::inout_buf::InOutBuf">InOutBuf</a>&lt;'_, '_, <a class="primitive" href="https://doc.rust-lang.org/1.94.0/core/primitive.u8.html">u8</a>&gt;)
<span class="where">where Self: <a class="trait" href="trait.BlockDecryptMut.html" title="trait cipher::BlockDecryptMut">BlockDecryptMut</a></span> { ... }
<span class="item-spacer"></span> fn <a href="#method.encrypt" class="fn">encrypt</a>(self, buf: &amp;mut [<a class="primitive" href="https://doc.rust-lang.org/1.94.0/core/primitive.u8.html">u8</a>])
<span class="where">where Self: <a class="trait" href="trait.BlockEncryptMut.html" title="trait cipher::BlockEncryptMut">BlockEncryptMut</a></span> { ... }
<span class="item-spacer"></span> fn <a href="#method.decrypt" class="fn">decrypt</a>(self, buf: &amp;mut [<a class="primitive" href="https://doc.rust-lang.org/1.94.0/core/primitive.u8.html">u8</a>])
<span class="where">where Self: <a class="trait" href="trait.BlockDecryptMut.html" title="trait cipher::BlockDecryptMut">BlockDecryptMut</a></span> { ... }
<span class="item-spacer"></span> fn <a href="#method.encrypt_b2b" class="fn">encrypt_b2b</a>(
self,
in_buf: &amp;[<a class="primitive" href="https://doc.rust-lang.org/1.94.0/core/primitive.u8.html">u8</a>],
out_buf: &amp;mut [<a class="primitive" href="https://doc.rust-lang.org/1.94.0/core/primitive.u8.html">u8</a>],
) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.94.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.94.0/core/primitive.unit.html">()</a>, <a class="struct" href="../inout/errors/struct.NotEqualError.html" title="struct inout::errors::NotEqualError">NotEqualError</a>&gt;
<span class="where">where Self: <a class="trait" href="trait.BlockEncryptMut.html" title="trait cipher::BlockEncryptMut">BlockEncryptMut</a></span> { ... }
<span class="item-spacer"></span> fn <a href="#method.decrypt_b2b" class="fn">decrypt_b2b</a>(
self,
in_buf: &amp;[<a class="primitive" href="https://doc.rust-lang.org/1.94.0/core/primitive.u8.html">u8</a>],
out_buf: &amp;mut [<a class="primitive" href="https://doc.rust-lang.org/1.94.0/core/primitive.u8.html">u8</a>],
) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.94.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.94.0/core/primitive.unit.html">()</a>, <a class="struct" href="../inout/errors/struct.NotEqualError.html" title="struct inout::errors::NotEqualError">NotEqualError</a>&gt;
<span class="where">where Self: <a class="trait" href="trait.BlockDecryptMut.html" title="trait cipher::BlockDecryptMut">BlockDecryptMut</a></span> { ... }
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Marker trait for block-level asynchronous stream ciphers</p>
</div></details><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="method.encrypt_inout" class="method"><a class="src rightside" href="../src/cipher/stream.rs.html#14-27">Source</a><h4 class="code-header">fn <a href="#method.encrypt_inout" class="fn">encrypt_inout</a>(self, data: <a class="struct" href="../inout/inout_buf/struct.InOutBuf.html" title="struct inout::inout_buf::InOutBuf">InOutBuf</a>&lt;'_, '_, <a class="primitive" href="https://doc.rust-lang.org/1.94.0/core/primitive.u8.html">u8</a>&gt;)<div class="where">where
Self: <a class="trait" href="trait.BlockEncryptMut.html" title="trait cipher::BlockEncryptMut">BlockEncryptMut</a>,</div></h4></section></summary><div class="docblock"><p>Encrypt data using <code>InOutBuf</code>.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.decrypt_inout" class="method"><a class="src rightside" href="../src/cipher/stream.rs.html#30-43">Source</a><h4 class="code-header">fn <a href="#method.decrypt_inout" class="fn">decrypt_inout</a>(self, data: <a class="struct" href="../inout/inout_buf/struct.InOutBuf.html" title="struct inout::inout_buf::InOutBuf">InOutBuf</a>&lt;'_, '_, <a class="primitive" href="https://doc.rust-lang.org/1.94.0/core/primitive.u8.html">u8</a>&gt;)<div class="where">where
Self: <a class="trait" href="trait.BlockDecryptMut.html" title="trait cipher::BlockDecryptMut">BlockDecryptMut</a>,</div></h4></section></summary><div class="docblock"><p>Decrypt data using <code>InOutBuf</code>.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.encrypt" class="method"><a class="src rightside" href="../src/cipher/stream.rs.html#45-50">Source</a><h4 class="code-header">fn <a href="#method.encrypt" class="fn">encrypt</a>(self, buf: &amp;mut [<a class="primitive" href="https://doc.rust-lang.org/1.94.0/core/primitive.u8.html">u8</a>])<div class="where">where
Self: <a class="trait" href="trait.BlockEncryptMut.html" title="trait cipher::BlockEncryptMut">BlockEncryptMut</a>,</div></h4></section></summary><div class="docblock"><p>Encrypt data in place.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.decrypt" class="method"><a class="src rightside" href="../src/cipher/stream.rs.html#53-58">Source</a><h4 class="code-header">fn <a href="#method.decrypt" class="fn">decrypt</a>(self, buf: &amp;mut [<a class="primitive" href="https://doc.rust-lang.org/1.94.0/core/primitive.u8.html">u8</a>])<div class="where">where
Self: <a class="trait" href="trait.BlockDecryptMut.html" title="trait cipher::BlockDecryptMut">BlockDecryptMut</a>,</div></h4></section></summary><div class="docblock"><p>Decrypt data in place.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.encrypt_b2b" class="method"><a class="src rightside" href="../src/cipher/stream.rs.html#61-66">Source</a><h4 class="code-header">fn <a href="#method.encrypt_b2b" class="fn">encrypt_b2b</a>(
self,
in_buf: &amp;[<a class="primitive" href="https://doc.rust-lang.org/1.94.0/core/primitive.u8.html">u8</a>],
out_buf: &amp;mut [<a class="primitive" href="https://doc.rust-lang.org/1.94.0/core/primitive.u8.html">u8</a>],
) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.94.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.94.0/core/primitive.unit.html">()</a>, <a class="struct" href="../inout/errors/struct.NotEqualError.html" title="struct inout::errors::NotEqualError">NotEqualError</a>&gt;<div class="where">where
Self: <a class="trait" href="trait.BlockEncryptMut.html" title="trait cipher::BlockEncryptMut">BlockEncryptMut</a>,</div></h4></section></summary><div class="docblock"><p>Encrypt data from buffer to buffer.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.decrypt_b2b" class="method"><a class="src rightside" href="../src/cipher/stream.rs.html#69-74">Source</a><h4 class="code-header">fn <a href="#method.decrypt_b2b" class="fn">decrypt_b2b</a>(
self,
in_buf: &amp;[<a class="primitive" href="https://doc.rust-lang.org/1.94.0/core/primitive.u8.html">u8</a>],
out_buf: &amp;mut [<a class="primitive" href="https://doc.rust-lang.org/1.94.0/core/primitive.u8.html">u8</a>],
) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.94.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.94.0/core/primitive.unit.html">()</a>, <a class="struct" href="../inout/errors/struct.NotEqualError.html" title="struct inout::errors::NotEqualError">NotEqualError</a>&gt;<div class="where">where
Self: <a class="trait" href="trait.BlockDecryptMut.html" title="trait cipher::BlockDecryptMut">BlockDecryptMut</a>,</div></h4></section></summary><div class="docblock"><p>Decrypt data from buffer to buffer.</p>
</div></details></div><h2 id="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.94.0/reference/items/traits.html#dyn-compatibility">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../trait.impl/cipher/stream/trait.AsyncStreamCipher.js" async></script></section></div></main></body></html>