<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><metaname="viewport"content="width=device-width, initial-scale=1.0"><metaname="generator"content="rustdoc"><metaname="description"content="API documentation for the Rust `SynchOpt` enum in crate `kanidm_cli`."><metaname="keywords"content="rust, rustlang, rust-lang, SynchOpt"><title>SynchOpt in kanidm_cli - Rust</title><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/SourceSerif4-Regular-1f7d512b176f0f72.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/SourceSerif4-Bold-124a1ca42af929b6.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><linkrel="stylesheet"href="../static.files/normalize-76eba96aa4d2e634.css"><linkrel="stylesheet"href="../static.files/rustdoc-6827029ac823cab7.css"id="mainThemeStyle"><linkrel="stylesheet"id="themeStyle"href="../static.files/light-ebce58d0a40c3431.css"><linkrel="stylesheet"disabledhref="../static.files/dark-f23faae4a2daf9a6.css"><linkrel="stylesheet"disabledhref="../static.files/ayu-8af5e100b21cd173.css"><scriptid="default-settings"></script><scriptsrc="../static.files/storage-d43fa987303ecbbb.js"></script><scriptdefersrc="sidebar-items.js"></script><scriptdefersrc="../static.files/main-c55e1eb52e1886b4.js"></script><noscript><linkrel="stylesheet"href="../static.files/noscript-13285aec31fa243e.css"></noscript><linkrel="alternate icon"type="image/png"href="../static.files/favicon-16x16-8b506e7a72182f1c.png"><linkrel="alternate icon"type="image/png"href="../static.files/favicon-32x32-422f7d1d52889060.png"><linkrel="icon"type="image/svg+xml"href="../static.files/favicon-2c020d218678b618.svg"></head><bodyclass="rustdoc enum"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="mobile-topbar"><buttonclass="sidebar-menu-toggle">☰</button><aclass="sidebar-logo"href="../kanidm_cli/index.html"><divclass="logo-container"><imgclass="rust-logo"src="../static.files/rust-logo-151179464ae7ed46.svg"alt="logo"></div></a><h2></h2></nav><navclass="sidebar"><aclass="sidebar-logo"href="../kanidm_cli/index.html"><divclass="logo-container"><imgclass="rust-logo"src="../static.files/rust-logo-151179464ae7ed46.svg"alt="logo"></div></a><h2class="location"><ahref="#">SynchOpt</a></h2><divclass="sidebar-elems"><section><h3><ahref="#variants">Variants</a></h3><ulclass="block"><li><ahref="#variant.Create">Create</a></li><li><ahref="#variant.DestroyToken">DestroyToken</a></li><li><ahref="#variant.Finalise">Finalise</a></li><li><ahref="#variant.ForceRefresh">ForceRefresh</a></li><li><ahref="#variant.GenerateToken">GenerateToken</a></li><li><ahref="#variant.Get">Get</a></li><li><ahref="#variant.List">List</a></li><li><ahref="#variant.Terminate">Terminate</a></li></ul><h3><ahref="#implementations">Methods</a></h3><ulclass="block"><li><ahref="#method.debug">debug</a></li><li><ahref="#method.exec">exec</a></li></ul><h3><ahref="#trait-implementations">Trait Implementations</a></h3><ulclass="block"><li><ahref="#impl-Debug-for-SynchOpt">Debug</a></li><li><ahref="#impl-FromArgMatches-for-SynchOpt">FromArgMatches</a></li><li><ahref="#impl-Subcommand-for-SynchOpt">Subcommand</a></li></ul><h3><ahref="#synthetic-implementations">Auto Trait Implementations</a></h3><ulclass="block"><li><ahref="#impl-RefUnwindSafe-for-SynchOpt">RefUnwindSafe</a></li><li><ahref="#impl-Send-for-SynchOpt">Send</a></li><li><ahref="#impl-Sync-for-SynchOpt">Sync</a></li><li><ahref="#impl
</div><sectionid="variant.Create"class="variant"><ahref="#variant.Create"class="anchor">§</a><h3class="code-header">Create</h3></section><divclass="sub-variant"id="variant.Create.fields"><h4>Fields</h4><divclass="sub-variant-field"><spanid="variant.Create.field.account_id"class="small-section-header"><ahref="#variant.Create.field.account_id"class="anchor field">§</a><code>account_id: <aclass="struct"href="https://doc.rust-lang.org/1.67.1/alloc/string/struct.String.html"title="struct alloc::string::String">String</a></code></span></div><divclass="sub-variant-field"><spanid="variant.Create.field.copt"class="small-section-header"><ahref="#variant.Create.field.copt"class="anchor field">§</a><code>copt: <aclass="struct"href="struct.CommonOpt.html"title="struct kanidm_cli::CommonOpt">CommonOpt</a></code></span></div><divclass="sub-variant-field"><spanid="variant.Create.field.description"class="small-section-header"><ahref="#variant.Create.field.description"class="anchor field">§</a><code>description: <aclass="enum"href="https://doc.rust-lang.org/1.67.1/core/option/enum.Option.html"title="enum core::option::Option">Option</a><<aclass="struct"href="https://doc.rust-lang.org/1.67.1/alloc/string/struct.String.html"title="struct alloc::string::String">String</a>></code></span></div></div><divclass="docblock"><p>Create a new IDM sync account</p>
</div><sectionid="variant.GenerateToken"class="variant"><ahref="#variant.GenerateToken"class="anchor">§</a><h3class="code-header">GenerateToken</h3></section><divclass="sub-variant"id="variant.GenerateToken.fields"><h4>Fields</h4><divclass="sub-variant-field"><spanid="variant.GenerateToken.field.account_id"class="small-section-header"><ahref="#variant.GenerateToken.field.account_id"class="anchor field">§</a><code>account_id: <aclass="struct"href="https://doc.rust-lang.org/1.67.1/alloc/string/struct.String.html"title="struct alloc::string::String">String</a></code></span></div><divclass="sub-variant-field"><spanid="variant.GenerateToken.field.label"class="small-section-header"><ahref="#variant.GenerateToken.field.label"class="anchor field">§</a><code>label: <aclass="struct"href="https://doc.rust-lang.org/1.67.1/alloc/string/struct.String.html"title="struct alloc::string::String">String</a></code></span></div><divclass="sub-variant-field"><spanid="variant.GenerateToken.field.copt"class="small-section-header"><ahref="#variant.GenerateToken.field.copt"class="anchor field">§</a><code>copt: <aclass="struct"href="struct.CommonOpt.html"title="struct kanidm_cli::CommonOpt">CommonOpt</a></code></span></div></div><divclass="docblock"><p>Generate a bearer token for an IDM sync account</p>
</div><sectionid="variant.DestroyToken"class="variant"><ahref="#variant.DestroyToken"class="anchor">§</a><h3class="code-header">DestroyToken</h3></section><divclass="sub-variant"id="variant.DestroyToken.fields"><h4>Fields</h4><divclass="sub-variant-field"><spanid="variant.DestroyToken.field.account_id"class="small-section-header"><ahref="#variant.DestroyToken.field.account_id"class="anchor field">§</a><code>account_id: <aclass="struct"href="https://doc.rust-lang.org/1.67.1/alloc/string/struct.String.html"title="struct alloc::string::String">String</a></code></span></div><divclass="sub-variant-field"><spanid="variant.DestroyToken.field.copt"class="small-section-header"><ahref="#variant.DestroyToken.field.copt"class="anchor field">§</a><code>copt: <aclass="struct"href="struct.CommonOpt.html"title="struct kanidm_cli::CommonOpt">CommonOpt</a></code></span></div></div><divclass="docblock"><p>Destroy (revoke) the bearer token for an IDM sync account</p>
</div><sectionid="variant.ForceRefresh"class="variant"><ahref="#variant.ForceRefresh"class="anchor">§</a><h3class="code-header">ForceRefresh</h3></section><divclass="sub-variant"id="variant.ForceRefresh.fields"><h4>Fields</h4><divclass="sub-variant-field"><spanid="variant.ForceRefresh.field.account_id"class="small-section-header"><ahref="#variant.ForceRefresh.field.account_id"class="anchor field">§</a><code>account_id: <aclass="struct"href="https://doc.rust-lang.org/1.67.1/alloc/string/struct.String.html"title="struct alloc::string::String">String</a></code></span></div><divclass="sub-variant-field"><spanid="variant.ForceRefresh.field.copt"class="small-section-header"><ahref="#variant.ForceRefresh.field.copt"class="anchor field">§</a><code>copt: <aclass="struct"href="struct.CommonOpt.html"title="struct kanidm_cli::CommonOpt">CommonOpt</a></code></span></div></div><divclass="docblock"><p>Reset the sync cookie of this connector, so that on the next operation of the sync tool
</div><sectionid="variant.Finalise"class="variant"><ahref="#variant.Finalise"class="anchor">§</a><h3class="code-header">Finalise</h3></section><divclass="sub-variant"id="variant.Finalise.fields"><h4>Fields</h4><divclass="sub-variant-field"><spanid="variant.Finalise.field.account_id"class="small-section-header"><ahref="#variant.Finalise.field.account_id"class="anchor field">§</a><code>account_id: <aclass="struct"href="https://doc.rust-lang.org/1.67.1/alloc/string/struct.String.html"title="struct alloc::string::String">String</a></code></span></div><divclass="sub-variant-field"><spanid="variant.Finalise.field.copt"class="small-section-header"><ahref="#variant.Finalise.field.copt"class="anchor field">§</a><code>copt: <aclass="struct"href="struct.CommonOpt.html"title="struct kanidm_cli::CommonOpt">CommonOpt</a></code></span></div></div><divclass="docblock"><p>Finalise and remove this sync account. This will transfer all synchronised entries into
</div><sectionid="variant.Terminate"class="variant"><ahref="#variant.Terminate"class="anchor">§</a><h3class="code-header">Terminate</h3></section><divclass="sub-variant"id="variant.Terminate.fields"><h4>Fields</h4><divclass="sub-variant-field"><spanid="variant.Terminate.field.account_id"class="small-section-header"><ahref="#variant.Terminate.field.account_id"class="anchor field">§</a><code>account_id: <aclass="struct"href="https://doc.rust-lang.org/1.67.1/alloc/string/struct.String.html"title="struct alloc::string::String">String</a></code></span></div><divclass="sub-variant-field"><spanid="variant.Terminate.field.copt"class="small-section-header"><ahref="#variant.Terminate.field.copt"class="anchor field">§</a><code>copt: <aclass="struct"href="struct.CommonOpt.html"title="struct kanidm_cli::CommonOpt">CommonOpt</a></code></span></div></div><divclass="docblock"><p>Terminate and remove this sync account. This will DELETE all entries that were imported
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"><summary><sectionid="impl-Instrument-for-SynchOpt"class="impl has-srclink"><aclass="srclink rightside"href="https://docs.rs/tracing/0.1.37/src/tracing/instrument.rs.html#276">source</a><ahref="#impl-Instrument-for-SynchOpt"class="anchor">§</a><h3class="code-header">impl<T><aclass="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><divclass="impl-items"><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.instrument"class="method trait-impl has-srclink"><aclass="srclink rightside"href="https://docs.rs/tracing/0.1.37/src/tracing/instrument.rs.html#82">source</a><ahref="#method.instrument"class="anchor">§</a><h4class="code-header">fn <ahref="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.Instrument.html#method.instrument"class="fn">instrument</a>(self, span: <aclass="struct"href="https://docs.rs/tracing/0.1.37/tracing/span/struct.Span.html"title="struct tracing::span::Span">Span</a>) -><aclass="struct"href="https://docs.rs/tracing/0.1.37/tracing/instrument/struct.Instrumented.html"title="struct tracing::instrument::Instrumented">Instrumented</a><Self></h4></section></summary><divclass='docblock'>Instruments this type with the provided <ahref="https://docs.rs/tracing/0.1.37/tracing/span/struct.Span.html"title="Span"><code>Span</code></a>, returning an
<code>Instrumented</code> wrapper. <ahref="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.Instrument.html#method.instrument">Read more</a></div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.in_current_span"class="method trait-impl has-srclink"><aclass="srclink rightside"href="https://docs.rs/tracing/0.1.37/src/tracing/instrument.rs.html#121">source</a><ahref="#method.in_current_span"class="anchor">§</a><h4class="code-header">fn <ahref="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.Instrument.html#method.in_current_span"class="fn">in_current_span</a>(self) -><aclass="struct"href="https://docs.rs/tracing/0.1.37/tracing/instrument/struct.Instrumented.html"title="struct tracing::instrument::Instrumented">Instrumented</a><Self></h4></section></summary><divclass='docblock'>Instruments this type with the <ahref="https://docs.rs/tracing/0.1.37/tracing/span/struct.Span.html#method.current">current</a><ahref="https://docs.rs/tracing/0.1.37/tracing/span/struct.Span.html"><code>Span</code></a>, returning an
<ahref="https://docs.rs/tracing/0.1.37/tracing/instrument/struct.WithDispatch.html"title="WithDispatch"><code>WithDispatch</code></a> wrapper. <ahref="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.WithSubscriber.html#method.with_subscriber">Read more</a></div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.with_current_subscriber"class="method trait-impl has-srclink"><aclass="srclink rightside"href="https://docs.rs/tracing/0.1.37/src/tracing/instrument.rs.html#221">source</a><ahref="#method.with_current_subscriber"class="anchor">§</a><h4class="code-header">fn <ahref="https://docs.rs/tracing/0.1.37/tracing/instrument/trait.WithSubscriber.html#method.with_current_subscriber"class="fn">with_current_subscriber</a>(self) -><aclass="struct"href="https://docs.rs/tracing/0.1.37/tracing/instrument/struct.WithDispatch.html"title="struct tracing::instrument::WithDispatch">WithDispatch</a><Self></h4></section></summary><divclass='docblock'>Attaches the current <ahref="https://docs.rs/tracing/0.1.37/tracing/dispatcher/index.html#setting-the-default-subscriber">default</a><ahref="https://docs.rs/tracing-core/0.1.22/tracing_core/subscriber/trait.Subscriber.html"><code>Subscriber</code></a> to this type, returning a
