2022-11-04 01:07:22 +01:00
<!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 `BasicMessage` struct in crate `kanidm_proto`." > < meta name = "keywords" content = "rust, rustlang, rust-lang, BasicMessage" > < title > BasicMessage in kanidm_proto::messages - Rust< / title > < link rel = "preload" as = "font" type = "font/woff2" crossorigin href = "../../SourceSerif4-Regular.ttf.woff2" > < link rel = "preload" as = "font" type = "font/woff2" crossorigin href = "../../FiraSans-Regular.woff2" > < link rel = "preload" as = "font" type = "font/woff2" crossorigin href = "../../FiraSans-Medium.woff2" > < link rel = "preload" as = "font" type = "font/woff2" crossorigin href = "../../SourceCodePro-Regular.ttf.woff2" > < link rel = "preload" as = "font" type = "font/woff2" crossorigin href = "../../SourceSerif4-Bold.ttf.woff2" > < link rel = "preload" as = "font" type = "font/woff2" crossorigin href = "../../SourceCodePro-Semibold.ttf.woff2" > < link rel = "stylesheet" href = "../../normalize.css" > < link rel = "stylesheet" href = "../../rustdoc.css" id = "mainThemeStyle" > < link rel = "stylesheet" href = "../../ayu.css" disabled > < link rel = "stylesheet" href = "../../dark.css" disabled > < link rel = "stylesheet" href = "../../light.css" id = "themeStyle" > < script id = "default-settings" > < / script > < script src = "../../storage.js" > < / script > < script defer src = "sidebar-items.js" > < / script > < script defer src = "../../main.js" > < / script > < noscript > < link rel = "stylesheet" href = "../../noscript.css" > < / noscript > < link rel = "alternate icon" type = "image/png" href = "../../favicon-16x16.png" > < link rel = "alternate icon" type = "image/png" href = "../../favicon-32x32.png" > < link rel = "icon" type = "image/svg+xml" href = "../../favicon.svg" > < / head > < body class = "rustdoc struct" > <!-- [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" > ☰ < / button > < a class = "sidebar-logo" href = "../../kanidm_proto/index.html" > < div class = "logo-container" > < img class = "rust-logo" src = "../../rust-logo.svg" alt = "logo" > < / div > < / a > < h2 class = "location" > < / h2 > < / nav > < nav class = "sidebar" > < a class = "sidebar-logo" href = "../../kanidm_proto/index.html" > < div class = "logo-container" > < img class = "rust-logo" src = "../../rust-logo.svg" alt = "logo" > < / div > < / a > < h2 class = "location" > < a href = "#" > BasicMessage< / a > < / h2 > < div class = "sidebar-elems" > < section > < div class = "block" > < h3 class = "sidebar-title" > < a href = "#fields" > Fields< / a > < / h3 > < ul > < li > < a href = "#structfield.action" > action< / a > < / li > < li > < a href = "#structfield.output_mode" > output_mode< / a > < / li > < li > < a href = "#structfield.result" > result< / a > < / li > < li > < a href = "#structfield.status" > status< / a > < / li > < / ul > < / div > < div class = "block" > < h3 class = "sidebar-title" > < a href = "#trait-implementations" > Trait Implementations< / a > < / h3 > < ul > < li > < a href = "#impl-Debug-for-BasicMessage" > Debug< / a > < / li > < li > < a href = "#impl-Default-for-BasicMessage" > Default< / a > < / li > < li > < a href = "#impl-Deserialize%3C%27de%3E-for-BasicMessage" > Deserialize< ' de> < / a > < / li > < li > < a href = "#impl-Display-for-BasicMessage" > Display< / a > < / li > < li > < a href = "#impl-Serialize-for-BasicMessage" > Serialize< / a > < / li > < / ul > < / div > < div class = "block" > < h3 class = "sidebar-title" > < a href = "#synthetic-implementations" > Auto Trait Implementations< / a > < / h3 > < ul > < li > < a href = "#impl-RefUnwindSafe-for-BasicMessage" > RefUnwindSafe< / a > < / li > < li > < a href = "#impl-Send-for-BasicMessage" > Send< / a > < / li > < li > < a href = "#impl-Sync-for-BasicMessage" > Sync< / a > < / li > < li > < a href = "#impl-Unpin-for-BasicMessage" > Unpin< / a > < / li > < li > < a href = "#impl-UnwindSafe-for-BasicMessage" > UnwindSafe< / a > < / li > < / ul > < / div > < div class = "block" > < h3 class = "sidebar-title" > < a href = "#blanket-implementations" > Blanket Implementations< / a > < / h3 > < ul > < li > < a href = "#impl-Any-for-BasicMessage" > Any< / a > < / li > < li > < a href = "#impl-Borrow%3CT%3E-for-BasicMessage" > Borrow< T> < / a > < / li > < li > < a href = "#impl-BorrowMut%3CT%3E-for-BasicMessage" > BorrowMut< T> < / a > < / li > < li > < a href = "#impl-DeserializeOwned-for-BasicMessage" > DeserializeOwned< / a > < / li > < li > < a href = "#impl-Fro
2022-10-07 11:23:12 +02:00
pub output_mode: < a class = "enum" href = "enum.ConsoleOutputMode.html" title = "enum kanidm_proto::messages::ConsoleOutputMode" > ConsoleOutputMode< / a > ,
2022-11-04 01:07:22 +01:00
pub action: < a class = "struct" href = "https://doc.rust-lang.org/1.65.0/alloc/string/struct.String.html" title = "struct alloc::string::String" > String< / a > ,
pub result: < a class = "struct" href = "https://doc.rust-lang.org/1.65.0/alloc/string/struct.String.html" title = "struct alloc::string::String" > String< / a > ,
2022-10-07 11:23:12 +02:00
pub status: < a class = "enum" href = "enum.MessageStatus.html" title = "enum kanidm_proto::messages::MessageStatus" > MessageStatus< / a > ,
2022-11-04 01:07:22 +01:00
}< / code > < / pre > < / div > < h2 id = "fields" class = "fields small-section-header" > Fields< a href = "#fields" class = "anchor" > < / a > < / h2 > < span id = "structfield.output_mode" class = "structfield small-section-header" > < a href = "#structfield.output_mode" class = "anchor field" > < / a > < code > output_mode: < a class = "enum" href = "enum.ConsoleOutputMode.html" title = "enum kanidm_proto::messages::ConsoleOutputMode" > ConsoleOutputMode< / a > < / code > < / span > < span id = "structfield.action" class = "structfield small-section-header" > < a href = "#structfield.action" class = "anchor field" > < / a > < code > action: < a class = "struct" href = "https://doc.rust-lang.org/1.65.0/alloc/string/struct.String.html" title = "struct alloc::string::String" > String< / a > < / code > < / span > < span id = "structfield.result" class = "structfield small-section-header" > < a href = "#structfield.result" class = "anchor field" > < / a > < code > result: < a class = "struct" href = "https://doc.rust-lang.org/1.65.0/alloc/string/struct.String.html" title = "struct alloc::string::String" > String< / a > < / code > < / span > < span id = "structfield.status" class = "structfield small-section-header" > < a href = "#structfield.status" class = "anchor field" > < / a > < code > status: < a class = "enum" href = "enum.MessageStatus.html" title = "enum kanidm_proto::messages::MessageStatus" > MessageStatus< / a > < / code > < / span > < 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 = "rustdoc-toggle implementors-toggle" open > < summary > < section id = "impl-Debug-for-BasicMessage" class = "impl has-srclink" > < a class = "srclink rightside" href = "../../src/kanidm_proto/messages.rs.html#164" > source< / a > < a href = "#impl-Debug-for-BasicMessage" class = "anchor" > < / a > < h3 class = "code-header in-band" > impl < a class = "trait" href = "https://doc.rust-lang.org/1.65.0/core/fmt/trait.Debug.html" title = "trait core::fmt::Debug" > Debug< / a > for < a class = "struct" href = "struct.BasicMessage.html" title = "struct kanidm_proto::messages::BasicMessage" > BasicMessage< / a > < / h3 > < / section > < / summary > < div class = "impl-items" > < details class = "rustdoc-toggle method-toggle" open > < summary > < section id = "method.fmt" class = "method trait-impl has-srclink" > < a class = "srclink rightside" href = "../../src/kanidm_proto/messages.rs.html#164" > source< / a > < a href = "#method.fmt" class = "anchor" > < / a > < h4 class = "code-header" > fn < a href = "https://doc.rust-lang.org/1.65.0/core/fmt/trait.Debug.html#tymethod.fmt" class = "fnname" > fmt< / a > (& self, f: & mut < a class = "struct" href = "https://doc.rust-lang.org/1.65.0/core/fmt/struct.Formatter.html" title = "struct core::fmt::Formatter" > Formatter< / a > < '_> ) -> < a class = "type" href = "https://doc.rust-lang.org/1.65.0/core/fmt/type.Result.html" title = "type core::fmt::Result" > Result< / a > < / h4 > < / section > < / summary > < div class = 'docblock' > Formats the value using the given formatter. < a href = "https://doc.rust-lang.org/1.65.0/core/fmt/trait.Debug.html#tymethod.fmt" > Read more< / a > < / div > < / details > < / div > < / details > < details class = "rustdoc-toggle implementors-toggle" open > < summary > < section id = "impl-Default-for-BasicMessage" class = "impl has-srclink" > < a class = "srclink rightside" href = "../../src/kanidm_proto/messages.rs.html#173-182" > source< / a > < a href = "#impl-Default-for-BasicMessage" class = "anchor" > < / a > < h3 class = "code-header in-band" > impl < a class = "trait" href = "https://doc.rust-lang.org/1.65.0/core/default/trait.Default.html" title = "trait core::default::Default" > Default< / a > for < a class = "struct" href = "struct.BasicMessage.html" title = "struct kanidm_proto::messages::BasicMessage" > BasicMessage< / a > < / h3 > < / section > < / summary > < div class = "impl-items" > < details class = "rustdoc-toggle method-toggle" open > < summary > < section id = "method.default" class = "method trait-impl has-srclink" > < a class = "srclink rightside" href = "../../src/kanidm_proto/messages.rs.html#174-181" > source< / a > < a href = "#method.default" class = "anchor" > < / a > < h4 class = "code-header" > fn < a href = "https://doc.rust-lang.org/1.65.0/core/default/trait.Default.html#tymethod.default" class = "fnname" > default< / a > () -> Self< / h4 > < / section > < / summary > < div class = 'docblock' > Returns the “default valu
2022-10-07 11:23:12 +02:00
2022-11-04 01:07:22 +01:00
< div class = "example-wrap" > < pre class = "rust rust-example-rendered" > < code > < span class = "kw" > use < / span > kanidm_proto::messages::< span class = "kw-2" > *< / span > ;
< span class = "kw" > use < / span > std::fmt::format;
< span class = "kw" > let < / span > < span class = "kw-2" > mut < / span > msg = BasicMessage::default();
msg.action = String::from(< span class = "string" > " cake_eating" < / span > );
msg.result = String::from(< span class = "string" > " It was amazing" < / span > );
< span class = "macro" > assert_eq!< / span > (msg.status, MessageStatus::Success);
2022-10-07 11:23:12 +02:00
2022-11-04 01:07:22 +01:00
< span class = "kw" > let < / span > expected_result = < span class = "string" > " success - cake_eating: It was amazing" < / span > ;
< span class = "macro" > assert_eq!< / span > (< span class = "macro" > format!< / span > (< span class = "string" > " {}" < / span > , msg), expected_result);
2022-10-07 11:23:12 +02:00
2022-11-04 01:07:22 +01:00
msg.output_mode = ConsoleOutputMode::JSON;
< span class = "kw" > let < / span > expected_result =
2022-10-07 11:23:12 +02:00
< span class = "string" > " {\" action\" :\" cake_eating\" ,\" result\" :\" It was amazing\" ,\" status\" :\" success\" }" < / span > ;
2022-11-04 01:07:22 +01:00
< span class = "macro" > assert_eq!< / span > (< span class = "macro" > format!< / span > (< span class = "string" > " {}" < / span > , msg), expected_result);< / code > < / pre > < / div >
< / div > < div class = "impl-items" > < details class = "rustdoc-toggle method-toggle" open > < summary > < section id = "method.fmt-1" class = "method trait-impl has-srclink" > < a class = "srclink rightside" href = "../../src/kanidm_proto/messages.rs.html#202-213" > source< / a > < a href = "#method.fmt-1" class = "anchor" > < / a > < h4 class = "code-header" > fn < a href = "https://doc.rust-lang.org/1.65.0/core/fmt/trait.Display.html#tymethod.fmt" class = "fnname" > fmt< / a > (& self, f: & mut < a class = "struct" href = "https://doc.rust-lang.org/1.65.0/core/fmt/struct.Formatter.html" title = "struct core::fmt::Formatter" > Formatter< / a > < '_> ) -> < a class = "type" href = "https://doc.rust-lang.org/1.65.0/core/fmt/type.Result.html" title = "type core::fmt::Result" > Result< / a > < / h4 > < / section > < / summary > < div class = 'docblock' > Formats the value using the given formatter. < a href = "https://doc.rust-lang.org/1.65.0/core/fmt/trait.Display.html#tymethod.fmt" > Read more< / a > < / div > < / details > < / div > < / details > < details class = "rustdoc-toggle implementors-toggle" open > < summary > < section id = "impl-Serialize-for-BasicMessage" class = "impl has-srclink" > < a class = "srclink rightside" href = "../../src/kanidm_proto/messages.rs.html#164" > source< / a > < a href = "#impl-Serialize-for-BasicMessage" class = "anchor" > < / a > < h3 class = "code-header in-band" > impl < a class = "trait" href = "https://docs.rs/serde/1.0.147/serde/ser/trait.Serialize.html" title = "trait serde::ser::Serialize" > Serialize< / a > for < a class = "struct" href = "struct.BasicMessage.html" title = "struct kanidm_proto::messages::BasicMessage" > BasicMessage< / a > < / h3 > < / section > < / summary > < div class = "impl-items" > < details class = "rustdoc-toggle method-toggle" open > < summary > < section id = "method.serialize" class = "method trait-impl has-srclink" > < a class = "srclink rightside" href = "../../src/kanidm_proto/messages.rs.html#164" > source< / a > < a href = "#method.serialize" class = "anchor" > < / a > < h4 class = "code-header" > fn < a href = "https://docs.rs/serde/1.0.147/serde/ser/trait.Serialize.html#tymethod.serialize" class = "fnname" > serialize< / a > < __S> (& self, __serializer: __S) -> < a class = "enum" href = "https://doc.rust-lang.org/1.65.0/core/result/enum.Result.html" title = "enum core::result::Result" > Result< / a > < __S::< a class = "associatedtype" href = "https://docs.rs/serde/1.0.147/serde/ser/trait.Serializer.html#associatedtype.Ok" title = "type serde::ser::Serializer::Ok" > Ok< / a > , __S::< a class = "associatedtype" href = "https://docs.rs/serde/1.0.147/serde/ser/trait.Serializer.html#associatedtype.Error" title = "type serde::ser::Serializer::Error" > Error< / a > > < span class = "where fmt-newline" > where< br > __S: < a class = "trait" href = "https://docs.rs/serde/1.0.147/serde/ser/trait.Serializer.html" title = "trait serde::ser::Serializer" > Serializer< / a > ,< / span > < / h4 > < / section > < / summary > < div class = 'docblock' > Serialize this value into the given Serde serializer. < a href = "https://docs.rs/serde/1.0.147/serde/ser/trait.Serialize.html#tymethod.serialize" > Read more< / a > < / div > < / details > < / div > < / details > < / div > < h2 id = "synthetic-implementations" class = "small-section-header" > Auto Trait Implementations< a href = "#synthetic-implementations" class = "anchor" > < / a > < / h2 > < div id = "synthetic-implementations-list" > < section id = "impl-RefUnwindSafe-for-BasicMessage" class = "impl has-srclink" > < a href = "#impl-RefUnwindSafe-for-BasicMessage" class = "anchor" > < / a > < h3 class = "code-header in-band" > impl < a class = "trait" href = "https://doc.rust-lang.org/1.65.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title = "trait core::panic::unwind_safe::RefUnwindSafe" > RefUnwindSafe< / a > for < a class = "struct" href = "struct.BasicMessage.html" title = "struct kanidm_proto::messages::BasicMessage" > BasicMessage< / a > < / h3 > < / section > < section id = "impl-Send-for-BasicMessage" class = "impl has-srclink" > < a href = "#impl-Send-for-BasicMessage" class = "anchor" > < / a > < h3 class = "code-header in-band" > impl < a class = "trait" href = "https://doc.rust-lang.org/1.65.0/core/marker/trait.Send.html" title = "trait core::marker::Send" > Send< / a > for < a class = "struct" href = "struct.BasicMessage.html" title = "struct kanidm_proto::messages::BasicMessage" > BasicMessage< / a > < / h3 > < / section > < section id = "i
< / div > < / details > < / div > < / details > < details class = "rustdoc-toggle implementors-toggle" > < summary > < section id = "impl-Into%3CU%3E-for-BasicMessage" class = "impl has-srclink" > < a class = "srclink rightside" href = "https://doc.rust-lang.org/1.65.0/src/core/convert/mod.rs.html#543" > source< / a > < a href = "#impl-Into%3CU%3E-for-BasicMessage" class = "anchor" > < / a > < h3 class = "code-header in-band" > impl< T, U> < a class = "trait" href = "https://doc.rust-lang.org/1.65.0/core/convert/trait.Into.html" title = "trait core::convert::Into" > Into< / a > < U> for T< span class = "where fmt-newline" > where< br > U: < a class = "trait" href = "https://doc.rust-lang.org/1.65.0/core/convert/trait.From.html" title = "trait core::convert::From" > From< / a > < T> ,< / span > < / h3 > < / section > < / summary > < div class = "impl-items" > < details class = "rustdoc-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.65.0/src/core/convert/mod.rs.html#551" > source< / a > < / span > < a href = "#method.into" class = "anchor" > < / a > < h4 class = "code-header" > fn < a href = "https://doc.rust-lang.org/1.65.0/core/convert/trait.Into.html#tymethod.into" class = "fnname" > into< / a > (self) -> U< / h4 > < / section > < / summary > < div class = "docblock" > < p > Calls < code > U::from(self)< / code > .< / p >
2022-10-07 11:23:12 +02:00
< p > That is, this conversion is whatever the implementation of
2022-11-04 01:07:22 +01:00
< code > < a href = "https://doc.rust-lang.org/1.65.0/core/convert/trait.From.html" title = "From" > From< / a > < T> for U< / code > chooses to do.< / p >
< / div > < / details > < / div > < / details > < details class = "rustdoc-toggle implementors-toggle" > < summary > < section id = "impl-Serialize-for-BasicMessage-1" class = "impl has-srclink" > < a class = "srclink rightside" href = "https://docs.rs/erased-serde/0.3.23/src/erased_serde/ser.rs.html#238" > source< / a > < a href = "#impl-Serialize-for-BasicMessage-1" class = "anchor" > < / a > < h3 class = "code-header in-band" > impl< T> < a class = "trait" href = "https://docs.rs/erased-serde/0.3.23/erased_serde/ser/trait.Serialize.html" title = "trait erased_serde::ser::Serialize" > Serialize< / a > for T< span class = "where fmt-newline" > where< br > T: < a class = "trait" href = "https://docs.rs/serde/1.0.147/serde/ser/trait.Serialize.html" title = "trait serde::ser::Serialize" > Serialize< / a > + ?< a class = "trait" href = "https://doc.rust-lang.org/1.65.0/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.23/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.23/erased_serde/ser/trait.Serialize.html#tymethod.erased_serialize" class = "fnname" > erased_serialize< / a > (& self, serializer: & mut dyn < a class = "trait" href = "https://docs.rs/erased-serde/0.3.23/erased_serde/ser/trait.Serializer.html" title = "trait erased_serde::ser::Serializer" > Serializer< / a > ) -> < a class = "enum" href = "https://doc.rust-lang.org/1.65.0/core/result/enum.Result.html" title = "enum core::result::Result" > Result< / a > < Ok, < a class = "struct" href = "https://docs.rs/erased-serde/0.3.23/erased_serde/error/struct.Error.html" title = "struct erased_serde::error::Error" > Error< / a > > < / h4 > < / section > < / div > < / details > < details class = "rustdoc-toggle implementors-toggle" > < summary > < section id = "impl-ToString-for-BasicMessage" class = "impl has-srclink" > < a class = "srclink rightside" href = "https://doc.rust-lang.org/1.65.0/src/alloc/string.rs.html#2500" > source< / a > < a href = "#impl-ToString-for-BasicMessage" class = "anchor" > < / a > < h3 class = "code-header in-band" > impl< T> < a class = "trait" href = "https://doc.rust-lang.org/1.65.0/alloc/string/trait.ToString.html" title = "trait alloc::string::ToString" > ToString< / a > for T< span class = "where fmt-newline" > where< br > T: < a class = "trait" href = "https://doc.rust-lang.org/1.65.0/core/fmt/trait.Display.html" title = "trait core::fmt::Display" > Display< / a > + ?< a class = "trait" href = "https://doc.rust-lang.org/1.65.0/core/marker/trait.Sized.html" title = "trait core::marker::Sized" > Sized< / a > ,< / span > < / h3 > < / section > < / summary > < div class = "impl-items" > < details class = "rustdoc-toggle method-toggle" open > < summary > < section id = "method.to_string" class = "method trait-impl has-srclink" > < a class = "srclink rightside" href = "https://doc.rust-lang.org/1.65.0/src/alloc/string.rs.html#2506" > source< / a > < a href = "#method.to_string" class = "anchor" > < / a > < h4 class = "code-header" > default fn < a href = "https://doc.rust-lang.org/1.65.0/alloc/string/trait.ToString.html#tymethod.to_string" class = "fnname" > to_string< / a > (& self) -> < a class = "struct" href = "https://doc.rust-lang.org/1.65.0/alloc/string/struct.String.html" title = "struct alloc::string::String" > String< / a > < / h4 > < / section > < / summary > < div class = 'docblock' > Converts the given value to a < code > String< / code > . < a href = "https://doc.rust-lang.org/1.65.0/alloc/string/trait.ToString.html#tymethod.to_string" > Read more< / a > < / div > < / details > < / div > < / details > < details class = "rustdoc-toggle implementors-toggle" > < summary > < section id = "impl-TryFrom%3CU%3E-for-BasicMessage" class = "impl has-srclink" > < a class = "srclink rightside" href = "https://doc.rust-lang.org/1.65.0/src/core/convert/mod.rs.html#601" > source< / a > < a href = "#impl-TryFrom%3CU%3E-for-BasicMessage" class = "anchor" > < / a > < h3 class = "code-header in-band" > impl< T, U> < a class = "trait" href = "https://doc.rust-lang.org/1.65.0/core/convert/trait.TryFrom.html" title = "trait core::convert::TryFrom" > TryFr
