mirror of
https://github.com/kanidm/kanidm.git
synced 2025-02-24 21:17:01 +01:00
12 lines
23 KiB
HTML
12 lines
23 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`."><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="../../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 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 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="sidebar-logo" href="../../kanidmd_lib/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="../../kanidmd_lib/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">SchemaTransaction</a></h2><div class="sidebar-elems"><section><div class="block"><h3 class="sidebar-title"><a href="#required-methods">Required Methods</a></h3><ul><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></div><div class="block"><h3 class="sidebar-title"><a href="#provided-methods">Provided Methods</a></h3><ul><li><a href="#method.is_multivalue">is_multivalue</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></div><div class="block"><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div></section><h2 class="location"><a href="index.html">In kanidmd_lib::schema</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../kanidmd_lib/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><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"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">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" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/kanidmd_lib/schema.rs.html#412-548">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust trait"><code>pub trait SchemaTransaction {
|
||
fn <a href="#tymethod.get_classes" class="fnname">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="fnname">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="fnname">get_attributes_unique</a>(&self) -> &<a class="struct" href="https://doc.rust-lang.org/1.64.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>><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<span class="notable-traits-tooltiptext"><span class="docblock"><span class="notable">Notable traits for <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u8.html">u8</a>, A></span><code class="content"><span class="where fmt-newline">impl<A> <a class="trait" href="https://doc.rust-lang.org/1.64.0/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u8.html">u8</a>, A> <span class="where fmt-newline">where<br> A: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/alloc/trait.Allocator.html" title="trait core::alloc::Allocator">Allocator</a>, </span></span></code></span></span></span></span>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.get_reference_types" class="fnname">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>>;
|
||
|
||
fn <a href="#method.validate" class="fnname">validate</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.unit.html">()</a>, <a class="enum" href="../prelude/enum.ConsistencyError.html" title="enum kanidmd_lib::prelude::ConsistencyError">ConsistencyError</a>>><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<span class="notable-traits-tooltiptext"><span class="docblock"><span class="notable">Notable traits for <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u8.html">u8</a>, A></span><code class="content"><span class="where fmt-newline">impl<A> <a class="trait" href="https://doc.rust-lang.org/1.64.0/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u8.html">u8</a>, A> <span class="where fmt-newline">where<br> A: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/alloc/trait.Allocator.html" title="trait core::alloc::Allocator">Allocator</a>, </span></span></code></span></span></span></span> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.is_multivalue" class="fnname">is_multivalue</a>(&self, attr: &<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.bool.html">bool</a>, <a class="enum" href="../../kanidm_proto/v1/enum.SchemaError.html" title="enum kanidm_proto::v1::SchemaError">SchemaError</a>> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.normalise_attr_name" class="fnname">normalise_attr_name</a>(&self, an: &<a class="primitive" href="https://doc.rust-lang.org/1.64.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="fnname">normalise_attr_if_exists</a>(&self, an: &<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.64.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="fnname">query_attrs_difference</a>(<br> &self,<br> 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.64.0/std/primitive.str.html">str</a>>,<br> 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.64.0/std/primitive.str.html">str</a>><br> ) -> <a class="enum" href="https://doc.rust-lang.org/1.64.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.64.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.64.0/std/primitive.str.html">str</a>>), <a class="enum" href="../../kanidm_proto/v1/enum.SchemaError.html" title="enum kanidm_proto::v1::SchemaError">SchemaError</a>> { ... }
|
||
}</code></pre></div><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><div id="tymethod.get_classes" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/kanidmd_lib/schema.rs.html#413">source</a></div><h4 class="code-header">fn <a href="#tymethod.get_classes" class="fnname">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></div><div id="tymethod.get_attributes" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/kanidmd_lib/schema.rs.html#414">source</a></div><h4 class="code-header">fn <a href="#tymethod.get_attributes" class="fnname">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></div><div id="tymethod.get_attributes_unique" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/kanidmd_lib/schema.rs.html#416">source</a></div><h4 class="code-header">fn <a href="#tymethod.get_attributes_unique" class="fnname">get_attributes_unique</a>(&self) -> &<a class="struct" href="https://doc.rust-lang.org/1.64.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>><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<span class="notable-traits-tooltiptext"><span class="docblock"><span class="notable">Notable traits for <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u8.html">u8</a>, A></span><code class="content"><span class="where fmt-newline">impl<A> <a class="trait" href="https://doc.rust-lang.org/1.64.0/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u8.html">u8</a>, A> <span class="where fmt-newline">where<br> A: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/alloc/trait.Allocator.html" title="trait core::alloc::Allocator">Allocator</a>, </span></span></code></span></span></span></span></h4></div><div id="tymethod.get_reference_types" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/kanidmd_lib/schema.rs.html#417">source</a></div><h4 class="code-header">fn <a href="#tymethod.get_reference_types" class="fnname">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></div></div><h2 id="provided-methods" class="small-section-header">Provided Methods<a href="#provided-methods" class="anchor"></a></h2><div class="methods"><div id="method.validate" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/kanidmd_lib/schema.rs.html#419-471">source</a></div><h4 class="code-header">fn <a href="#method.validate" class="fnname">validate</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.unit.html">()</a>, <a class="enum" href="../prelude/enum.ConsistencyError.html" title="enum kanidmd_lib::prelude::ConsistencyError">ConsistencyError</a>>><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<span class="notable-traits-tooltiptext"><span class="docblock"><span class="notable">Notable traits for <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u8.html">u8</a>, A></span><code class="content"><span class="where fmt-newline">impl<A> <a class="trait" href="https://doc.rust-lang.org/1.64.0/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u8.html">u8</a>, A> <span class="where fmt-newline">where<br> A: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/alloc/trait.Allocator.html" title="trait core::alloc::Allocator">Allocator</a>, </span></span></code></span></span></span></span></h4></div><div id="method.is_multivalue" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/kanidmd_lib/schema.rs.html#473-481">source</a></div><h4 class="code-header">fn <a href="#method.is_multivalue" class="fnname">is_multivalue</a>(&self, attr: &<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.bool.html">bool</a>, <a class="enum" href="../../kanidm_proto/v1/enum.SchemaError.html" title="enum kanidm_proto::v1::SchemaError">SchemaError</a>></h4></div><div id="method.normalise_attr_name" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/kanidmd_lib/schema.rs.html#483-486">source</a></div><h4 class="code-header">fn <a href="#method.normalise_attr_name" class="fnname">normalise_attr_name</a>(&self, an: &<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.str.html">str</a>) -> <a class="type" href="../prelude/type.AttrString.html" title="type kanidmd_lib::prelude::AttrString">AttrString</a></h4></div><div id="method.normalise_attr_if_exists" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/kanidmd_lib/schema.rs.html#488-494">source</a></div><h4 class="code-header">fn <a href="#method.normalise_attr_if_exists" class="fnname">normalise_attr_if_exists</a>(&self, an: &<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.64.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></div><div id="method.query_attrs_difference" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/kanidmd_lib/schema.rs.html#496-547">source</a></div><h4 class="code-header">fn <a href="#method.query_attrs_difference" class="fnname">query_attrs_difference</a>(<br> &self,<br> 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.64.0/std/primitive.str.html">str</a>>,<br> 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.64.0/std/primitive.str.html">str</a>><br>) -> <a class="enum" href="https://doc.rust-lang.org/1.64.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.64.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.64.0/std/primitive.str.html">str</a>>), <a class="enum" href="../../kanidm_proto/v1/enum.SchemaError.html" title="enum kanidm_proto::v1::SchemaError">SchemaError</a>></h4></div></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"><section id="impl-SchemaTransaction-for-SchemaReadTransaction" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/kanidmd_lib/schema.rs.html#1552-1568">source</a></span><a href="#impl-SchemaTransaction-for-SchemaReadTransaction" class="anchor"></a><h3 class="code-header in-band">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%27a%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/kanidmd_lib/schema.rs.html#1534-1550">source</a></span><a href="#impl-SchemaTransaction-for-SchemaWriteTransaction%3C%27a%3E" class="anchor"></a><h3 class="code-header in-band">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 type="text/javascript" src="../../implementors/kanidmd_lib/schema/trait.SchemaTransaction.js" data-ignore-extern-crates="" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="kanidmd_lib" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html> |