mcaptcha-website/api-docs/browser/0.1.0/mCaptcha_browser/index.html
2021-03-11 05:08:07 +00:00

17 lines
No EOL
4.4 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 `mCaptcha_browser` crate."><meta name="keywords" content="rust, rustlang, rust-lang, mCaptcha_browser"><title>mCaptcha_browser - 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><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../mCaptcha_browser/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class="location">Crate mCaptcha_browser</p><div class="block version"><p>Version 0.1.0</p></div><div class="sidebar-elems"><a id="all-types" href="all.html"><p>See all mCaptcha_browser's items</p></a><div class="block items"><ul><li><a href="#functions">Functions</a></li></ul></div><p class="location"></p><script>window.sidebarCurrent = {name: "mCaptcha_browser", ty: "mod", relpath: "../"};</script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../theme.js"></script><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" class="help-button">?</button>
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><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/mCaptcha_browser/lib.rs.html#1-54" title="goto source code">[src]</a></span><span class="in-band">Crate <a class="mod" href="">mCaptcha_browser</a></span></h1><div class="docblock"><p>mCaptcha is a proof of work based Denaial-of-Service attack protection system.
This is is a WASM library that you can embed in your frontend code to protect your
service.</p>
<p>A commercial managed solution is in the works but I'd much rather prefer
folks host their own instances as it will make the more decentralized and free.</p>
<h2 id="workflow" class="section-header"><a href="#workflow">Workflow:</a></h2>
<p>mCaptcha workflow in the frontend is simple.</p>
<ol>
<li>Call service to get a proof of work(PoW) configuration</li>
<li>Call into mCaptcha to get PoW</li>
<li>Send PoW to your service</li>
</ol>
</div><h2 id="functions" class="section-header"><a href="#functions">Functions</a></h2>
<table><tr class="module-item"><td><a class="fn" href="fn.__wasm_bindgen_generated_gen_pow.html" title="mCaptcha_browser::__wasm_bindgen_generated_gen_pow fn">__wasm_bindgen_generated_gen_pow</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="fn" href="fn.gen_pow.html" title="mCaptcha_browser::gen_pow fn">gen_pow</a></td><td class="docblock-short"></td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../";window.currentCrate = "mCaptcha_browser";</script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>