kanidm/docs/stable/rustdoc/kanidm_proto/v1/enum.CURequest.html

22 lines
40 KiB
HTML
Raw Normal View History

<!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 `CURequest` enum in crate `kanidm_proto`."><meta name="keywords" content="rust, rustlang, rust-lang, CURequest"><title>CURequest in kanidm_proto::v1 - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-1f7d512b176f0f72.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Bold-124a1ca42af929b6.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-93196c7a1c3542a8.css" id="mainThemeStyle"><link rel="stylesheet" id="themeStyle" href="../../static.files/light-4743e13df3dfe8c4.css"><link rel="stylesheet" disabled href="../../static.files/dark-0e1b889528bd466b.css"><link rel="stylesheet" disabled href="../../static.files/ayu-65289d5d067c7c66.css"><script id="default-settings" ></script><script src="../../static.files/storage-d43fa987303ecbbb.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-3367e395607fafc1.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-13285aec31fa243e.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc enum"><!--[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">&#9776;</button><a class="logo-container" href="../../kanidm_proto/index.html"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2></h2></nav><nav class="sidebar"><a class="logo-container" href="../../kanidm_proto/index.html"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2 class="location"><a href="#">CURequest</a></h2><div class="sidebar-elems"><section><h3><a href="#variants">Variants</a></h3><ul class="block"><li><a href="#variant.BackupCodeGenerate">BackupCodeGenerate</a></li><li><a href="#variant.BackupCodeRemove">BackupCodeRemove</a></li><li><a href="#variant.CancelMFAReg">CancelMFAReg</a></li><li><a href="#variant.PasskeyFinish">PasskeyFinish</a></li><li><a href="#variant.PasskeyInit">PasskeyInit</a></li><li><a href="#variant.PasskeyRemove">PasskeyRemove</a></li><li><a href="#variant.Password">Password</a></li><li><a href="#variant.PrimaryRemove">PrimaryRemove</a></li><li><a href="#variant.TotpAcceptSha1">TotpAcceptSha1</a></li><li><a href="#variant.TotpGenerate">TotpGenerate</a></li><li><a href="#variant.TotpRemove">TotpRemove</a></li><li><a href="#variant.TotpVerify">TotpVerify</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Debug-for-CURequest">Debug</a></li><li><a href="#impl-Deserialize%3C%27de%3E-for-CURequest">Deserialize&lt;&#39;de&gt;</a></li><li><a href="#impl-Serialize-for-CURequest">Serialize</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a
PrimaryRemove,
Password(<a class="struct" href="https://doc.rust-lang.org/1.68.2/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>),
CancelMFAReg,
TotpGenerate,
TotpVerify(<a class="primitive" href="https://doc.rust-lang.org/1.68.2/std/primitive.u32.html">u32</a>,&nbsp;<a class="struct" href="https://doc.rust-lang.org/1.68.2/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>),
TotpAcceptSha1,
TotpRemove(<a class="struct" href="https://doc.rust-lang.org/1.68.2/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>),
BackupCodeGenerate,
BackupCodeRemove,
PasskeyInit,
PasskeyFinish(<a class="struct" href="https://doc.rust-lang.org/1.68.2/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>,&nbsp;RegisterPublicKeyCredential),
PasskeyRemove(<a class="struct" href="https://docs.rs/uuid/1.3.1/uuid/struct.Uuid.html" title="struct uuid::Uuid">Uuid</a>),
}</code></pre></div><h2 id="variants" class="variants small-section-header">Variants<a href="#variants" class="anchor">§</a></h2><div class="variants"><section id="variant.PrimaryRemove" class="variant"><a href="#variant.PrimaryRemove" class="anchor">§</a><h3 class="code-header">PrimaryRemove</h3></section><section id="variant.Password" class="variant"><a href="#variant.Password" class="anchor">§</a><h3 class="code-header">Password(<a class="struct" href="https://doc.rust-lang.org/1.68.2/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>)</h3></section><section id="variant.CancelMFAReg" class="variant"><a href="#variant.CancelMFAReg" class="anchor">§</a><h3 class="code-header">CancelMFAReg</h3></section><section id="variant.TotpGenerate" class="variant"><a href="#variant.TotpGenerate" class="anchor">§</a><h3 class="code-header">TotpGenerate</h3></section><section id="variant.TotpVerify" class="variant"><a href="#variant.TotpVerify" class="anchor">§</a><h3 class="code-header">TotpVerify(<a class="primitive" href="https://doc.rust-lang.org/1.68.2/std/primitive.u32.html">u32</a>,&nbsp;<a class="struct" href="https://doc.rust-lang.org/1.68.2/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>)</h3></section><section id="variant.TotpAcceptSha1" class="variant"><a href="#variant.TotpAcceptSha1" class="anchor">§</a><h3 class="code-header">TotpAcceptSha1</h3></section><section id="variant.TotpRemove" class="variant"><a href="#variant.TotpRemove" class="anchor">§</a><h3 class="code-header">TotpRemove(<a class="struct" href="https://doc.rust-lang.org/1.68.2/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>)</h3></section><section id="variant.BackupCodeGenerate" class="variant"><a href="#variant.BackupCodeGenerate" class="anchor">§</a><h3 class="code-header">BackupCodeGenerate</h3></section><section id="variant.BackupCodeRemove" class="variant"><a href="#variant.BackupCodeRemove" class="anchor">§</a><h3 class="code-header">BackupCodeRemove</h3></section><section id="variant.PasskeyInit" class="variant"><a href="#variant.PasskeyInit" class="anchor">§</a><h3 class="code-header">PasskeyInit</h3></section><section id="variant.PasskeyFinish" class="variant"><a href="#variant.PasskeyFinish" class="anchor">§</a><h3 class="code-header">PasskeyFinish(<a class="struct" href="https://doc.rust-lang.org/1.68.2/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>,&nbsp;RegisterPublicKeyCredential)</h3></section><section id="variant.PasskeyRemove" class="variant"><a href="#variant.PasskeyRemove" class="anchor">§</a><h3 class="code-header">PasskeyRemove(<a class="struct" href="https://docs.rs/uuid/1.3.1/uuid/struct.Uuid.html" title="struct uuid::Uuid">Uuid</a>)</h3></section></div><h2 id="trait-implementations" class="small-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-Debug-for-CURequest" class="impl has-srclink"><a class="srclink rightside" href="../../src/kanidm_proto/v1.rs.html#1128-1146">source</a><a href="#impl-Debug-for-CURequest" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.68.2/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="enum" href="enum.CURequest.html" title="enum kanidm_proto::v1::CURequest">CURequest</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/kanidm_proto/v1.rs.html#1129-1145">source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.68.2/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.68.2/core/fmt/struct.Formatter.html" title="struct core::fmt:
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Instrument-for-CURequest" class="impl has-srclink"><a class="srclink rightside" href="https://docs.rs/tracing/0.1.37/src/tracing/instrument.rs.html#276">source</a><a href="#impl-Instrument-for-CURequest" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.Instrument.html" title="trait tracing::instrument::Instrument">Instrument</a> for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.instrument" class="method trait-impl has-srclink"><a class="srclink rightside" href="https://docs.rs/tracing/0.1.37/src/tracing/instrument.rs.html#82">source</a><a href="#method.instrument" class="anchor">§</a><h4 class="code-header">fn <a href="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.Instrument.html#method.instrument" class="fn">instrument</a>(self, span: <a class="struct" href="https://docs.rs/tracing/0.1.37/tracing/span/struct.Span.html" title="struct tracing::span::Span">Span</a>) -&gt; <a class="struct" href="https://docs.rs/tracing/0.1.37/tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a>&lt;Self&gt;</h4></section></summary><div class='docblock'>Instruments this type with the provided <a href="https://docs.rs/tracing/0.1.37/tracing/span/struct.Span.html" title="Span"><code>Span</code></a>, returning an
<code>Instrumented</code> wrapper. <a href="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.Instrument.html#method.instrument">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.in_current_span" class="method trait-impl has-srclink"><a class="srclink rightside" href="https://docs.rs/tracing/0.1.37/src/tracing/instrument.rs.html#121">source</a><a href="#method.in_current_span" class="anchor">§</a><h4 class="code-header">fn <a href="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.Instrument.html#method.in_current_span" class="fn">in_current_span</a>(self) -&gt; <a class="struct" href="https://docs.rs/tracing/0.1.37/tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a>&lt;Self&gt;</h4></section></summary><div class='docblock'>Instruments this type with the <a href="https://docs.rs/tracing/0.1.37/tracing/span/struct.Span.html#method.current">current</a> <a href="https://docs.rs/tracing/0.1.37/tracing/span/struct.Span.html"><code>Span</code></a>, returning an
<code>Instrumented</code> wrapper. <a href="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.Instrument.html#method.in_current_span">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-CURequest" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/1.68.2/src/core/convert/mod.rs.html#717">source</a><a href="#impl-Into%3CU%3E-for-CURequest" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.68.2/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: <a class="trait" href="https://doc.rust-lang.org/1.68.2/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.68.2/src/core/convert/mod.rs.html#725">source</a></span><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.68.2/core/convert/trait.Into.html#tymethod.into" class="fn">into</a>(self) -&gt; U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
<p>That is, this conversion is whatever the implementation of
<code><a href="https://doc.rust-lang.org/1.68.2/core/convert/trait.From.html" title="From">From</a>&lt;T&gt; for U</code> chooses to do.</p>
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Serialize-for-CURequest-1" class="impl has-srclink"><a class="srclink rightside" href="https://docs.rs/erased-serde/0.3.24/src/erased_serde/ser.rs.html#238">source</a><a href="#impl-Serialize-for-CURequest-1" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://docs.rs/erased-serde/0.3.24/erased_serde/ser/trait.Serialize.html" title="trait erased_serde::ser::Serialize">Serialize</a> for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="https://docs.rs/serde/1.0.160/serde/ser/trait.Serialize.html" title="trait serde::ser::Serialize">Serialize</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.68.2/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</span></h3></section></summary><div class="impl-items"><section id="method.erased_serialize" class="method trait-impl has-srclink"><a class="srclink rightside" href="https://docs.rs/erased-serde/0.3.24/src/erased_serde/ser.rs.html#242">source</a><a href="#method.erased_serialize" class="anchor">§</a><h4 class="code-header">fn <a href="https://docs.rs/erased-serde/0.3.24/erased_serde/ser/trait.Serialize.html#tymethod.erased_serialize" class="fn">erased_serialize</a>(&amp;self, serializer: &amp;mut dyn <a class="trait" href="https://docs.rs/erased-serde/0.3.24/erased_serde/ser/trait.Serializer.html" title="trait erased_serde::ser::Serializer">Serializer</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.68.2/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;Ok, <a class="struct" href="https://docs.rs/erased-serde/0.3.24/erased_serde/error/struct.Error.html" title="struct erased_serde::error::Error">Error</a>&gt;</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-CURequest" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/1.68.2/src/core/convert/mod.rs.html#775">source</a><a href="#impl-TryFrom%3CU%3E-for-CURequest" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.68.2/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: <a class="trait" href="https://doc.rust-lang.org/1.68.2/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.68.2/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.68.2/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.68.2/src/core/convert/mod.rs.html#781">source</a></span><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.68.2/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.68.2/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, &lt;T as <a class="trait" href="https://doc.rust-lang.org/1.68.2/core/convert/trait.TryFrom.html" title="trait core:
<a href="https://docs.rs/tracing/0.1.37/tracing/instrument/struct.WithDispatch.html" title="WithDispatch"><code>WithDispatch</code></a> wrapper. <a href="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.WithSubscriber.html#method.with_subscriber">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.with_current_subscriber" class="method trait-impl has-srclink"><a class="srclink rightside" href="https://docs.rs/tracing/0.1.37/src/tracing/instrument.rs.html#221">source</a><a href="#method.with_current_subscriber" class="anchor">§</a><h4 class="code-header">fn <a href="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.WithSubscriber.html#method.with_current_subscriber" class="fn">with_current_subscriber</a>(self) -&gt; <a class="struct" href="https://docs.rs/tracing/0.1.37/tracing/instrument/struct.WithDispatch.html" title="struct tracing::instrument::WithDispatch">WithDispatch</a>&lt;Self&gt;</h4></section></summary><div class='docblock'>Attaches the current <a href="https://docs.rs/tracing/0.1.37/tracing/dispatcher/index.html#setting-the-default-subscriber">default</a> <a href="https://docs.rs/tracing-core/0.1.22/tracing_core/subscriber/trait.Subscriber.html"><code>Subscriber</code></a> to this type, returning a
<a href="https://docs.rs/tracing/0.1.37/tracing/instrument/struct.WithDispatch.html" title="WithDispatch"><code>WithDispatch</code></a> wrapper. <a href="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.WithSubscriber.html#method.with_current_subscriber">Read more</a></div></details></div></details><section id="impl-DeserializeOwned-for-CURequest" class="impl has-srclink"><a class="srclink rightside" href="https://docs.rs/serde/1.0.160/src/serde/de/mod.rs.html#604">source</a><a href="#impl-DeserializeOwned-for-CURequest" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://docs.rs/serde/1.0.160/serde/de/trait.DeserializeOwned.html" title="trait serde::de::DeserializeOwned">DeserializeOwned</a> for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: for&lt;'de&gt; <a class="trait" href="https://docs.rs/serde/1.0.160/serde/de/trait.Deserialize.html" title="trait serde::de::Deserialize">Deserialize</a>&lt;'de&gt;,</span></h3></section></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="kanidm_proto" data-themes="" data-resource-suffix="" data-rustdoc-version="1.68.2 (9eb3afe9e 2023-03-27)" data-search-js="search-98d53477a794af0b.js" data-settings-js="settings-c3c521c753752a1a.js" data-settings-css="settings-08ddfdda51b8ee2e.css" ></div></body></html>