mirror of
https://github.com/kanidm/kanidm.git
synced 2025-03-01 07:27:00 +01:00
266 lines
18 KiB
HTML
266 lines
18 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="Source of the Rust file `kanidm_proto/src/messages.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>messages.rs - source</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" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script src="../../crates.js"></script><script defer src="../../main.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.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 source"><!--[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></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../kanidm_proto/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><div class="theme-picker hidden"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="22" height="22" alt="Pick another theme!" src="../../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><div class="example-wrap"><pre class="line-numbers"><span id="1">1</span>
|
||
<span id="2">2</span>
|
||
<span id="3">3</span>
|
||
<span id="4">4</span>
|
||
<span id="5">5</span>
|
||
<span id="6">6</span>
|
||
<span id="7">7</span>
|
||
<span id="8">8</span>
|
||
<span id="9">9</span>
|
||
<span id="10">10</span>
|
||
<span id="11">11</span>
|
||
<span id="12">12</span>
|
||
<span id="13">13</span>
|
||
<span id="14">14</span>
|
||
<span id="15">15</span>
|
||
<span id="16">16</span>
|
||
<span id="17">17</span>
|
||
<span id="18">18</span>
|
||
<span id="19">19</span>
|
||
<span id="20">20</span>
|
||
<span id="21">21</span>
|
||
<span id="22">22</span>
|
||
<span id="23">23</span>
|
||
<span id="24">24</span>
|
||
<span id="25">25</span>
|
||
<span id="26">26</span>
|
||
<span id="27">27</span>
|
||
<span id="28">28</span>
|
||
<span id="29">29</span>
|
||
<span id="30">30</span>
|
||
<span id="31">31</span>
|
||
<span id="32">32</span>
|
||
<span id="33">33</span>
|
||
<span id="34">34</span>
|
||
<span id="35">35</span>
|
||
<span id="36">36</span>
|
||
<span id="37">37</span>
|
||
<span id="38">38</span>
|
||
<span id="39">39</span>
|
||
<span id="40">40</span>
|
||
<span id="41">41</span>
|
||
<span id="42">42</span>
|
||
<span id="43">43</span>
|
||
<span id="44">44</span>
|
||
<span id="45">45</span>
|
||
<span id="46">46</span>
|
||
<span id="47">47</span>
|
||
<span id="48">48</span>
|
||
<span id="49">49</span>
|
||
<span id="50">50</span>
|
||
<span id="51">51</span>
|
||
<span id="52">52</span>
|
||
<span id="53">53</span>
|
||
<span id="54">54</span>
|
||
<span id="55">55</span>
|
||
<span id="56">56</span>
|
||
<span id="57">57</span>
|
||
<span id="58">58</span>
|
||
<span id="59">59</span>
|
||
<span id="60">60</span>
|
||
<span id="61">61</span>
|
||
<span id="62">62</span>
|
||
<span id="63">63</span>
|
||
<span id="64">64</span>
|
||
<span id="65">65</span>
|
||
<span id="66">66</span>
|
||
<span id="67">67</span>
|
||
<span id="68">68</span>
|
||
<span id="69">69</span>
|
||
<span id="70">70</span>
|
||
<span id="71">71</span>
|
||
<span id="72">72</span>
|
||
<span id="73">73</span>
|
||
<span id="74">74</span>
|
||
<span id="75">75</span>
|
||
<span id="76">76</span>
|
||
<span id="77">77</span>
|
||
<span id="78">78</span>
|
||
<span id="79">79</span>
|
||
<span id="80">80</span>
|
||
<span id="81">81</span>
|
||
<span id="82">82</span>
|
||
<span id="83">83</span>
|
||
<span id="84">84</span>
|
||
<span id="85">85</span>
|
||
<span id="86">86</span>
|
||
<span id="87">87</span>
|
||
<span id="88">88</span>
|
||
<span id="89">89</span>
|
||
<span id="90">90</span>
|
||
<span id="91">91</span>
|
||
<span id="92">92</span>
|
||
<span id="93">93</span>
|
||
<span id="94">94</span>
|
||
<span id="95">95</span>
|
||
<span id="96">96</span>
|
||
<span id="97">97</span>
|
||
<span id="98">98</span>
|
||
<span id="99">99</span>
|
||
<span id="100">100</span>
|
||
<span id="101">101</span>
|
||
<span id="102">102</span>
|
||
<span id="103">103</span>
|
||
<span id="104">104</span>
|
||
<span id="105">105</span>
|
||
<span id="106">106</span>
|
||
<span id="107">107</span>
|
||
<span id="108">108</span>
|
||
<span id="109">109</span>
|
||
<span id="110">110</span>
|
||
<span id="111">111</span>
|
||
<span id="112">112</span>
|
||
<span id="113">113</span>
|
||
<span id="114">114</span>
|
||
<span id="115">115</span>
|
||
<span id="116">116</span>
|
||
<span id="117">117</span>
|
||
<span id="118">118</span>
|
||
<span id="119">119</span>
|
||
<span id="120">120</span>
|
||
<span id="121">121</span>
|
||
<span id="122">122</span>
|
||
<span id="123">123</span>
|
||
<span id="124">124</span>
|
||
<span id="125">125</span>
|
||
<span id="126">126</span>
|
||
<span id="127">127</span>
|
||
<span id="128">128</span>
|
||
<span id="129">129</span>
|
||
</pre><pre class="rust"><code><span class="comment">// User-facing output things</span>
|
||
|
||
<span class="kw">use</span> <span class="ident">serde</span>::{<span class="ident">Deserialize</span>, <span class="ident">Serialize</span>};
|
||
<span class="kw">use</span> <span class="ident">std::fmt</span>;
|
||
<span class="kw">use</span> <span class="ident">std::str::FromStr</span>;
|
||
|
||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Serialize</span>, <span class="ident">Deserialize</span>, <span class="ident">Clone</span>, <span class="ident">Copy</span>, <span class="ident">PartialEq</span>, <span class="ident">Eq</span>)]</span>
|
||
<span class="attribute">#[<span class="ident">serde</span>(<span class="ident">rename_all</span> <span class="op">=</span> <span class="string">"lowercase"</span>)]</span>
|
||
<span class="kw">pub</span> <span class="kw">enum</span> <span class="ident">ConsoleOutputMode</span> {
|
||
<span class="ident">Text</span>,
|
||
<span class="ident">JSON</span>,
|
||
}
|
||
<span class="kw">impl</span> <span class="ident">Default</span> <span class="kw">for</span> <span class="ident">ConsoleOutputMode</span> {
|
||
<span class="kw">fn</span> <span class="ident">default</span>() -> <span class="self">Self</span> {
|
||
<span class="ident">ConsoleOutputMode::Text</span>
|
||
}
|
||
}
|
||
|
||
<span class="kw">impl</span> <span class="ident">FromStr</span> <span class="kw">for</span> <span class="ident">ConsoleOutputMode</span> {
|
||
<span class="kw">type</span> <span class="prelude-val">Err</span> <span class="op">=</span> <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>;
|
||
<span class="doccomment">/// This can be safely unwrap'd because it'll always return a default</span>
|
||
<span class="kw">fn</span> <span class="ident">from_str</span>(<span class="ident">s</span>: <span class="kw-2">&</span><span class="ident">str</span>) -> <span class="prelude-ty">Result</span><span class="op"><</span><span class="self">Self</span>, <span class="ident"><span class="self">Self</span>::Err</span><span class="op">></span> {
|
||
<span class="kw">match</span> <span class="ident">s</span> {
|
||
<span class="string">"json"</span> => <span class="prelude-val">Ok</span>(<span class="ident">ConsoleOutputMode::JSON</span>),
|
||
<span class="string">"text"</span> => <span class="prelude-val">Ok</span>(<span class="ident">ConsoleOutputMode::Text</span>),
|
||
<span class="kw">_</span> => {
|
||
<span class="macro">eprintln!</span>(
|
||
<span class="string">"Supplied output mode ({:?}) was invalid, defaulting to text"</span>,
|
||
<span class="ident">s</span>
|
||
);
|
||
<span class="prelude-val">Ok</span>(<span class="ident">ConsoleOutputMode::Text</span>)
|
||
}
|
||
}
|
||
}
|
||
}
|
||
|
||
<span class="doccomment">/// This will take any string, if it's 'text' or 'json' then you'll get</span>
|
||
<span class="doccomment">/// what you asked for, else you'll get a text version.</span>
|
||
<span class="doccomment">///</span>
|
||
<span class="doccomment">/// ```</span>
|
||
<span class="doccomment">/// use kanidm_proto::messages::ConsoleOutputMode;</span>
|
||
<span class="doccomment">/// let bork = "text";</span>
|
||
<span class="doccomment">/// let com: ConsoleOutputMode = bork.into();</span>
|
||
<span class="doccomment">/// matches!(ConsoleOutputMode::Text, com);</span>
|
||
<span class="doccomment">/// ```</span>
|
||
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">str</span><span class="op">></span> <span class="kw">for</span> <span class="ident">ConsoleOutputMode</span> {
|
||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">input</span>: <span class="kw-2">&</span><span class="ident">str</span>) -> <span class="self">Self</span> {
|
||
<span class="kw">match</span> <span class="ident">ConsoleOutputMode::from_str</span>(<span class="ident">input</span>) {
|
||
<span class="prelude-val">Ok</span>(<span class="ident">val</span>) => <span class="ident">val</span>,
|
||
<span class="prelude-val">Err</span>(<span class="kw">_</span>) => <span class="ident"><span class="self">Self</span>::Text</span>,
|
||
}
|
||
}
|
||
}
|
||
|
||
<span class="doccomment">/// This will take any string, if it's 'text' or 'json' then you'll get</span>
|
||
<span class="doccomment">/// what you asked for, else you'll get a text version.</span>
|
||
<span class="doccomment">///</span>
|
||
<span class="doccomment">/// ```</span>
|
||
<span class="doccomment">/// use kanidm_proto::messages::ConsoleOutputMode;</span>
|
||
<span class="doccomment">/// let bork = String::from("cr4bz");</span>
|
||
<span class="doccomment">/// let com: ConsoleOutputMode = bork.into();</span>
|
||
<span class="doccomment">/// matches!(ConsoleOutputMode::Text, com);</span>
|
||
<span class="doccomment">/// ```</span>
|
||
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">String</span><span class="op">></span> <span class="kw">for</span> <span class="ident">ConsoleOutputMode</span> {
|
||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">input</span>: <span class="ident">String</span>) -> <span class="self">Self</span> {
|
||
<span class="kw">match</span> <span class="ident">ConsoleOutputMode::from_str</span>(<span class="ident">input</span>.<span class="ident">as_str</span>()) {
|
||
<span class="prelude-val">Ok</span>(<span class="ident">val</span>) => <span class="ident">val</span>,
|
||
<span class="prelude-val">Err</span>(<span class="kw">_</span>) => <span class="ident"><span class="self">Self</span>::Text</span>,
|
||
}
|
||
}
|
||
}
|
||
|
||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Serialize</span>, <span class="ident">Deserialize</span>)]</span>
|
||
<span class="attribute">#[<span class="ident">serde</span>(<span class="ident">rename_all</span> <span class="op">=</span> <span class="string">"lowercase"</span>)]</span>
|
||
<span class="kw">pub</span> <span class="kw">enum</span> <span class="ident">MessageStatus</span> {
|
||
<span class="ident">Failure</span>,
|
||
<span class="ident">Success</span>,
|
||
}
|
||
|
||
<span class="kw">impl</span> <span class="ident">fmt::Display</span> <span class="kw">for</span> <span class="ident">MessageStatus</span> {
|
||
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&mut</span> <span class="ident">fmt::Formatter</span>) -> <span class="ident">::std::result::Result</span><span class="op"><</span>(), <span class="ident">::std::fmt::Error</span><span class="op">></span> {
|
||
<span class="kw">match</span> <span class="kw-2">*</span><span class="self">self</span> {
|
||
<span class="ident">MessageStatus::Failure</span> => <span class="ident">f</span>.<span class="ident">write_str</span>(<span class="string">"failure"</span>),
|
||
<span class="ident">MessageStatus::Success</span> => <span class="ident">f</span>.<span class="ident">write_str</span>(<span class="string">"success"</span>),
|
||
}
|
||
}
|
||
}
|
||
|
||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Serialize</span>, <span class="ident">Deserialize</span>)]</span>
|
||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">AccountChangeMessage</span> {
|
||
<span class="attribute">#[<span class="ident">serde</span>(<span class="ident">skip_serializing</span>)]</span>
|
||
<span class="kw">pub</span> <span class="ident">output_mode</span>: <span class="ident">ConsoleOutputMode</span>,
|
||
<span class="kw">pub</span> <span class="ident">action</span>: <span class="ident">String</span>,
|
||
<span class="kw">pub</span> <span class="ident">result</span>: <span class="ident">String</span>,
|
||
<span class="kw">pub</span> <span class="ident">status</span>: <span class="ident">MessageStatus</span>,
|
||
<span class="kw">pub</span> <span class="ident">src_user</span>: <span class="ident">String</span>,
|
||
<span class="kw">pub</span> <span class="ident">dest_user</span>: <span class="ident">String</span>,
|
||
}
|
||
|
||
<span class="kw">impl</span> <span class="ident">Default</span> <span class="kw">for</span> <span class="ident">AccountChangeMessage</span> {
|
||
<span class="kw">fn</span> <span class="ident">default</span>() -> <span class="self">Self</span> {
|
||
<span class="ident">AccountChangeMessage</span> {
|
||
<span class="ident">output_mode</span>: <span class="ident">ConsoleOutputMode::Text</span>,
|
||
<span class="ident">action</span>: <span class="ident">String::from</span>(<span class="string">""</span>),
|
||
<span class="ident">result</span>: <span class="ident">String::from</span>(<span class="string">""</span>),
|
||
<span class="ident">status</span>: <span class="ident">MessageStatus::Success</span>,
|
||
<span class="ident">src_user</span>: <span class="ident">String::from</span>(<span class="string">""</span>),
|
||
<span class="ident">dest_user</span>: <span class="ident">String::from</span>(<span class="string">""</span>),
|
||
}
|
||
}
|
||
}
|
||
|
||
<span class="doccomment">/// This outputs in either JSON or Text depending on the output_mode setting</span>
|
||
<span class="kw">impl</span> <span class="ident">fmt::Display</span> <span class="kw">for</span> <span class="ident">AccountChangeMessage</span> {
|
||
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&mut</span> <span class="ident">fmt::Formatter</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span>) -> <span class="ident">fmt::Result</span> {
|
||
<span class="kw">match</span> <span class="self">self</span>.<span class="ident">output_mode</span> {
|
||
<span class="ident">ConsoleOutputMode::JSON</span> => <span class="macro">write!</span>(
|
||
<span class="ident">f</span>,
|
||
<span class="string">"{}"</span>,
|
||
<span class="ident">serde_json::to_string</span>(<span class="self">self</span>).<span class="ident">unwrap_or</span>(<span class="macro">format!</span>(<span class="string">"{:?}"</span>, <span class="self">self</span>)) <span class="comment">// if it fails to JSON serialize, just debug-dump it</span>
|
||
),
|
||
<span class="ident">ConsoleOutputMode::Text</span> => <span class="macro">write!</span>(
|
||
<span class="ident">f</span>,
|
||
<span class="string">"{} - {} for user {}: {}"</span>,
|
||
<span class="self">self</span>.<span class="ident">status</span>, <span class="self">self</span>.<span class="ident">action</span>, <span class="self">self</span>.<span class="ident">dest_user</span>, <span class="self">self</span>.<span class="ident">result</span>,
|
||
),
|
||
}
|
||
}
|
||
}
|
||
</code></pre></div>
|
||
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="kanidm_proto" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.62.0 (a8314ef7d 2022-06-27)" ></div>
|
||
</body></html> |