mirror of
https://github.com/kanidm/kanidm.git
synced 2025-02-24 13:07:00 +01:00
23 lines
21 KiB
HTML
23 lines
21 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="API documentation for the Rust `SchemaTransaction` trait in crate `kanidmd_lib`."><title>SchemaTransaction in kanidmd_lib::schema - Rust</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="sidebar-items.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 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">☰</button><a class="logo-container" href="../../kanidmd_lib/index.html"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2></h2></nav><nav class="sidebar"><a class="logo-container" href="../../kanidmd_lib/index.html"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></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" 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="main-heading"><h1>Trait <a href="../index.html">kanidmd_lib</a>::<wbr><a href="index.html">schema</a>::<wbr><a class="trait" href="#">SchemaTransaction</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/kanidmd_lib/schema.rs.html#437-590">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait SchemaTransaction {
|
||
// Required methods
|
||
fn <a href="#tymethod.get_classes" class="fn">get_classes</a>(&self) -> &HashMap<<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>>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.get_attributes" class="fn">get_attributes</a>(&self) -> &HashMap<<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>>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.get_attributes_unique" class="fn">get_attributes_unique</a>(&self) -> &<a class="struct" href="https://doc.rust-lang.org/1.69.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="type" href="../prelude/type.AttrString.html" title="type kanidmd_lib::prelude::AttrString">AttrString</a>> <a href="#" class="tooltip" data-notable-ty="&Vec<AttrString>">ⓘ</a>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.get_reference_types" class="fn">get_reference_types</a>(&self) -> &HashMap<<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>>;
|
||
|
||
// Provided methods
|
||
fn <a href="#method.validate" class="fn">validate</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.69.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="enum" href="https://doc.rust-lang.org/1.69.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.69.0/std/primitive.unit.html">()</a>, <a class="enum" href="../prelude/enum.ConsistencyError.html" title="enum kanidmd_lib::prelude::ConsistencyError">ConsistencyError</a>>> <a href="#" class="tooltip" data-notable-ty="Vec<Result<(), ConsistencyError>>">ⓘ</a> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.is_replicated" class="fn">is_replicated</a>(&self, attr: &<a class="primitive" href="https://doc.rust-lang.org/1.69.0/std/primitive.str.html">str</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.69.0/std/primitive.bool.html">bool</a> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.is_multivalue" class="fn">is_multivalue</a>(&self, attr: &<a class="primitive" href="https://doc.rust-lang.org/1.69.0/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.69.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.69.0/std/primitive.bool.html">bool</a>, <a class="enum" href="../prelude/enum.SchemaError.html" title="enum kanidmd_lib::prelude::SchemaError">SchemaError</a>> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.normalise_attr_name" class="fn">normalise_attr_name</a>(&self, an: &<a class="primitive" href="https://doc.rust-lang.org/1.69.0/std/primitive.str.html">str</a>) -> <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>(&self, an: &<a class="primitive" href="https://doc.rust-lang.org/1.69.0/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.69.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<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.query_attrs_difference" class="fn">query_attrs_difference</a>(
|
||
&self,
|
||
prev_class: &<a class="struct" href="../idm/authsession/struct.Set.html" title="struct kanidmd_lib::idm::authsession::Set">BTreeSet</a><&<a class="primitive" href="https://doc.rust-lang.org/1.69.0/std/primitive.str.html">str</a>>,
|
||
new_class: &<a class="struct" href="../idm/authsession/struct.Set.html" title="struct kanidmd_lib::idm::authsession::Set">BTreeSet</a><&<a class="primitive" href="https://doc.rust-lang.org/1.69.0/std/primitive.str.html">str</a>>
|
||
) -> <a class="enum" href="https://doc.rust-lang.org/1.69.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><(<a class="struct" href="../idm/authsession/struct.Set.html" title="struct kanidmd_lib::idm::authsession::Set">BTreeSet</a><&<a class="primitive" href="https://doc.rust-lang.org/1.69.0/std/primitive.str.html">str</a>>, <a class="struct" href="../idm/authsession/struct.Set.html" title="struct kanidmd_lib::idm::authsession::Set">BTreeSet</a><&<a class="primitive" href="https://doc.rust-lang.org/1.69.0/std/primitive.str.html">str</a>>), <a class="enum" href="../prelude/enum.SchemaError.html" title="enum kanidmd_lib::prelude::SchemaError">SchemaError</a>> { ... }
|
||
}</code></pre><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"><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>(&self) -> &HashMap<<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>></h4></section><section id="tymethod.get_attributes" class="method"><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>(&self) -> &HashMap<<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>></h4></section><section id="tymethod.get_attributes_unique" class="method"><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>(&self) -> &<a class="struct" href="https://doc.rust-lang.org/1.69.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="type" href="../prelude/type.AttrString.html" title="type kanidmd_lib::prelude::AttrString">AttrString</a>> <a href="#" class="tooltip" data-notable-ty="&Vec<AttrString>">ⓘ</a></h4></section><section id="tymethod.get_reference_types" class="method"><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>(&self) -> &HashMap<<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>></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"><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>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.69.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="enum" href="https://doc.rust-lang.org/1.69.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.69.0/std/primitive.unit.html">()</a>, <a class="enum" href="../prelude/enum.ConsistencyError.html" title="enum kanidmd_lib::prelude::ConsistencyError">ConsistencyError</a>>> <a href="#" class="tooltip" data-notable-ty="Vec<Result<(), ConsistencyError>>">ⓘ</a></h4></section><section id="method.is_replicated" class="method"><a class="srclink rightside" href="../../src/kanidmd_lib/schema.rs.html#498-513">source</a><h4 class="code-header">fn <a href="#method.is_replicated" class="fn">is_replicated</a>(&self, attr: &<a class="primitive" href="https://doc.rust-lang.org/1.69.0/std/primitive.str.html">str</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.69.0/std/primitive.bool.html">bool</a></h4></section><section id="method.is_multivalue" class="method"><a class="srclink rightside" href="../../src/kanidmd_lib/schema.rs.html#515-523">source</a><h4 class="code-header">fn <a href="#method.is_multivalue" class="fn">is_multivalue</a>(&self, attr: &<a class="primitive" href="https://doc.rust-lang.org/1.69.0/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.69.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.69.0/std/primitive.bool.html">bool</a>, <a class="enum" href="../prelude/enum.SchemaError.html" title="enum kanidmd_lib::prelude::SchemaError">SchemaError</a>></h4></section><section id="method.normalise_attr_name" class="method"><a class="srclink rightside" href="../../src/kanidmd_lib/schema.rs.html#525-528">source</a><h4 class="code-header">fn <a href="#method.normalise_attr_name" class="fn">normalise_attr_name</a>(&self, an: &<a class="primitive" href="https://doc.rust-lang.org/1.69.0/std/primitive.str.html">str</a>) -> <a class="type" href="../prelude/type.AttrString.html" title="type kanidmd_lib::prelude::AttrString">AttrString</a></h4></section><section id="method.normalise_attr_if_exists" class="method"><a class="srclink rightside" href="../../src/kanidmd_lib/schema.rs.html#530-536">source</a><h4 class="code-header">fn <a href="#method.normalise_attr_if_exists" class="fn">normalise_attr_if_exists</a>(&self, an: &<a class="primitive" href="https://doc.rust-lang.org/1.69.0/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.69.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="type" href="../prelude/type.AttrString.html" title="type kanidmd_lib::prelude::AttrString">AttrString</a>></h4></section><section id="method.query_attrs_difference" class="method"><a class="srclink rightside" href="../../src/kanidmd_lib/schema.rs.html#538-589">source</a><h4 class="code-header">fn <a href="#method.query_attrs_difference" class="fn">query_attrs_difference</a>(
|
||
&self,
|
||
prev_class: &<a class="struct" href="../idm/authsession/struct.Set.html" title="struct kanidmd_lib::idm::authsession::Set">BTreeSet</a><&<a class="primitive" href="https://doc.rust-lang.org/1.69.0/std/primitive.str.html">str</a>>,
|
||
new_class: &<a class="struct" href="../idm/authsession/struct.Set.html" title="struct kanidmd_lib::idm::authsession::Set">BTreeSet</a><&<a class="primitive" href="https://doc.rust-lang.org/1.69.0/std/primitive.str.html">str</a>>
|
||
) -> <a class="enum" href="https://doc.rust-lang.org/1.69.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><(<a class="struct" href="../idm/authsession/struct.Set.html" title="struct kanidmd_lib::idm::authsession::Set">BTreeSet</a><&<a class="primitive" href="https://doc.rust-lang.org/1.69.0/std/primitive.str.html">str</a>>, <a class="struct" href="../idm/authsession/struct.Set.html" title="struct kanidmd_lib::idm::authsession::Set">BTreeSet</a><&<a class="primitive" href="https://doc.rust-lang.org/1.69.0/std/primitive.str.html">str</a>>), <a class="enum" href="../prelude/enum.SchemaError.html" title="enum kanidmd_lib::prelude::SchemaError">SchemaError</a>></h4></section></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-SchemaTransaction-for-SchemaReadTransaction" class="impl"><a class="srclink rightside" href="../../src/kanidmd_lib/schema.rs.html#1855-1871">source</a><a href="#impl-SchemaTransaction-for-SchemaReadTransaction" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.SchemaTransaction.html" title="trait kanidmd_lib::schema::SchemaTransaction">SchemaTransaction</a> for <a class="struct" href="struct.SchemaReadTransaction.html" title="struct kanidmd_lib::schema::SchemaReadTransaction">SchemaReadTransaction</a></h3></section><section id="impl-SchemaTransaction-for-SchemaWriteTransaction%3C'a%3E" class="impl"><a class="srclink rightside" href="../../src/kanidmd_lib/schema.rs.html#1837-1853">source</a><a href="#impl-SchemaTransaction-for-SchemaWriteTransaction%3C'a%3E" class="anchor">§</a><h3 class="code-header">impl<'a> <a class="trait" href="trait.SchemaTransaction.html" title="trait kanidmd_lib::schema::SchemaTransaction">SchemaTransaction</a> for <a class="struct" href="struct.SchemaWriteTransaction.html" title="struct kanidmd_lib::schema::SchemaWriteTransaction">SchemaWriteTransaction</a><'a></h3></section></div><script src="../../implementors/kanidmd_lib/schema/trait.SchemaTransaction.js" async></script><script type="text/json" id="notable-traits-data">{"&Vec<AttrString>":"<h3>Notable traits for <code><a class=\"struct\" href=\"https://doc.rust-lang.org/1.69.0/alloc/vec/struct.Vec.html\" title=\"struct alloc::vec::Vec\">Vec</a><<a class=\"primitive\" href=\"https://doc.rust-lang.org/1.69.0/std/primitive.u8.html\">u8</a>, A></code></h3><pre><code><span class=\"where fmt-newline\">impl<A> <a class=\"trait\" href=\"https://doc.rust-lang.org/1.69.0/std/io/trait.Write.html\" title=\"trait std::io::Write\">Write</a> for <a class=\"struct\" href=\"https://doc.rust-lang.org/1.69.0/alloc/vec/struct.Vec.html\" title=\"struct alloc::vec::Vec\">Vec</a><<a class=\"primitive\" href=\"https://doc.rust-lang.org/1.69.0/std/primitive.u8.html\">u8</a>, A><span class=\"where fmt-newline\">where\n A: <a class=\"trait\" href=\"https://doc.rust-lang.org/1.69.0/core/alloc/trait.Allocator.html\" title=\"trait core::alloc::Allocator\">Allocator</a>,</span></span>","Vec<Result<(), ConsistencyError>>":"<h3>Notable traits for <code><a class=\"struct\" href=\"https://doc.rust-lang.org/1.69.0/alloc/vec/struct.Vec.html\" title=\"struct alloc::vec::Vec\">Vec</a><<a class=\"primitive\" href=\"https://doc.rust-lang.org/1.69.0/std/primitive.u8.html\">u8</a>, A></code></h3><pre><code><span class=\"where fmt-newline\">impl<A> <a class=\"trait\" href=\"https://doc.rust-lang.org/1.69.0/std/io/trait.Write.html\" title=\"trait std::io::Write\">Write</a> for <a class=\"struct\" href=\"https://doc.rust-lang.org/1.69.0/alloc/vec/struct.Vec.html\" title=\"struct alloc::vec::Vec\">Vec</a><<a class=\"primitive\" href=\"https://doc.rust-lang.org/1.69.0/std/primitive.u8.html\">u8</a>, A><span class=\"where fmt-newline\">where\n A: <a class=\"trait\" href=\"https://doc.rust-lang.org/1.69.0/core/alloc/trait.Allocator.html\" title=\"trait core::alloc::Allocator\">Allocator</a>,</span></span>"}</script></section></div></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> |