mirror of
https://github.com/kanidm/kanidm.git
synced 2025-02-24 21:17:01 +01:00
17 lines
7.5 KiB
HTML
17 lines
7.5 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="An `event` is a self contained module of data, that contains all of the required information for any operation to proceed. While there are many types of potential events, they all eventually lower to one of:"><meta name="keywords" content="rust, rustlang, rust-lang, event"><title>kanidmd_lib::event - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-1f7d512b176f0f72.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-124a1ca42af929b6.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-93196c7a1c3542a8.css" id="mainThemeStyle"><link rel="stylesheet" id="themeStyle" href="../../static.files/light-4743e13df3dfe8c4.css"><link rel="stylesheet" disabled href="../../static.files/dark-0e1b889528bd466b.css"><link rel="stylesheet" disabled href="../../static.files/ayu-65289d5d067c7c66.css"><script id="default-settings" ></script><script src="../../static.files/storage-d43fa987303ecbbb.js"></script><script defer src="../../static.files/main-3367e395607fafc1.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">☰</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 event</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</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-5ec35bf9ca753509.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="#">event</a><button id="copy-path" onclick="copy_path(this)" 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/event.rs.html#1-821">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>An <code>event</code> is a self contained module of data, that contains all of the
|
||
required information for any operation to proceed. While there are many
|
||
types of potential events, they all eventually lower to one of:</p>
|
||
<ul>
|
||
<li>AuthEvent</li>
|
||
<li>SearchEvent</li>
|
||
<li>ExistsEvent</li>
|
||
<li>ModifyEvent</li>
|
||
<li>CreateEvent</li>
|
||
<li>DeleteEvent</li>
|
||
</ul>
|
||
<p>An “event” is generally then passed to the <code>QueryServer</code> for processing.
|
||
By making these fully self contained units, it means that we can assert
|
||
at event creation time we have all the correct data required to proceed
|
||
with the operation, and a clear path to know how to transform events between
|
||
various types.</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.CreateEvent.html" title="kanidmd_lib::event::CreateEvent struct">CreateEvent</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.DeleteEvent.html" title="kanidmd_lib::event::DeleteEvent struct">DeleteEvent</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ExistsEvent.html" title="kanidmd_lib::event::ExistsEvent struct">ExistsEvent</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ModifyEvent.html" title="kanidmd_lib::event::ModifyEvent struct">ModifyEvent</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.OnlineBackupEvent.html" title="kanidmd_lib::event::OnlineBackupEvent struct">OnlineBackupEvent</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.PurgeRecycledEvent.html" title="kanidmd_lib::event::PurgeRecycledEvent struct">PurgeRecycledEvent</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.PurgeTombstoneEvent.html" title="kanidmd_lib::event::PurgeTombstoneEvent struct">PurgeTombstoneEvent</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ReviveRecycledEvent.html" title="kanidmd_lib::event::ReviveRecycledEvent struct">ReviveRecycledEvent</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.SearchEvent.html" title="kanidmd_lib::event::SearchEvent struct">SearchEvent</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.SearchResult.html" title="kanidmd_lib::event::SearchResult struct">SearchResult</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.WhoamiResult.html" title="kanidmd_lib::event::WhoamiResult struct">WhoamiResult</a></div></div></div></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.68.0 (2c8cc3432 2023-03-06)" data-search-js="search-98d53477a794af0b.js" data-settings-js="settings-c3c521c753752a1a.js" data-settings-css="settings-08ddfdda51b8ee2e.css" ></div></body></html> |