kanidm/master/rustdoc/doc/pam_kanidm/module/trait.PamItem.html
2023-05-06 13:48:03 +00:00

12 lines
10 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="Type-level mapping for safely retrieving values with `get_item`."><title>PamItem in pam_kanidm::module - 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="sidebar-items.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 trait"><!--[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="../../pam_kanidm/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="../../pam_kanidm/index.html"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2 class="location"><a href="#">PamItem</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.item_type">item_type</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In pam_kanidm::module</a></h2></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>Trait <a href="../index.html">pam_kanidm</a>::<wbr><a href="index.html">module</a>::<wbr><a class="trait" href="#">PamItem</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/pam_kanidm/pam/module.rs.html#73-81">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub trait PamItem {
// Required method
fn <a href="#tymethod.item_type" class="fn">item_type</a>() -&gt; <a class="type" href="../constants/type.PamItemType.html" title="type pam_kanidm::constants::PamItemType">PamItemType</a>;
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Type-level mapping for safely retrieving values with <code>get_item</code>.</p>
<p>See <code>pam_get_item</code> in
<a href="http://www.linux-pam.org/Linux-PAM-html/mwg-expected-by-module-item.html">http://www.linux-pam.org/Linux-PAM-html/mwg-expected-by-module-item.html</a></p>
</div></details><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.item_type" class="method"><a class="srclink rightside" href="../../src/pam_kanidm/pam/module.rs.html#80">source</a><h4 class="code-header">fn <a href="#tymethod.item_type" class="fn">item_type</a>() -&gt; <a class="type" href="../constants/type.PamItemType.html" title="type pam_kanidm::constants::PamItemType">PamItemType</a></h4></section></summary><div class="docblock"><p>Maps a Rust type to a pam constant.</p>
<p>For example, the type PamConv maps to the constant PAM_CONV. The pam
API contract specifies that when the API function <code>pam_get_item</code> is
called with the constant PAM_CONV, it will return a value of type
<code>PamConv</code>.</p>
</div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-PamItem-for-PamConv" class="impl"><a class="srclink rightside" href="../../src/pam_kanidm/pam/conv.rs.html#81-85">source</a><a href="#impl-PamItem-for-PamConv" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.PamItem.html" title="trait pam_kanidm::module::PamItem">PamItem</a> for <a class="struct" href="../conv/struct.PamConv.html" title="struct pam_kanidm::conv::PamConv">PamConv</a></h3></section><section id="impl-PamItem-for-PamAuthTok" class="impl"><a class="srclink rightside" href="../../src/pam_kanidm/pam/items.rs.html#65-69">source</a><a href="#impl-PamItem-for-PamAuthTok" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.PamItem.html" title="trait pam_kanidm::module::PamItem">PamItem</a> for <a class="struct" href="../items/struct.PamAuthTok.html" title="struct pam_kanidm::items::PamAuthTok">PamAuthTok</a></h3></section><section id="impl-PamItem-for-PamOldAuthTok" class="impl"><a class="srclink rightside" href="../../src/pam_kanidm/pam/items.rs.html#74-78">source</a><a href="#impl-PamItem-for-PamOldAuthTok" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.PamItem.html" title="trait pam_kanidm::module::PamItem">PamItem</a> for <a class="struct" href="../items/struct.PamOldAuthTok.html" title="struct pam_kanidm::items::PamOldAuthTok">PamOldAuthTok</a></h3></section><section id="impl-PamItem-for-PamRHost" class="impl"><a class="srclink rightside" href="../../src/pam_kanidm/pam/items.rs.html#56-60">source</a><a href="#impl-PamItem-for-PamRHost" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.PamItem.html" title="trait pam_kanidm::module::PamItem">PamItem</a> for <a class="struct" href="../items/struct.PamRHost.html" title="struct pam_kanidm::items::PamRHost">PamRHost</a></h3></section><section id="impl-PamItem-for-PamRUser" class="impl"><a class="srclink rightside" href="../../src/pam_kanidm/pam/items.rs.html#47-51">source</a><a href="#impl-PamItem-for-PamRUser" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.PamItem.html" title="trait pam_kanidm::module::PamItem">PamItem</a> for <a class="struct" href="../items/struct.PamRUser.html" title="struct pam_kanidm::items::PamRUser">PamRUser</a></h3></section><section id="impl-PamItem-for-PamService" class="impl"><a class="srclink rightside" href="../../src/pam_kanidm/pam/items.rs.html#11-15">source</a><a href="#impl-PamItem-for-PamService" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.PamItem.html" title="trait pam_kanidm::module::PamItem">PamItem</a> for <a class="struct" href="../items/struct.PamService.html" title="struct pam_kanidm::items::PamService">PamService</a></h3></section><section id="impl-PamItem-for-PamTty" class="impl"><a class="srclink rightside" href="../../src/pam_kanidm/pam/items.rs.html#38-42">source</a><a href="#impl-PamItem-for-PamTty" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.PamItem.html" title="trait pam_kanidm::module::PamItem">PamItem</a> for <a class="struct" href="../items/struct.PamTty.html" title="struct pam_kanidm::items::PamTty">PamTty</a></h3></section><section id="impl-PamItem-for-PamUser" class="impl"><a class="srclink rightside" href="../../src/pam_kanidm/pam/items.rs.html#20-24">source</a><a href="#impl-PamItem-for-PamUser" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.PamItem.html" title="trait pam_kanidm::module::PamItem">PamItem</a> for <a class="struct" href="../items/struct.PamUser.html" title="struct pam_kanidm::items::PamUser">PamUser</a></h3></section><section id="impl-PamItem-for-PamUserPrompt" class="impl"><a class="srclink rightside" href="../../src/pam_kanidm/pam/items.rs.html#29-33">source</a><a href="#impl-PamItem-for-PamUserPrompt" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.PamItem.html" title="trait pam_kanidm::module::PamItem">PamItem</a> for <a class="struct" href="../items/struct.PamUserPrompt.html" title="struct pam_kanidm::items::PamUserPrompt">PamUserPrompt</a></h3></section></div><script src="../../implementors/pam_kanidm/pam/module/trait.PamItem.js" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="pam_kanidm" 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>