<!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 `server/lib/src/idm/group.rs`."><title>group.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceSerif4-Regular-46f98efaafac5295.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-a2c9cd1067f8b328.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-c4dbdcde0fbd8430.css" id="mainThemeStyle"><link rel="stylesheet" id="themeStyle" href="../../../static.files/light-db279b6232be9c13.css"><link rel="stylesheet" disabled href="../../../static.files/dark-cf923f49f397b216.css"><link rel="stylesheet" disabled href="../../../static.files/ayu-be46fdc453a55015.css"><script src="../../../static.files/storage-3891ce972e3a2bf8.js"></script><script defer src="../../../static.files/source-script-1b95b7cca98b26e5.js"></script><script defer src="../../../source-files.js"></script><script defer src="../../../static.files/main-98a684e84ae5b08b.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 source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"></nav><main><nav class="sub"><a class="sub-logo-container" href="../../../kanidmd_lib/index.html"><img class="rust-logo" src="../../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><a href="#1" id="1">1</a>
<a href="#2" id="2">2</a>
<a href="#3" id="3">3</a>
<a href="#4" id="4">4</a>
<a href="#5" id="5">5</a>
<a href="#6" id="6">6</a>
<a href="#7" id="7">7</a>
<a href="#8" id="8">8</a>
<a href="#9" id="9">9</a>
<a href="#10" id="10">10</a>
<a href="#11" id="11">11</a>
<a href="#12" id="12">12</a>
<a href="#13" id="13">13</a>
<a href="#14" id="14">14</a>
<a href="#15" id="15">15</a>
<a href="#16" id="16">16</a>
<a href="#17" id="17">17</a>
<a href="#18" id="18">18</a>
<a href="#19" id="19">19</a>
<a href="#20" id="20">20</a>
<a href="#21" id="21">21</a>
<a href="#22" id="22">22</a>
<a href="#23" id="23">23</a>
<a href="#24" id="24">24</a>
<a href="#25" id="25">25</a>
<a href="#26" id="26">26</a>
<a href="#27" id="27">27</a>
<a href="#28" id="28">28</a>
<a href="#29" id="29">29</a>
<a href="#30" id="30">30</a>
<a href="#31" id="31">31</a>
<a href="#32" id="32">32</a>
<a href="#33" id="33">33</a>
<a href="#34" id="34">34</a>
<a href="#35" id="35">35</a>
<a href="#36" id="36">36</a>
<a href="#37" id="37">37</a>
<a href="#38" id="38">38</a>
<a href="#39" id="39">39</a>
<a href="#40" id="40">40</a>
<a href="#41" id="41">41</a>
<a href="#42" id="42">42</a>
<a href="#43" id="43">43</a>
<a href="#44" id="44">44</a>
<a href="#45" id="45">45</a>
<a href="#46" id="46">46</a>
<a href="#47" id="47">47</a>
<a href="#48" id="48">48</a>
<a href="#49" id="49">49</a>
<a href="#50" id="50">50</a>
<a href="#51" id="51">51</a>
<a href="#52" id="52">52</a>
<a href="#53" id="53">53</a>
<a href="#54" id="54">54</a>
<a href="#55" id="55">55</a>
<a href="#56" id="56">56</a>
<a href="#57" id="57">57</a>
<a href="#58" id="58">58</a>
<a href="#59" id="59">59</a>
<a href="#60" id="60">60</a>
<a href="#61" id="61">61</a>
<a href="#62" id="62">62</a>
<a href="#63" id="63">63</a>
<a href="#64" id="64">64</a>
<a href="#65" id="65">65</a>
<a href="#66" id="66">66</a>
<a href="#67" id="67">67</a>
<a href="#68" id="68">68</a>
<a href="#69" id="69">69</a>
<a href="#70" id="70">70</a>
<a href="#71" id="71">71</a>
<a href="#72" id="72">72</a>
<a href="#73" id="73">73</a>
<a href="#74" id="74">74</a>
<a href="#75" id="75">75</a>
<a href="#76" id="76">76</a>
<a href="#77" id="77">77</a>
<a href="#78" id="78">78</a>
<a href="#79" id="79">79</a>
<a href="#80" id="80">80</a>
<a href="#81" id="81">81</a>
<a href="#82" id="82">82</a>
<a href="#83" id="83">83</a>
<a href="#84" id="84">84</a>
<a href="#85" id="85">85</a>
<a href="#86" id="86">86</a>
<a href="#87" id="87">87</a>
<a href="#88" id="88">88</a>
<a href="#89" id="89">89</a>
<a href="#90" id="90">90</a>
<a href="#91" id="91">91</a>
<a href="#92" id="92">92</a>
<a href="#93" id="93">93</a>
<a href="#94" id="94">94</a>
<a href="#95" id="95">95</a>
<a href="#96" id="96">96</a>
<a href="#97" id="97">97</a>
<a href="#98" id="98">98</a>
<a href="#99" id="99">99</a>
<a href="#100" id="100">100</a>
<a href="#101" id="101">101</a>
<a href="#102" id="102">102</a>
<a href="#103" id="103">103</a>
<a href="#104" id="104">104</a>
<a href="#105" id="105">105</a>
<a href="#106" id="106">106</a>
<a href="#107" id="107">107</a>
<a href="#108" id="108">108</a>
<a href="#109" id="109">109</a>
<a href="#110" id="110">110</a>
<a href="#111" id="111">111</a>
<a href="#112" id="112">112</a>
<a href="#113" id="113">113</a>
<a href="#114" id="114">114</a>
<a href="#115" id="115">115</a>
<a href="#116" id="116">116</a>
<a href="#117" id="117">117</a>
<a href="#118" id="118">118</a>
<a href="#119" id="119">119</a>
<a href="#120" id="120">120</a>
<a href="#121" id="121">121</a>
<a href="#122" id="122">122</a>
<a href="#123" id="123">123</a>
<a href="#124" id="124">124</a>
<a href="#125" id="125">125</a>
<a href="#126" id="126">126</a>
<a href="#127" id="127">127</a>
<a href="#128" id="128">128</a>
<a href="#129" id="129">129</a>
<a href="#130" id="130">130</a>
<a href="#131" id="131">131</a>
<a href="#132" id="132">132</a>
<a href="#133" id="133">133</a>
<a href="#134" id="134">134</a>
<a href="#135" id="135">135</a>
<a href="#136" id="136">136</a>
<a href="#137" id="137">137</a>
<a href="#138" id="138">138</a>
<a href="#139" id="139">139</a>
<a href="#140" id="140">140</a>
<a href="#141" id="141">141</a>
<a href="#142" id="142">142</a>
</pre><pre class="rust"><code><span class="kw">use </span>std::collections::BTreeSet;

<span class="kw">use </span>kanidm_proto::v1::UiHint;
<span class="kw">use </span>kanidm_proto::v1::{Group <span class="kw">as </span>ProtoGroup, OperationError};
<span class="kw">use </span>uuid::Uuid;

<span class="kw">use </span><span class="kw">crate</span>::entry::{Entry, EntryCommitted, EntryReduced, EntrySealed};
<span class="kw">use </span><span class="kw">crate</span>::prelude::<span class="kw-2">*</span>;
<span class="kw">use </span><span class="kw">crate</span>::value::PartialValue;

<span class="attr">#[derive(Debug, Clone)]
</span><span class="kw">pub struct </span>Group {
    spn: String,
    uuid: Uuid,
    <span class="comment">// We&#39;ll probably add policy and claims later to this
    </span><span class="kw">pub </span>ui_hints: BTreeSet&lt;UiHint&gt;,
}

<span class="macro">macro_rules! </span>try_from_account_e {
    (<span class="macro-nonterminal">$value</span>:expr, <span class="macro-nonterminal">$qs</span>:expr) =&gt; {{
        <span class="comment">/*
        let name = $value
            .get_ava_single_iname(&quot;name&quot;)
            .map(str::to_string)
            .ok_or_else(|| {
                OperationError::InvalidAccountState(&quot;Missing attribute: name&quot;.to_string())
            })?;
        */

        // Setup the user private group
        </span><span class="kw">let </span>spn = <span class="macro-nonterminal">$value</span>.get_ava_single_proto_string(<span class="string">&quot;spn&quot;</span>).ok_or(
            OperationError::InvalidAccountState(<span class="string">&quot;Missing attribute: spn&quot;</span>.to_string()),
        )<span class="question-mark">?</span>;

        <span class="kw">let </span>uuid = <span class="macro-nonterminal">$value</span>.get_uuid();

        <span class="comment">// We could allow ui hints on the user direct in the future?
        </span><span class="kw">let </span>ui_hints = BTreeSet::default();

        <span class="kw">let </span>upg = Group {
            spn,
            uuid,
            ui_hints,
        };

        <span class="kw">let </span><span class="kw-2">mut </span>groups: Vec&lt;Group&gt; = <span class="kw">match </span><span class="macro-nonterminal">$value</span>.get_ava_as_refuuid(<span class="string">&quot;memberof&quot;</span>) {
            <span class="prelude-val">Some</span>(riter) =&gt; {
                <span class="comment">// given a list of uuid, make a filter: even if this is empty, the be will
                // just give and empty result set.
                </span><span class="kw">let </span>f = <span class="macro">filter!</span>(f_or(
                    riter.map(|u| f_eq(<span class="string">&quot;uuid&quot;</span>, PartialValue::Uuid(u))).collect()
                ));
                <span class="kw">let </span>group_entries: Vec&lt;<span class="kw">_</span>&gt; = <span class="macro-nonterminal">$qs</span>.internal_search(f).map_err(|e| {
                    <span class="macro">admin_error!</span>(<span class="question-mark">?</span>e, <span class="string">&quot;internal search failed&quot;</span>);
                    e
                })<span class="question-mark">?</span>;
                <span class="comment">// Now convert the group entries to groups.
                </span><span class="kw">let </span>groups: <span class="prelude-ty">Result</span>&lt;Vec&lt;<span class="kw">_</span>&gt;, <span class="kw">_</span>&gt; = group_entries
                    .iter()
                    .map(|e| Group::try_from_entry(e.as_ref()))
                    .collect();

                groups.map_err(|e| {
                    <span class="macro">admin_error!</span>(<span class="question-mark">?</span>e, <span class="string">&quot;failed to transform group entries to groups&quot;</span>);
                    e
                })<span class="question-mark">?
            </span>}
            <span class="prelude-val">None </span>=&gt; {
                <span class="comment">// No memberof, no groups!
                </span><span class="macro">vec!</span>[]
            }
        };
        groups.push(upg);
        <span class="prelude-val">Ok</span>(groups)
    }};
}

<span class="kw">impl </span>Group {
    <span class="kw">pub fn </span>try_from_account_entry_red_ro(
        value: <span class="kw-2">&amp;</span>Entry&lt;EntryReduced, EntryCommitted&gt;,
        qs: <span class="kw-2">&amp;mut </span>QueryServerReadTransaction,
    ) -&gt; <span class="prelude-ty">Result</span>&lt;Vec&lt;<span class="self">Self</span>&gt;, OperationError&gt; {
        <span class="macro">try_from_account_e!</span>(value, qs)
    }

    <span class="kw">pub fn </span>try_from_account_entry_ro(
        value: <span class="kw-2">&amp;</span>Entry&lt;EntrySealed, EntryCommitted&gt;,
        qs: <span class="kw-2">&amp;mut </span>QueryServerReadTransaction,
    ) -&gt; <span class="prelude-ty">Result</span>&lt;Vec&lt;<span class="self">Self</span>&gt;, OperationError&gt; {
        <span class="macro">try_from_account_e!</span>(value, qs)
    }

    <span class="kw">pub fn </span>try_from_account_entry_rw(
        value: <span class="kw-2">&amp;</span>Entry&lt;EntrySealed, EntryCommitted&gt;,
        qs: <span class="kw-2">&amp;mut </span>QueryServerWriteTransaction,
    ) -&gt; <span class="prelude-ty">Result</span>&lt;Vec&lt;<span class="self">Self</span>&gt;, OperationError&gt; {
        <span class="macro">try_from_account_e!</span>(value, qs)
    }

    <span class="kw">pub fn </span>try_from_entry(
        value: <span class="kw-2">&amp;</span>Entry&lt;EntrySealed, EntryCommitted&gt;,
    ) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="self">Self</span>, OperationError&gt; {
        <span class="kw">if </span>!value.attribute_equality(<span class="string">&quot;class&quot;</span>, <span class="kw-2">&amp;</span>PVCLASS_GROUP) {
            <span class="kw">return </span><span class="prelude-val">Err</span>(OperationError::InvalidAccountState(
                <span class="string">&quot;Missing class: group&quot;</span>.to_string(),
            ));
        }

        <span class="comment">// Now extract our needed attributes
        /*
        let name = value
            .get_ava_single_iname(&quot;name&quot;)
            .map(|s| s.to_string())
            .ok_or_else(|| {
                OperationError::InvalidAccountState(&quot;Missing attribute: name&quot;.to_string())
            })?;
        */
        </span><span class="kw">let </span>spn = value.get_ava_single_proto_string(<span class="string">&quot;spn&quot;</span>).ok_or_else(|| {
            OperationError::InvalidAccountState(<span class="string">&quot;Missing attribute: spn&quot;</span>.to_string())
        })<span class="question-mark">?</span>;

        <span class="kw">let </span>uuid = value.get_uuid();

        <span class="kw">let </span>ui_hints = value
            .get_ava_uihint(<span class="string">&quot;grant_ui_hint&quot;</span>)
            .cloned()
            .unwrap_or_default();

        <span class="prelude-val">Ok</span>(Group {
            spn,
            uuid,
            ui_hints,
        })
    }

    <span class="kw">pub fn </span>to_proto(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; ProtoGroup {
        ProtoGroup {
            spn: <span class="self">self</span>.spn.clone(),
            uuid: <span class="self">self</span>.uuid.as_hyphenated().to_string(),
        }
    }
}
</code></pre></div>
</section></main><div id="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="kanidmd_lib" data-themes="" data-resource-suffix="" data-rustdoc-version="1.69.0 (84c898d65 2023-04-16)" data-search-js="search-8a59a8356673ec1f.js" data-settings-js="settings-f0c5c39777a9a2f6.js" data-settings-css="settings-0bcba95ff279c1db.css" ></div></body></html>