kanidm/stable/rustdoc/kanidmd_lib/value/index.html
2023-05-06 08:35:24 +00:00

9 lines
9.2 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="Inside an entry, the key-value pairs are stored in these `Value` types. The components of the `Value` module allow storage and transformation of various types of input into strongly typed values, allows their comparison, filtering and more. It also has the code for serialising these into a form for the backend that can be persistent into the `Backend`."><title>kanidmd_lib::value - 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="../../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 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">&#9776;</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="#">Module value</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</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" 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>Module <a href="../index.html">kanidmd_lib</a>::<wbr><a class="mod" href="#">value</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/value.rs.html#1-1986">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Inside an entry, the key-value pairs are stored in these <a href="enum.Value.html" title="enum kanidmd_lib::value::Value"><code>Value</code></a> types. The components of
the <a href="enum.Value.html" title="enum kanidmd_lib::value::Value"><code>Value</code></a> module allow storage and transformation of various types of input into strongly
typed values, allows their comparison, filtering and more. It also has the code for serialising
these into a form for the backend that can be persistent into the <a href="../be/struct.Backend.html" title="struct kanidmd_lib::be::Backend"><code>Backend</code></a>.</p>
</div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.Address.html" title="struct kanidmd_lib::value::Address">Address</a></div></li><li><div class="item-name"><a class="struct" href="struct.ApiToken.html" title="struct kanidmd_lib::value::ApiToken">ApiToken</a></div></li><li><div class="item-name"><a class="struct" href="struct.DISALLOWED_NAMES.html" title="struct kanidmd_lib::value::DISALLOWED_NAMES">DISALLOWED_NAMES</a></div></li><li><div class="item-name"><a class="struct" href="struct.EXTRACT_VAL_DN.html" title="struct kanidmd_lib::value::EXTRACT_VAL_DN">EXTRACT_VAL_DN</a></div></li><li><div class="item-name"><a class="struct" href="struct.INAME_RE.html" title="struct kanidmd_lib::value::INAME_RE">INAME_RE</a></div><div class="desc docblock-short">Only lowercase+numbers, with limited chars.</div></li><li><div class="item-name"><a class="struct" href="struct.NSUNIQUEID_RE.html" title="struct kanidmd_lib::value::NSUNIQUEID_RE">NSUNIQUEID_RE</a></div></li><li><div class="item-name"><a class="struct" href="struct.OAUTHSCOPE_RE.html" title="struct kanidmd_lib::value::OAUTHSCOPE_RE">OAUTHSCOPE_RE</a></div><div class="desc docblock-short">Must not contain whitespace.</div></li><li><div class="item-name"><a class="struct" href="struct.Oauth2Session.html" title="struct kanidmd_lib::value::Oauth2Session">Oauth2Session</a></div></li><li><div class="item-name"><a class="struct" href="struct.SINGLELINE_RE.html" title="struct kanidmd_lib::value::SINGLELINE_RE">SINGLELINE_RE</a></div></li><li><div class="item-name"><a class="struct" href="struct.SPN_RE.html" title="struct kanidmd_lib::value::SPN_RE">SPN_RE</a></div></li><li><div class="item-name"><a class="struct" href="struct.Session.html" title="struct kanidmd_lib::value::Session">Session</a></div></li><li><div class="item-name"><a class="struct" href="struct.UNICODE_CONTROL_RE.html" title="struct kanidmd_lib::value::UNICODE_CONTROL_RE">UNICODE_CONTROL_RE</a></div></li><li><div class="item-name"><a class="struct" href="struct.VALIDATE_EMAIL_RE.html" title="struct kanidmd_lib::value::VALIDATE_EMAIL_RE">VALIDATE_EMAIL_RE</a></div><div class="desc docblock-short">Per https://html.spec.whatwg.org/multipage/input.html#valid-e-mail-address
this regex validates for valid emails.</div></li></ul><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.ApiTokenScope.html" title="enum kanidmd_lib::value::ApiTokenScope">ApiTokenScope</a></div></li><li><div class="item-name"><a class="enum" href="enum.IndexType.html" title="enum kanidmd_lib::value::IndexType">IndexType</a></div></li><li><div class="item-name"><a class="enum" href="enum.IntentTokenState.html" title="enum kanidmd_lib::value::IntentTokenState">IntentTokenState</a></div></li><li><div class="item-name"><a class="enum" href="enum.PartialValue.html" title="enum kanidmd_lib::value::PartialValue">PartialValue</a></div><div class="desc docblock-short">A partial value is a key or key subset that can be used to match for equality or substring
against a complete Value within a set in an Entry.</div></li><li><div class="item-name"><a class="enum" href="enum.SessionScope.html" title="enum kanidmd_lib::value::SessionScope">SessionScope</a></div></li><li><div class="item-name"><a class="enum" href="enum.SyntaxType.html" title="enum kanidmd_lib::value::SyntaxType">SyntaxType</a></div></li><li><div class="item-name"><a class="enum" href="enum.Value.html" title="enum kanidmd_lib::value::Value">Value</a></div><div class="desc docblock-short">A value is a complete unit of data for an attribute. It is made up of a PartialValue, which is
used for selection, filtering, searching, matching etc. It also contains supplemental data
which may be stored inside of the Value, such as credential secrets, blobs etc.</div></li></ul></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>