mCaptcha-cache/cache/index.html
2021-12-06 06:51:41 +00:00

19 lines
No EOL
8.5 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="API documentation for the Rust `cache` crate."><meta name="keywords" content="rust, rustlang, rust-lang, cache"><title>cache - Rust</title><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="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings" ></script><script src="../storage.js"></script><script src="../crates.js"></script><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"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></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="sidebar"><div class="sidebar-menu" role="button">&#9776;</div><a href='../cache/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><h2 class="location">Crate cache</h2><div class="block version"><div class="narrow-helper"></div><p>Version 0.1.0</p></div><div class="sidebar-elems"><a id="all-types" href="all.html"><p>See all cache's items</p></a><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#constants">Constants</a></li><li><a href="#functions">Functions</a></li></ul></div><div id="sidebar-vars" data-name="cache" data-ty="mod" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../brush.svg"></button><div id="theme-choices" role="menu"></div></div><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../wheel.svg"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Crate <a class="mod" href="#">cache</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><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span><a class="srclink" href="../src/cache/lib.rs.html#17-104" title="goto source code">[src]</a></span></h1><h2 id="modules" class="section-header"><a href="#modules">Modules</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="mod" href="bucket/index.html" title="cache::bucket mod">bucket</a></div><div class="item-right docblock-short"><p>Leaky bucket algorithim is implemantation for mcatpcha using batch processing Everytime count
is increased for an mcaptcha object, a decrement job is added to a batch that is scheduled to
be executed at that mcaptcha objects expiry rate(MCaptcha.get_duration())</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="challenge/index.html" title="cache::challenge mod">challenge</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="errors/index.html" title="cache::errors mod">errors</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="mcaptcha/index.html" title="cache::mcaptcha mod">mcaptcha</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="redis/index.html" title="cache::redis mod">redis</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="safety/index.html" title="cache::safety mod">safety</a></div><div class="item-right docblock-short"><p>Custom datastructure that controls mCaptcha lifetime through its expiration event handler
and callbacks</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="utils/index.html" title="cache::utils mod">utils</a></div><div class="item-right docblock-short"></div></div></div><h2 id="structs" class="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.ID.html" title="cache::ID struct">ID</a></div><div class="item-right docblock-short"><p>node unique identifier, useful when running in cluster mode</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.PREFIX_BUCKET.html" title="cache::PREFIX_BUCKET struct">PREFIX_BUCKET</a></div><div class="item-right docblock-short"><p>bucket key prefix</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.PREFIX_CAPTCHA.html" title="cache::PREFIX_CAPTCHA struct">PREFIX_CAPTCHA</a></div><div class="item-right docblock-short"><p>counter/captcha key prefix</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.PREFIX_CHALLENGE.html" title="cache::PREFIX_CHALLENGE struct">PREFIX_CHALLENGE</a></div><div class="item-right docblock-short"></div></div></div><h2 id="constants" class="section-header"><a href="#constants">Constants</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.BUCKET_EXPIRY_OFFSET.html" title="cache::BUCKET_EXPIRY_OFFSET constant">BUCKET_EXPIRY_OFFSET</a></div><div class="item-right docblock-short"><p>If buckets perform clean up at x instant, then buckets themselves will get cleaned
up at x + BUCKET_EXPIRY_OFFSET(if they havent already been cleaned up)</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.HIT_PER_SECOND.html" title="cache::HIT_PER_SECOND constant">HIT_PER_SECOND</a></div><div class="item-right docblock-short"><p>Initial allocation ammount of bucket<a href="bucket/struct.Bucket.html" title="bucket::Bucket">bucket::Bucket</a></p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.PKG_NAME.html" title="cache::PKG_NAME constant">PKG_NAME</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.PKG_VERSION.html" title="cache::PKG_VERSION constant">PKG_VERSION</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.PREFIX_BUCKET_TIMER.html" title="cache::PREFIX_BUCKET_TIMER constant">PREFIX_BUCKET_TIMER</a></div><div class="item-right docblock-short"><p>bucket timer key prefix</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.PREFIX_SAFETY.html" title="cache::PREFIX_SAFETY constant">PREFIX_SAFETY</a></div><div class="item-right docblock-short"></div></div></div><h2 id="functions" class="section-header"><a href="#functions">Functions</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.on_delete.html" title="cache::on_delete fn">on_delete</a></div><div class="item-right docblock-short"></div></div></div></section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../" data-current-crate="cache" data-search-index-js="../search-index.js" data-search-js="../search.js"></div>
<script src="../main.js"></script>
</body></html>