<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><metaname="viewport"content="width=device-width, initial-scale=1.0"><metaname="generator"content="rustdoc"><metaname="description"content="The Kanidmd server library. This implements all of the internal components of the server which is used to process authentication, store identities and enforce access controls."><metaname="keywords"content="rust, rustlang, rust-lang, kanidmd_lib"><title>kanidmd_lib - Rust</title><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../SourceSerif4-Regular.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../FiraSans-Regular.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../FiraSans-Medium.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../SourceCodePro-Regular.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../SourceSerif4-Bold.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../SourceCodePro-Semibold.ttf.woff2"><linkrel="stylesheet"href="../normalize.css"><linkrel="stylesheet"href="../rustdoc.css"id="mainThemeStyle"><linkrel="stylesheet"href="../ayu.css"disabled><linkrel="stylesheet"href="../dark.css"disabled><linkrel="stylesheet"href="../light.css"id="themeStyle"><scriptid="default-settings"></script><scriptsrc="../storage.js"></script><scriptdefersrc="../crates.js"></script><scriptdefersrc="../main.js"></script><noscript><linkrel="stylesheet"href="../noscript.css"></noscript><linkrel="alternate icon"type="image/png"href="../favicon-16x16.png"><linkrel="alternate icon"type="image/png"href="../favicon-32x32.png"><linkrel="icon"type="image/svg+xml"href="../favicon.svg"></head><bodyclass="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="mobile-topbar"><buttonclass="sidebar-menu-toggle">☰</button><aclass="sidebar-logo"href="../kanidmd_lib/index.html"><divclass="logo-container"><imgclass="rust-logo"src="../rust-logo.svg"alt="logo"></div></a><h2></h2></nav><navclass="sidebar"><aclass="sidebar-logo"href="../kanidmd_lib/index.html"><divclass="logo-container"><imgclass="rust-logo"src="../rust-logo.svg"alt="logo"></div></a><h2class="location"><ahref="#">Crate kanidmd_lib</a></h2><divclass="sidebar-elems"><ulclass="block"><liclass="version">Version 1.1.0-alpha.11-dev</li><li><aid="all-types"href="all.html">All Items</a></li></ul><section><ulclass="block"><li><ahref="#modules">Modules</a></li><li><ahref="#macros">Macros</a></li></ul></section></div></nav><main><divclass="width-limiter"><navclass="sub"><formclass="search-form"><span></span><inputclass="search-input"name="search"autocomplete="off"spellcheck="false"placeholder="Click or press ‘S’ to search, ‘?’ for more options…"type="search"><divid="help-button"title="help"tabindex="-1"><ahref="../help.html">?</a></div><divid="settings-menu"tabindex="-1"><ahref="../settings.html"title="settings"><imgwidth="22"height="22"alt="Change settings"src="../wheel.svg"></a></div></form></nav><sectionid="main-content"class="content"><divclass="main-heading"><h1class="fqn">Crate <aclass="mod"href="#">kanidmd_lib</a><buttonid="copy-path"onclick="copy_path(this)"title="Copy item path to clipboard"><imgsrc="../clipboard.svg"width="19"height="18"alt="Copy item path"></button></h1><spanclass="out-of-band"><aclass="srclink"href="../src/kanidmd_lib/lib.rs.html#1-101">source</a> · <aid="toggle-all-docs"href="javascript:void(0)"title="collapse all docs">[<spanclass="inner">−</span>]</a></span></div><detailsclass="rustdoc-toggle top-doc"open><summaryclass="hideme"><span>Expand description</span></summary><divclass="docblock"><p>The Kanidmd server library. This implements all of the internal components of the server
</div></details><h2id="modules"class="small-section-header"><ahref="#modules">Modules</a></h2><divclass="item-table"><divclass="item-row"><divclass="item-left module-item"><aclass="mod"href="be/index.html"title="kanidmd_lib::be mod">be</a></div><divclass="item-right docblock-short">The backend. This contains the “low level” storage and query code, which is
utilising indexes in the most effective way possible.</div></div><divclass="item-row"><divclass="item-left module-item"><aclass="mod"href="constants/index.html"title="kanidmd_lib::constants mod">constants</a></div></div><divclass="item-row"><divclass="item-left module-item"><aclass="mod"href="credential/index.html"title="kanidmd_lib::credential mod">credential</a></div></div><divclass="item-row"><divclass="item-left module-item"><aclass="mod"href="entry/index.html"title="kanidmd_lib::entry mod">entry</a></div><divclass="item-right docblock-short">Entries are the base unit of object storage in the server. This is one of the three foundational
concepts along with <ahref="../filter/index.html"><code>filter</code></a>s and <ahref="../schema/index.html"><code>schema</code></a> that everything else builds upon.</div></div><divclass="item-row"><divclass="item-left module-item"><aclass="mod"href="event/index.html"title="kanidmd_lib::event mod">event</a></div><divclass="item-right docblock-short">An <code>event</code> is a self contained module of data, that contains all of the
types of potential events, they all eventually lower to one of:</div></div><divclass="item-row"><divclass="item-left module-item"><aclass="mod"href="filter/index.html"title="kanidmd_lib::filter mod">filter</a></div><divclass="item-right docblock-short"><ahref="struct.Filter.html"><code>Filter</code></a>s are one of the three foundational concepts of the design in kanidm.
datasets and assertion of entry properties.</div></div><divclass="item-row"><divclass="item-left module-item"><aclass="mod"href="idm/index.html"title="kanidmd_lib::idm mod">idm</a></div><divclass="item-right docblock-short">The Identity Management components that are layered on top of the <ahref="server/struct.QueryServer.html">QueryServer</a>. These allow
is implemented.</div></div><divclass="item-row"><divclass="item-left module-item"><aclass="mod"href="macros/index.html"title="kanidmd_lib::macros mod">macros</a></div></div><divclass="item-row"><divclass="item-left module-item"><aclass="mod"href="modify/index.html"title="kanidmd_lib::modify mod">modify</a></div><divclass="item-right docblock-short">Modification expressions and validation. This is how <code>ModifyEvents</code> store and
as “states” on what attribute-values should appear as within the <code>Entry</code></div></div><divclass="item-row"><divclass="item-left module-item"><aclass="mod"href="prelude/index.html"title="kanidmd_lib::prelude mod">prelude</a></div><divclass="item-right docblock-short">A prelude of imports that should be imported by all other Kanidm modules to
help make imports cleaner.</div></div><divclass="item-row"><divclass="item-left module-item"><aclass="mod"href="schema/index.html"title="kanidmd_lib::schema mod">schema</a></div><divclass="item-right docblock-short"><ahref="struct.Schema.html"><code>Schema</code></a> is one of the foundational concepts of the server. It provides a
which enables many other parts to function.</div></div><divclass="item-row"><divclass="item-left module-item"><aclass="mod"href="server/index.html"title="kanidmd_lib::server mod">server</a></div><divclass="item-right docblock-short"><code>server</code> contains the query server, which is the main high level construction
to coordinate queries and operations in the server.</div></div><divclass="item-row"><divclass="item-left module-item"><aclass="mod"href="status/index.html"title="kanidmd_lib::status mod">status</a></div><divclass="item-right docblock-short">An actor that shows the servers current status and statistics. (TODO).</div></div><divclass="item-row"><divclass="item-left module-item"><aclass="mod"href="testkit/index.html"title="kanidmd_lib::testkit mod">testkit</a></div></div><divclass="item-row"><divclass="item-left module-item"><aclass="mod"href="utils/index.html"title="kanidmd_lib::utils mod">utils</a></div></div><divclass="item-row"><divclass="item-left module-item"><aclass="mod"href="value/index.html"title="kanidmd_lib::value mod">value</a></div><divclass="item-right docblock-short">Inside an entry, the key-value pairs are stored in these <ahref="value/enum.Value.html"title="Value"><code>Value</code></a> types. The components of
