mart-w/kanidm
1
0
Fork 0
mirror of https://github.com/kanidm/kanidm.git synced 2025-02-24 21:17:01 +01:00
Code Issues Actions 10 Packages Projects Releases Wiki Activity
kanidm/docs/v1.1.0-alpha.8/rustdoc/kanidmd_lib/schema/trait.SchemaTransaction.html

13 lines
22 KiB
HTML
Raw Normal View History

deploy: dd761c9a455e8e3483644eef6f6543bc20380d9a
2023-02-24 05:06:37 +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 `SchemaTransaction` trait in crate `kanidmd_lib`."><meta name="keywords" content="rust, rustlang, rust-lang, SchemaTransaction"><title>SchemaTransaction in kanidmd_lib::schema - 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-6827029ac823cab7.css" id="mainThemeStyle"><link rel="stylesheet" id="themeStyle" href="../../static.files/light-ebce58d0a40c3431.css"><link rel="stylesheet" disabled href="../../static.files/dark-f23faae4a2daf9a6.css"><link rel="stylesheet" disabled href="../../static.files/ayu-8af5e100b21cd173.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-c55e1eb52e1886b4.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 trait"><!--[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="sidebar-logo" href="../../kanidmd_lib/index.html"><div class="logo-container"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../kanidmd_lib/index.html"><div class="logo-container"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></div></a><h2 class="location"><a href="#">SchemaTransaction</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.get_attributes">get_attributes</a></li><li><a href="#tymethod.get_attributes_unique">get_attributes_unique</a></li><li><a href="#tymethod.get_classes">get_classes</a></li><li><a href="#tymethod.get_reference_types">get_reference_types</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.is_multivalue">is_multivalue</a></li><li><a href="#method.is_replicated">is_replicated</a></li><li><a href="#method.normalise_attr_if_exists">normalise_attr_if_exists</a></li><li><a href="#method.normalise_attr_name">normalise_attr_name</a></li><li><a href="#method.query_attrs_difference">query_attrs_difference</a></li><li><a href="#method.validate">validate</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In kanidmd_lib::schema</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><input class="search-input" n
deploy: 6f7afc0a72210bf2ccacf6bd37be48053e92b24d
2023-01-28 05:14:00 +01:00
fn <a href="#tymethod.get_classes" class="fn">get_classes</a>(&amp;self) -&gt; &amp;HashMap&lt;<a class="type" href="../prelude/type.AttrString.html" title="type kanidmd_lib::prelude::AttrString">AttrString</a>, <a class="struct" href="struct.SchemaClass.html" title="struct kanidmd_lib::schema::SchemaClass">SchemaClass</a>&gt;;
<span class="item-spacer"></span> fn <a href="#tymethod.get_attributes" class="fn">get_attributes</a>(&amp;self) -&gt; &amp;HashMap&lt;<a class="type" href="../prelude/type.AttrString.html" title="type kanidmd_lib::prelude::AttrString">AttrString</a>, <a class="struct" href="struct.SchemaAttribute.html" title="struct kanidmd_lib::schema::SchemaAttribute">SchemaAttribute</a>&gt;;
deploy: 0d8d9e1a62652b2ca008154cb90f8e99e2bd4389
2023-02-17 08:24:03 +01:00
<span class="item-spacer"></span> fn <a href="#tymethod.get_attributes_unique" class="fn">get_attributes_unique</a>(&amp;self) -&gt; &amp;<a class="struct" href="https://doc.rust-lang.org/1.67.1/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="type" href="../prelude/type.AttrString.html" title="type kanidmd_lib::prelude::AttrString">AttrString</a>&gt; <a href="#" class="notable-traits" data-ty="&amp;Vec&lt;AttrString&gt;">ⓘ</a>;
deploy: 6f7afc0a72210bf2ccacf6bd37be48053e92b24d
2023-01-28 05:14:00 +01:00
<span class="item-spacer"></span> fn <a href="#tymethod.get_reference_types" class="fn">get_reference_types</a>(&amp;self) -&gt; &amp;HashMap&lt;<a class="type" href="../prelude/type.AttrString.html" title="type kanidmd_lib::prelude::AttrString">AttrString</a>, <a class="struct" href="struct.SchemaAttribute.html" title="struct kanidmd_lib::schema::SchemaAttribute">SchemaAttribute</a>&gt;;
deploy: 048aa0dfb56cbcf956c9da5115baed7728820a26
2022-10-07 11:23:12 +02:00
deploy: 0d8d9e1a62652b2ca008154cb90f8e99e2bd4389
2023-02-17 08:24:03 +01:00
fn <a href="#method.validate" class="fn">validate</a>(&amp;self) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.67.1/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="enum" href="https://doc.rust-lang.org/1.67.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.67.1/std/primitive.unit.html">()</a>, <a class="enum" href="../prelude/enum.ConsistencyError.html" title="enum kanidmd_lib::prelude::ConsistencyError">ConsistencyError</a>&gt;&gt; <a href="#" class="notable-traits" data-ty="Vec&lt;Result&lt;(), ConsistencyError&gt;&gt;">ⓘ</a> { ... }
<span class="item-spacer"></span> fn <a href="#method.is_replicated" class="fn">is_replicated</a>(&amp;self, attr: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.67.1/std/primitive.str.html">str</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.67.1/std/primitive.bool.html">bool</a> { ... }
<span class="item-spacer"></span> fn <a href="#method.is_multivalue" class="fn">is_multivalue</a>(&amp;self, attr: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.67.1/std/primitive.str.html">str</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.67.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.67.1/std/primitive.bool.html">bool</a>, <a class="enum" href="../prelude/enum.SchemaError.html" title="enum kanidmd_lib::prelude::SchemaError">SchemaError</a>&gt; { ... }
<span class="item-spacer"></span> fn <a href="#method.normalise_attr_name" class="fn">normalise_attr_name</a>(&amp;self, an: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.67.1/std/primitive.str.html">str</a>) -&gt; <a class="type" href="../prelude/type.AttrString.html" title="type kanidmd_lib::prelude::AttrString">AttrString</a> { ... }
<span class="item-spacer"></span> fn <a href="#method.normalise_attr_if_exists" class="fn">normalise_attr_if_exists</a>(&amp;self, an: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.67.1/std/primitive.str.html">str</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.67.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="type" href="../prelude/type.AttrString.html" title="type kanidmd_lib::prelude::AttrString">AttrString</a>&gt; { ... }
<span class="item-spacer"></span> fn <a href="#method.query_attrs_difference" class="fn">query_attrs_difference</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&amp;self,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;prev_class: &amp;<a class="struct" href="../idm/authsession/struct.Set.html" title="struct kanidmd_lib::idm::authsession::Set">BTreeSet</a>&lt;&amp;<a class="primitive" href="https://doc.rust-lang.org/1.67.1/std/primitive.str.html">str</a>&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;new_class: &amp;<a class="struct" href="../idm/authsession/struct.Set.html" title="struct kanidmd_lib::idm::authsession::Set">BTreeSet</a>&lt;&amp;<a class="primitive" href="https://doc.rust-lang.org/1.67.1/std/primitive.str.html">str</a>&gt;<br>&nbsp;&nbsp;&nbsp;&nbsp;) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.67.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;(<a class="struct" href="../idm/authsession/struct.Set.html" title="struct kanidmd_lib::idm::authsession::Set">BTreeSet</a>&lt;&amp;<a class="primitive" href="https://doc.rust-lang.org/1.67.1/std/primitive.str.html">str</a>&gt;, <a class="struct" href="../idm/authsession/struct.Set.html" title="struct kanidmd_lib::idm::authsession::Set">BTreeSet</a>&lt;&amp;<a class="primitive" href="https://doc.rust-lang.org/1.67.1/std/primitive.str.html">str</a>&gt;), <a class="enum" href="../prelude/enum.SchemaError.html" title="enum kanidmd_lib::prelude::SchemaError">SchemaError</a>&gt; { ... }
deploy: dd761c9a455e8e3483644eef6f6543bc20380d9a
2023-02-24 05:06:37 +01:00
}</code></pre></div><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><section id="tymethod.get_classes" class="method has-srclink"><a class="srclink rightside" href="../../src/kanidmd_lib/schema.rs.html#438">source</a><h4 class="code-header">fn <a href="#tymethod.get_classes" class="fn">get_classes</a>(&amp;self) -&gt; &amp;HashMap&lt;<a class="type" href="../prelude/type.AttrString.html" title="type kanidmd_lib::prelude::AttrString">AttrString</a>, <a class="struct" href="struct.SchemaClass.html" title="struct kanidmd_lib::schema::SchemaClass">SchemaClass</a>&gt;</h4></section><section id="tymethod.get_attributes" class="method has-srclink"><a class="srclink rightside" href="../../src/kanidmd_lib/schema.rs.html#439">source</a><h4 class="code-header">fn <a href="#tymethod.get_attributes" class="fn">get_attributes</a>(&amp;self) -&gt; &amp;HashMap&lt;<a class="type" href="../prelude/type.AttrString.html" title="type kanidmd_lib::prelude::AttrString">AttrString</a>, <a class="struct" href="struct.SchemaAttribute.html" title="struct kanidmd_lib::schema::SchemaAttribute">SchemaAttribute</a>&gt;</h4></section><section id="tymethod.get_attributes_unique" class="method has-srclink"><a class="srclink rightside" href="../../src/kanidmd_lib/schema.rs.html#441">source</a><h4 class="code-header">fn <a href="#tymethod.get_attributes_unique" class="fn">get_attributes_unique</a>(&amp;self) -&gt; &amp;<a class="struct" href="https://doc.rust-lang.org/1.67.1/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="type" href="../prelude/type.AttrString.html" title="type kanidmd_lib::prelude::AttrString">AttrString</a>&gt; <a href="#" class="notable-traits" data-ty="&amp;Vec&lt;AttrString&gt;">ⓘ</a></h4></section><section id="tymethod.get_reference_types" class="method has-srclink"><a class="srclink rightside" href="../../src/kanidmd_lib/schema.rs.html#442">source</a><h4 class="code-header">fn <a href="#tymethod.get_reference_types" class="fn">get_reference_types</a>(&amp;self) -&gt; &amp;HashMap&lt;<a class="type" href="../prelude/type.AttrString.html" title="type kanidmd_lib::prelude::AttrString">AttrString</a>, <a class="struct" href="struct.SchemaAttribute.html" title="struct kanidmd_lib::schema::SchemaAttribute">SchemaAttribute</a>&gt;</h4></section></div><h2 id="provided-methods" class="small-section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><section id="method.validate" class="method has-srclink"><a class="srclink rightside" href="../../src/kanidmd_lib/schema.rs.html#444-496">source</a><h4 class="code-header">fn <a href="#method.validate" class="fn">validate</a>(&amp;self) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.67.1/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="enum" href="https://doc.rust-lang.org/1.67.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.67.1/std/primitive.unit.html">()</a>, <a class="enum" href="../prelude/enum.ConsistencyError.html" title="enum kanidmd_lib::prelude::ConsistencyError">ConsistencyError</a>&gt;&gt; <a href="#" class="notable-traits" data-ty="Vec&lt;Result&lt;(), ConsistencyError&gt;&gt;">ⓘ</a></h4></section><section id="method.is_replicated" class="method has-srclink"><a class="srclink rightside" href="../../src/kanidmd_lib/schema.rs.html#498-512">source</a><h4 class="code-header">fn <a href="#method.is_replicated" class="fn">is_replicated</a>(&amp;self, attr: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.67.1/std/primitive.str.html">str</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.67.1/std/primitive.bool.html">bool</a></h4></section><section id="method.is_multivalue" class="method has-srclink"><a class="srclink rightside" href="../../src/kanidmd_lib/schema.rs.html#514-522">source</a><h4 class="code-header">fn <a href="#method.is_multivalue" class="fn">is
Reference in a new issue Copy permalink