mirror of
https://github.com/kanidm/kanidm.git
synced 2025-02-24 21:17:01 +01:00
20 lines
8.6 KiB
HTML
20 lines
8.6 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="Entries are the base unit of object storage in the server. This is one of the three foundational concepts along with `filter`s and `schema` that everything else builds upon."><meta name="keywords" content="rust, rustlang, rust-lang, entry"><title>kanidmd_lib::entry - 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" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.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 mod"><!--[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></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="#">Module entry</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#types">Type Definitions</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><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"><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="../../wheel.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Module <a href="../index.html">kanidmd_lib</a>::<wbr><a class="mod" href="#">entry</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></h1><span class="out-of-band"><a class="srclink" href="../../src/kanidmd_lib/entry.rs.html#1-3057">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Entries are the base unit of object storage in the server. This is one of the three foundational
|
||
concepts along with <a href="../filter/index.html"><code>filter</code></a>s and <a href="../schema/index.html"><code>schema</code></a> that everything else builds upon.</p>
|
||
<p>An <a href="struct.Entry.html"><code>Entry</code></a> is a collection of attribute-value sets. There are sometimes called attribute value
|
||
assertions, or AVAs. The attribute is a “key” and it holds 1 to infinite associated values
|
||
with no ordering. An entry has many AVAs. A pseudo example, minus schema and typing:</p>
|
||
<div class="example-wrap"><pre class="language-text"><code>Entry {
|
||
"name": ["william"],
|
||
"uuid": ["..."],
|
||
"mail": ["maila@example.com", "mailb@example.com"],
|
||
};
|
||
</code></pre></div>
|
||
<p>There are three rules for entries:</p>
|
||
<ul>
|
||
<li>Must have an AVA for UUID containing a single value.</li>
|
||
<li>Any AVA with zero values will be removed.</li>
|
||
<li>AVAs are stored with no sorting.</li>
|
||
</ul>
|
||
<p>For more, see the <a href="struct.Entry.html"><code>Entry</code></a> type.</p>
|
||
</div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Entry.html" title="kanidmd_lib::entry::Entry struct">Entry</a></div><div class="item-right docblock-short">Entry is the core data storage type of the server. Almost every aspect of the server is
|
||
designed to read, handle and manipulate entries.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.EntryCommitted.html" title="kanidmd_lib::entry::EntryCommitted struct">EntryCommitted</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.EntryInit.html" title="kanidmd_lib::entry::EntryInit struct">EntryInit</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.EntryInvalid.html" title="kanidmd_lib::entry::EntryInvalid struct">EntryInvalid</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.EntryNew.html" title="kanidmd_lib::entry::EntryNew struct">EntryNew</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.EntryReduced.html" title="kanidmd_lib::entry::EntryReduced struct">EntryReduced</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.EntrySealed.html" title="kanidmd_lib::entry::EntrySealed struct">EntrySealed</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.EntryValid.html" title="kanidmd_lib::entry::EntryValid struct">EntryValid</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Set.html" title="kanidmd_lib::entry::Set struct">Set</a></div><div class="item-right docblock-short">An ordered set based on a B-Tree.</div></div></div><h2 id="types" class="small-section-header"><a href="#types">Type Definitions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="type" href="type.Eattrs.html" title="kanidmd_lib::entry::Eattrs type">Eattrs</a></div></div><div class="item-row"><div class="item-left module-item"><a class="type" href="type.EntryInitNew.html" title="kanidmd_lib::entry::EntryInitNew type">EntryInitNew</a></div></div><div class="item-row"><div class="item-left module-item"><a class="type" href="type.EntryInvalidCommitted.html" title="kanidmd_lib::entry::EntryInvalidCommitted type">EntryInvalidCommitted</a></div></div><div class="item-row"><div class="item-left module-item"><a class="type" href="type.EntryInvalidNew.html" title="kanidmd_lib::entry::EntryInvalidNew type">EntryInvalidNew</a></div></div><div class="item-row"><div class="item-left module-item"><a class="type" href="type.EntryReducedCommitted.html" title="kanidmd_lib::entry::EntryReducedCommitted type">EntryReducedCommitted</a></div></div><div class="item-row"><div class="item-left module-item"><a class="type" href="type.EntrySealedCommitted.html" title="kanidmd_lib::entry::EntrySealedCommitted type">EntrySealedCommitted</a></div></div><div class="item-row"><div class="item-left module-item"><a class="type" href="type.EntrySealedNew.html" title="kanidmd_lib::entry::EntrySealedNew type">EntrySealedNew</a></div></div><div class="item-row"><div class="item-left module-item"><a class="type" href="type.EntryTuple.html" title="kanidmd_lib::entry::EntryTuple type">EntryTuple</a></div></div></div></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.66.1 (90743e729 2023-01-10)" ></div></body></html> |