Skip to content

Commit

Permalink
Deploying to gh-pages from @ 4377bdb 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
gferon committed Jan 30, 2025
1 parent c0f8e7e commit 605f628
Show file tree
Hide file tree
Showing 587 changed files with 3,031 additions and 3,012 deletions.
2 changes: 1 addition & 1 deletion libsignal_protocol/enum.ServiceId.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="enum" href="enum.ServiceId.html" title="enum libsignal_protocol::ServiceId">ServiceId</a>&gt;</h4></section></summary><div class="docblock"><p>Parses from the standard binary representation, returning <code>None</code> if invalid.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.parse_from_service_id_string" class="method"><h4 class="code-header">pub fn <a href="#method.parse_from_service_id_string" class="fn">parse_from_service_id_string</a>(input: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.str.html">str</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="enum" href="enum.ServiceId.html" title="enum libsignal_protocol::ServiceId">ServiceId</a>&gt;</h4></section></summary><div class="docblock"><p>Parses from the standard String representation, returning <code>None</code> if invalid.</p>
<p>The UUID parsing is case-insensitive.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.raw_uuid" class="method"><h4 class="code-header">pub fn <a href="#method.raw_uuid" class="fn">raw_uuid</a>(self) -&gt; <a class="struct" href="https://docs.rs/uuid/1.12.0/uuid/struct.Uuid.html" title="struct uuid::Uuid">Uuid</a></h4></section></summary><div class="docblock"><p>Returns the UUID inside this service ID, discarding the type.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.raw_uuid" class="method"><h4 class="code-header">pub fn <a href="#method.raw_uuid" class="fn">raw_uuid</a>(self) -&gt; <a class="struct" href="https://docs.rs/uuid/1.12.1/uuid/struct.Uuid.html" title="struct uuid::Uuid">Uuid</a></h4></section></summary><div class="docblock"><p>Returns the UUID inside this service ID, discarding the type.</p>
</div></details></div></details></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Clone-for-ServiceId" class="impl"><a href="#impl-Clone-for-ServiceId" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="enum" href="enum.ServiceId.html" title="enum libsignal_protocol::ServiceId">ServiceId</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl"><a href="#method.clone" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/clone/trait.Clone.html#tymethod.clone" class="fn">clone</a>(&amp;self) -&gt; <a class="enum" href="enum.ServiceId.html" title="enum libsignal_protocol::ServiceId">ServiceId</a></h4></section></summary><div class='docblock'>Returns a copy of the value. <a href="https://doc.rust-lang.org/1.84.0/core/clone/trait.Clone.html#tymethod.clone">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.84.0/src/core/clone.rs.html#174">Source</a></span><a href="#method.clone_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/clone/trait.Clone.html#method.clone_from" class="fn">clone_from</a>(&amp;mut self, source: &amp;Self)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/1.84.0/core/clone/trait.Clone.html#method.clone_from">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Debug-for-ServiceId" class="impl"><a href="#impl-Debug-for-ServiceId" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="enum" href="enum.ServiceId.html" title="enum libsignal_protocol::ServiceId">ServiceId</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl"><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/1.84.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>&lt;'_&gt;) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/1.84.0/core/fmt/struct.Error.html" title="struct core::fmt::Error">Error</a>&gt;</h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.84.0/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-From%3CSpecificServiceId%3Clibsignal_core::::address::Aci::%7Bconstant%230%7D%3E%3E-for-ServiceId" class="impl"><a href="#impl-From%3CSpecificServiceId%3Clibsignal_core::::address::Aci::%7Bconstant%230%7D%3E%3E-for-ServiceId" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;SpecificServiceId&lt;libsignal_core::::address::Aci::{constant#0}&gt;&gt; for <a class="enum" href="enum.ServiceId.html" title="enum libsignal_protocol::ServiceId">ServiceId</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(
aci: SpecificServiceId&lt;libsignal_core::::address::Aci::{constant#0}&gt;,
) -&gt; <a class="enum" href="enum.ServiceId.html" title="enum libsignal_protocol::ServiceId">ServiceId</a></h4></section></summary><div class='docblock'>Converts to this type from the input type.</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-From%3CSpecificServiceId%3Clibsignal_core::::address::Pni::%7Bconstant%230%7D%3E%3E-for-ServiceId" class="impl"><a href="#impl-From%3CSpecificServiceId%3Clibsignal_core::::address::Pni::%7Bconstant%230%7D%3E%3E-for-ServiceId" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;SpecificServiceId&lt;libsignal_core::::address::Pni::{constant#0}&gt;&gt; for <a class="enum" href="enum.ServiceId.html" title="enum libsignal_protocol::ServiceId">ServiceId</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from-1" class="method trait-impl"><a href="#method.from-1" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(
Expand Down
8 changes: 4 additions & 4 deletions libsignal_protocol/error/enum.SignalProtocolError.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@
InvalidKyberPreKeyId,
InvalidMacKeyLength(<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>),
NoSenderKeyState {
distribution_id: <a class="struct" href="https://docs.rs/uuid/1.12.0/uuid/struct.Uuid.html" title="struct uuid::Uuid">Uuid</a>,
distribution_id: <a class="struct" href="https://docs.rs/uuid/1.12.1/uuid/struct.Uuid.html" title="struct uuid::Uuid">Uuid</a>,
},
SessionNotFound(<a class="struct" href="../struct.ProtocolAddress.html" title="struct libsignal_protocol::ProtocolAddress">ProtocolAddress</a>),
InvalidSessionStructure(&amp;'static <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.str.html">str</a>),
InvalidSenderKeySession {
distribution_id: <a class="struct" href="https://docs.rs/uuid/1.12.0/uuid/struct.Uuid.html" title="struct uuid::Uuid">Uuid</a>,
distribution_id: <a class="struct" href="https://docs.rs/uuid/1.12.1/uuid/struct.Uuid.html" title="struct uuid::Uuid">Uuid</a>,
},
InvalidRegistrationId(<a class="struct" href="../struct.ProtocolAddress.html" title="struct libsignal_protocol::ProtocolAddress">ProtocolAddress</a>, <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u32.html">u32</a>),
DuplicatedMessage(<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u32.html">u32</a>, <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u32.html">u32</a>),
Expand Down Expand Up @@ -56,10 +56,10 @@
</div><section id="variant.InvalidKyberPreKeyId" class="variant"><a href="#variant.InvalidKyberPreKeyId" class="anchor">§</a><h3 class="code-header">InvalidKyberPreKeyId</h3></section><div class="docblock"><p>invalid Kyber prekey identifier</p>
</div><section id="variant.InvalidMacKeyLength" class="variant"><a href="#variant.InvalidMacKeyLength" class="anchor">§</a><h3 class="code-header">InvalidMacKeyLength(<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>)</h3></section><div class="docblock"><p>invalid MAC key length &lt;{0}&gt;</p>
</div><section id="variant.NoSenderKeyState" class="variant"><a href="#variant.NoSenderKeyState" class="anchor">§</a><h3 class="code-header">NoSenderKeyState</h3></section><div class="docblock"><p>missing sender key state for distribution ID {distribution_id}</p>
</div><div class="sub-variant" id="variant.NoSenderKeyState.fields"><h4>Fields</h4><div class="sub-variant-field"><span id="variant.NoSenderKeyState.field.distribution_id" class="section-header"><a href="#variant.NoSenderKeyState.field.distribution_id" class="anchor field">§</a><code>distribution_id: <a class="struct" href="https://docs.rs/uuid/1.12.0/uuid/struct.Uuid.html" title="struct uuid::Uuid">Uuid</a></code></span></div></div><section id="variant.SessionNotFound" class="variant"><a href="#variant.SessionNotFound" class="anchor">§</a><h3 class="code-header">SessionNotFound(<a class="struct" href="../struct.ProtocolAddress.html" title="struct libsignal_protocol::ProtocolAddress">ProtocolAddress</a>)</h3></section><div class="docblock"><p>session with {0} not found</p>
</div><div class="sub-variant" id="variant.NoSenderKeyState.fields"><h4>Fields</h4><div class="sub-variant-field"><span id="variant.NoSenderKeyState.field.distribution_id" class="section-header"><a href="#variant.NoSenderKeyState.field.distribution_id" class="anchor field">§</a><code>distribution_id: <a class="struct" href="https://docs.rs/uuid/1.12.1/uuid/struct.Uuid.html" title="struct uuid::Uuid">Uuid</a></code></span></div></div><section id="variant.SessionNotFound" class="variant"><a href="#variant.SessionNotFound" class="anchor">§</a><h3 class="code-header">SessionNotFound(<a class="struct" href="../struct.ProtocolAddress.html" title="struct libsignal_protocol::ProtocolAddress">ProtocolAddress</a>)</h3></section><div class="docblock"><p>session with {0} not found</p>
</div><section id="variant.InvalidSessionStructure" class="variant"><a href="#variant.InvalidSessionStructure" class="anchor">§</a><h3 class="code-header">InvalidSessionStructure(&amp;'static <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.str.html">str</a>)</h3></section><div class="docblock"><p>invalid session: {0}</p>
</div><section id="variant.InvalidSenderKeySession" class="variant"><a href="#variant.InvalidSenderKeySession" class="anchor">§</a><h3 class="code-header">InvalidSenderKeySession</h3></section><div class="docblock"><p>invalid sender key session with distribution ID {distribution_id}</p>
</div><div class="sub-variant" id="variant.InvalidSenderKeySession.fields"><h4>Fields</h4><div class="sub-variant-field"><span id="variant.InvalidSenderKeySession.field.distribution_id" class="section-header"><a href="#variant.InvalidSenderKeySession.field.distribution_id" class="anchor field">§</a><code>distribution_id: <a class="struct" href="https://docs.rs/uuid/1.12.0/uuid/struct.Uuid.html" title="struct uuid::Uuid">Uuid</a></code></span></div></div><section id="variant.InvalidRegistrationId" class="variant"><a href="#variant.InvalidRegistrationId" class="anchor">§</a><h3 class="code-header">InvalidRegistrationId(<a class="struct" href="../struct.ProtocolAddress.html" title="struct libsignal_protocol::ProtocolAddress">ProtocolAddress</a>, <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u32.html">u32</a>)</h3></section><div class="docblock"><p>session for {0} has invalid registration ID {1:X}</p>
</div><div class="sub-variant" id="variant.InvalidSenderKeySession.fields"><h4>Fields</h4><div class="sub-variant-field"><span id="variant.InvalidSenderKeySession.field.distribution_id" class="section-header"><a href="#variant.InvalidSenderKeySession.field.distribution_id" class="anchor field">§</a><code>distribution_id: <a class="struct" href="https://docs.rs/uuid/1.12.1/uuid/struct.Uuid.html" title="struct uuid::Uuid">Uuid</a></code></span></div></div><section id="variant.InvalidRegistrationId" class="variant"><a href="#variant.InvalidRegistrationId" class="anchor">§</a><h3 class="code-header">InvalidRegistrationId(<a class="struct" href="../struct.ProtocolAddress.html" title="struct libsignal_protocol::ProtocolAddress">ProtocolAddress</a>, <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u32.html">u32</a>)</h3></section><div class="docblock"><p>session for {0} has invalid registration ID {1:X}</p>
</div><section id="variant.DuplicatedMessage" class="variant"><a href="#variant.DuplicatedMessage" class="anchor">§</a><h3 class="code-header">DuplicatedMessage(<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u32.html">u32</a>, <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u32.html">u32</a>)</h3></section><div class="docblock"><p>message with old counter {0} / {1}</p>
</div><section id="variant.InvalidMessage" class="variant"><a href="#variant.InvalidMessage" class="anchor">§</a><h3 class="code-header">InvalidMessage(<a class="enum" href="../enum.CiphertextMessageType.html" title="enum libsignal_protocol::CiphertextMessageType">CiphertextMessageType</a>, &amp;'static <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.str.html">str</a>)</h3></section><div class="docblock"><p>invalid {0:?} message: {1}</p>
</div><section id="variant.FfiBindingError" class="variant"><a href="#variant.FfiBindingError" class="anchor">§</a><h3 class="code-header">FfiBindingError(<a class="struct" href="https://doc.rust-lang.org/1.84.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>)</h3></section><div class="docblock"><p>error while invoking an ffi callback: {0}</p>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!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 `create_sender_key_distribution_message` fn in crate `libsignal_protocol`."><title>create_sender_key_distribution_message in libsignal_protocol - 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="libsignal_protocol" 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="sidebar-items.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 fn"><!--[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="../libsignal_protocol/index.html">libsignal_<wbr>protocol</a><span class="version">0.1.0</span></h2></div><div class="sidebar-elems"><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"><span class="rustdoc-breadcrumbs"><a href="index.html">libsignal_protocol</a></span><h1>Function <span class="fn">create_sender_key_distribution_message</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/libsignal_protocol/group_cipher.rs.html#229-286">Source</a> </span></div><pre class="rust item-decl"><code>pub async fn create_sender_key_distribution_message&lt;R: <a class="trait" href="https://rust-random.github.io/rand/rand/rng/trait.Rng.html" title="trait rand::rng::Rng">Rng</a> + <a class="trait" href="https://rust-random.github.io/rand/rand_core/trait.CryptoRng.html" title="trait rand_core::CryptoRng">CryptoRng</a>&gt;(
sender: &amp;<a class="struct" href="struct.ProtocolAddress.html" title="struct libsignal_protocol::ProtocolAddress">ProtocolAddress</a>,
distribution_id: <a class="struct" href="https://docs.rs/uuid/1.12.0/uuid/struct.Uuid.html" title="struct uuid::Uuid">Uuid</a>,
distribution_id: <a class="struct" href="https://docs.rs/uuid/1.12.1/uuid/struct.Uuid.html" title="struct uuid::Uuid">Uuid</a>,
sender_key_store: &amp;mut dyn <a class="trait" href="trait.SenderKeyStore.html" title="trait libsignal_protocol::SenderKeyStore">SenderKeyStore</a>,
csprng: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&amp;mut R</a>,
) -&gt; <a class="type" href="error/type.Result.html" title="type libsignal_protocol::error::Result">Result</a>&lt;<a class="struct" href="struct.SenderKeyDistributionMessage.html" title="struct libsignal_protocol::SenderKeyDistributionMessage">SenderKeyDistributionMessage</a>&gt;</code></pre></section></div></main></body></html>
Loading

0 comments on commit 605f628

Please sign in to comment.