-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
rustdocs: Generated documentation for Jan 12, 2024
- Loading branch information
Showing
3 changed files
with
162 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,56 @@ | ||
| <!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="Easy to use interface for the DC file parser. Handles reading the DC files, instantiating the lexer and parser, and either returns the DCFile object or a Parse/File error."><title>read_dc_files in libdonet - 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/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-9ee3a5e31a2afa3e.css"><script id="default-settings" | ||
| data-theme="ayu" | ||
| data-use_system_theme="false"></script><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="libdonet" data-themes="" data-resource-suffix="" data-rustdoc-version="1.75.0 (82e1608df 2023-12-21)" data-channel="1.75.0" data-search-js="search-8fbf244ebcf71464.js" data-settings-js="settings-74424d7eec62a23e.js" ><script src="../static.files/storage-fec3eaa3851e447d.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-9dd44ab47b99a0fb.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-5d8b3c7633ad77ba.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 fn"><!--[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="../libdonet/index.html"><img src="https://raw.githubusercontent.com/donet-server/donet/master/logo/donet_logo_v3.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../libdonet/index.html"><img src="https://raw.githubusercontent.com/donet-server/donet/master/logo/donet_logo_v3.png" alt="logo"></a><h2><a href="../libdonet/index.html">libdonet</a><span class="version">0.1.0</span></h2></div><div class="sidebar-elems"></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>Function <a href="index.html">libdonet</a>::<wbr><a class="fn" href="#">read_dc_files</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="src" href="../src/libdonet/lib.rs.html#79-113">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub fn read_dc_files(file_paths: <a class="struct" href="https://doc.rust-lang.org/1.75.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="struct" href="https://doc.rust-lang.org/1.75.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>) -> <a class="type" href="globals/type.DCReadResult.html" title="type libdonet::globals::DCReadResult">DCReadResult</a></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Easy to use interface for the DC file parser. Handles reading | ||
| data-use_system_theme="false"></script><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="libdonet" data-themes="" data-resource-suffix="" data-rustdoc-version="1.75.0 (82e1608df 2023-12-21)" data-channel="1.75.0" data-search-js="search-8fbf244ebcf71464.js" data-settings-js="settings-74424d7eec62a23e.js" ><script src="../static.files/storage-fec3eaa3851e447d.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-9dd44ab47b99a0fb.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-5d8b3c7633ad77ba.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 fn"><!--[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="../libdonet/index.html"><img src="https://raw.githubusercontent.com/donet-server/donet/master/logo/donet_logo_v3.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../libdonet/index.html"><img src="https://raw.githubusercontent.com/donet-server/donet/master/logo/donet_logo_v3.png" alt="logo"></a><h2><a href="../libdonet/index.html">libdonet</a><span class="version">0.1.0</span></h2></div><div class="sidebar-elems"></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>Function <a href="index.html">libdonet</a>::<wbr><a class="fn" href="#">read_dc_files</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="src" href="../src/libdonet/lib.rs.html#134-168">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub fn read_dc_files(file_paths: <a class="struct" href="https://doc.rust-lang.org/1.75.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="struct" href="https://doc.rust-lang.org/1.75.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>) -> <a class="type" href="globals/type.DCReadResult.html" title="type libdonet::globals::DCReadResult">DCReadResult</a></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Easy to use interface for the DC file parser. Handles reading | ||
| the DC files, instantiating the lexer and parser, and either | ||
| returns the DCFile object or a Parse/File error.</p> | ||
| <h3 id="example-usage"><a href="#example-usage">Example Usage</a></h3> | ||
| <p>The following is an example of parsing a simple DC file string, | ||
| printing its DC hash in hexadecimal notation, and accessing | ||
| the elements of a defined Distributed Class:</p> | ||
|
|
||
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>libdonet::dcfile::DCFileInterface; | ||
| <span class="kw">use </span>libdonet::dclass::{DClass, DClassInterface}; | ||
| <span class="kw">use </span>libdonet::globals::DCReadResult; | ||
| <span class="kw">use </span>libdonet::read_dc_files; | ||
|
|
||
| <span class="comment">// All elements in a DC File object are thread-safe! | ||
| </span><span class="kw">use </span>std::sync::{Arc, Mutex, MutexGuard}; | ||
|
|
||
| <span class="kw">let </span>dc_file: <span class="kw-2">&</span>str = <span class="string">"from game.ai import AnonymousContact/UD | ||
| from game.ai import LoginManager/AI | ||
| from game.world import DistributedWorld/AI | ||
| from game.avatar import DistributedAvatar/AI/OV | ||
|
|
||
| dclass AnonymousContact { | ||
| login(string username, string password) clsend airecv; | ||
| }; | ||
|
|
||
| dclass LoginManager { | ||
| login(channel client, string username, string password) airecv; | ||
| }; | ||
|
|
||
| dclass DistributedWorld { | ||
| create_avatar(channel client) airecv; | ||
| }; | ||
|
|
||
| dclass DistributedAvatar { | ||
| set_xyzh(int16 x, int16 y, int16 z, int16 h) broadcast required; | ||
| indicate_intent(int16 / 10, int16 / 10) ownsend airecv; | ||
| };"</span>; | ||
|
|
||
| <span class="kw">let </span>dc_read: DCReadResult = read_dc_files(<span class="macro">vec!</span>[dc_file.into()]); | ||
|
|
||
| <span class="kw">if let </span><span class="prelude-val">Ok</span>(<span class="kw-2">mut </span>dc_file) = dc_read { | ||
| <span class="macro">println!</span>(<span class="string">"{}"</span>, dc_file.get_pretty_hash()); <span class="comment">// Print the DC File Hash | ||
|
|
||
| </span><span class="kw">let </span>avatar_class: Arc<Mutex<DClass>> = dc_file.get_dclass_by_id(<span class="number">3</span>); | ||
| <span class="kw">let </span><span class="kw-2">mut </span>locked_class: MutexGuard<<span class="lifetime">'_</span>, DClass> = avatar_class.lock().unwrap(); | ||
|
|
||
| <span class="macro">println!</span>(<span class="string">"{}"</span>, locked_class.get_name()); | ||
| }</code></pre></div> | ||
| <p>The output of the program would be the following:</p> | ||
| <div class="example-wrap"><pre class="language-txt"><code>0x01a5Fb0c | ||
| DistributedAvatar | ||
| </code></pre></div> | ||
| <p><br><img src="https://c.tenor.com/myQHgyWQQ9sAAAAd/tenor.gif"></p> | ||
| </div></details></section></div></main></body></html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.