index.html 5.9 KB

123456789101112131415
  1. <!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="API documentation for the Rust `auth` crate."><meta name="keywords" content="rust, rustlang, rust-lang, auth"><title>auth - 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" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script src="../crates.js"></script><script defer src="../main.js"></script>
  2. <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 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="sidebar-logo" href="../auth/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div>
  3. </a><h2 class="location"></h2>
  4. </nav>
  5. <nav class="sidebar"><a class="sidebar-logo" href="../auth/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div>
  6. </a><h2 class="location"><a href="#">Crate auth</a></h2><div class="sidebar-elems"><div class="block"><ul><li class="version">Version 0.1.0</li><li><a id="all-types" href="all.html">All Items</a></li></ul></div><section><div class="block"><ul><li><a href="#enums">Enums</a></li><li><a href="#functions">Functions</a></li></ul></div></section><div id="sidebar-vars" data-name="auth" data-ty="mod" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../auth/index.html"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><button type="button" id="help-button" title="help">?</button><div id="settings-menu" tabindex="-1">
  7. <a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div>
  8. </div></form></nav></div><section id="main-content" class="content"><div class="main-heading">
  9. <h1 class="fqn"><span class="in-band">Crate <a class="mod" href="#">auth</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></span></h1><span class="out-of-band"><a class="srclink" href="../src/auth/lib.rs.html#1-99">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2>
  10. <div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.AuthError.html" title="auth::AuthError enum">AuthError</a></div><div class="item-right docblock-short"></div></div></div><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2>
  11. <div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.generate_key.html" title="auth::generate_key fn">generate_key</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.set_key.html" title="auth::set_key fn">set_key</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.set_key_fallible.html" title="auth::set_key_fallible fn">set_key_fallible</a></div><div class="item-right docblock-short"><p>This function should only be called from tests</p>
  12. </div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.user_cookie_decode.html" title="auth::user_cookie_decode fn">user_cookie_decode</a></div><div class="item-right docblock-short"><p>Function decrypts a UserID which was encrypted with <code>user_cookie_generate</code></p>
  13. </div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.user_cookie_generate.html" title="auth::user_cookie_generate fn">user_cookie_generate</a></div><div class="item-right docblock-short"><p>Function encrypts a UserID with a nonce and returns it as a base64 string to be used as a cookie/token.</p>
  14. </div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="auth" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.63.0-nightly (c35035cef 2022-05-30)" ></div>
  15. </body></html>