kanidm/stable/rustdoc/doc/kanidmd_core/index.html
2023-05-06 13:48:03 +00:00

12 lines
9 KiB
HTML
Raw Permalink 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="These contain the server “cores”. These are able to startup the server (bootstrap) to a running state and then execute tasks. This is where modules are logically ordered based on their depenedncies for execution. Some of these are task-only i.e. reindexing, and some of these launch the server into a fully operational state (https, ldap, etc)."><title>kanidmd_core - 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="../crates.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 crate"><!--[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_core/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_core/index.html"><img class="rust-logo" src="../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2 class="location"><a href="#">Crate kanidmd_core</a></h2><div class="sidebar-elems"><ul class="block"><li class="version">Version 1.1.0-alpha.12</li><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#functions">Functions</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>Crate <a class="mod" href="#">kanidmd_core</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_core/lib.rs.html#1-830">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>These contain the server “cores”. These are able to startup the server
(bootstrap) to a running state and then execute tasks. This is where modules
are logically ordered based on their depenedncies for execution. Some of these
are task-only i.e. reindexing, and some of these launch the server into a
fully operational state (https, ldap, etc).</p>
<p>Generally, this is the “entry point” where the server begins to run, and
the entry point for all client traffic which is then directed to the
various <code>actors</code>.</p>
</div></details><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="actors/index.html" title="mod kanidmd_core::actors">actors</a></div><div class="desc docblock-short">This module contains the servers async tasks that are called from the various frontend
components to conduct operations. These are separated based on protocol versions and
if they are read or write transactions internally.</div></li><li><div class="item-name"><a class="mod" href="config/index.html" title="mod kanidmd_core::config">config</a></div><div class="desc docblock-short">The server configuration as processed from the startup wrapper. This controls a number of
variables that determine how our backends, query server, and frontends are configured.</div></li><li><div class="item-name"><a class="mod" href="https/index.html" title="mod kanidmd_core::https">https</a></div></li></ul><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.CoreHandle.html" title="struct kanidmd_core::CoreHandle">CoreHandle</a></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.CoreAction.html" title="enum kanidmd_core::CoreAction">CoreAction</a></div></li></ul><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.backup_server_core.html" title="fn kanidmd_core::backup_server_core">backup_server_core</a></div></li><li><div class="item-name"><a class="fn" href="fn.create_server_core.html" title="fn kanidmd_core::create_server_core">create_server_core</a></div></li><li><div class="item-name"><a class="fn" href="fn.dbscan_get_id2entry_core.html" title="fn kanidmd_core::dbscan_get_id2entry_core">dbscan_get_id2entry_core</a></div></li><li><div class="item-name"><a class="fn" href="fn.dbscan_list_id2entry_core.html" title="fn kanidmd_core::dbscan_list_id2entry_core">dbscan_list_id2entry_core</a></div></li><li><div class="item-name"><a class="fn" href="fn.dbscan_list_index_analysis_core.html" title="fn kanidmd_core::dbscan_list_index_analysis_core">dbscan_list_index_analysis_core</a></div></li><li><div class="item-name"><a class="fn" href="fn.dbscan_list_index_core.html" title="fn kanidmd_core::dbscan_list_index_core">dbscan_list_index_core</a></div></li><li><div class="item-name"><a class="fn" href="fn.dbscan_list_indexes_core.html" title="fn kanidmd_core::dbscan_list_indexes_core">dbscan_list_indexes_core</a></div></li><li><div class="item-name"><a class="fn" href="fn.domain_rename_core.html" title="fn kanidmd_core::domain_rename_core">domain_rename_core</a></div></li><li><div class="item-name"><a class="fn" href="fn.recover_account_core.html" title="fn kanidmd_core::recover_account_core">recover_account_core</a></div></li><li><div class="item-name"><a class="fn" href="fn.reindex_server_core.html" title="fn kanidmd_core::reindex_server_core">reindex_server_core</a></div></li><li><div class="item-name"><a class="fn" href="fn.restore_server_core.html" title="fn kanidmd_core::restore_server_core">restore_server_core</a></div></li><li><div class="item-name"><a class="fn" href="fn.vacuum_server_core.html" title="fn kanidmd_core::vacuum_server_core">vacuum_server_core</a></div></li><li><div class="item-name"><a class="fn" href="fn.verify_server_core.html" title="fn kanidmd_core::verify_server_core">verify_server_core</a></div></li></ul></section></div></main><div id="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="kanidmd_core" 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>