23 lines
5.8 KiB
HTML
23 lines
5.8 KiB
HTML
|
<!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 `mcquery` crate."><meta name="keywords" content="rust, rustlang, rust-lang, mcquery"><title>mcquery - 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">☰</div><a href='../mcquery/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class="location">Crate mcquery</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 mcquery's items</p></a><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#constants">Constants</a></li></ul></div><p class="location"></p><script>window.sidebarCurrent = {name: "mcquery", 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><span class="help-button">?</span>
|
|||
|
|
<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">−</span>]</a></span><a class="srclink" href="../src/mcquery/lib.rs.html#1-507" title="goto source code">[src]</a></span><span class="in-band">Crate <a class="mod" href="">mcquery</a></span></h1><div class="docblock"><p>This library provides basically two functions for querying Minecraft
|
|||
|
|
servers. For increased stability, an extra function for handshakes
|
|||
|
|
is not provided.</p>
|
|||
|
|
<h2 id="usage" class="section-header"><a href="#usage">Usage</a></h2>
|
|||
|
|
<p>To perform a query, call <a href="../mcquery/enum.Query.html#method.get_basic" title="Query::get_basic"><code>Query::get_basic</code></a> or <a href="../mcquery/enum.Query.html#method.get_full" title="Query::get_full"><code>Query::get_full</code></a>.
|
|||
|
|
The returned response will either be a <a href="../mcquery/struct.BasicQueryResponse.html" title="BasicQueryResponse"><code>BasicQueryResponse</code></a> or a
|
|||
|
|
<a href="../mcquery/struct.FullQueryResponse.html" title="FullQueryResponse"><code>FullQueryResponse</code></a> respectively.</p>
|
|||
|
|
<h2 id="development-resources" class="section-header"><a href="#development-resources">Development resources</a></h2>
|
|||
|
|
<p>Thank you to the <a href="https://tokio.rs/">Tokio project</a> and the <a href="https://wiki.vg/">Minecraft Developer Wiki</a> for
|
|||
|
|
providing a great asynchronous runtime and useful documentation!</p>
|
|||
|
|
<p>Without them, this crate wouldn't be possible.</p>
|
|||
|
|
</div><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
|
|||
|
|
<table><tr class="module-item"><td><a class="struct" href="struct.BasicQueryResponse.html" title="mcquery::BasicQueryResponse struct">BasicQueryResponse</a></td><td class="docblock-short"><p>Response to a basic query</p>
|
|||
|
|
</td></tr><tr class="module-item"><td><a class="struct" href="struct.FullQueryResponse.html" title="mcquery::FullQueryResponse struct">FullQueryResponse</a></td><td class="docblock-short"><p>Response to a full query</p>
|
|||
|
|
</td></tr><tr class="module-item"><td><a class="struct" href="struct.MaybeIncompleteDataError.html" title="mcquery::MaybeIncompleteDataError struct">MaybeIncompleteDataError</a></td><td class="docblock-short"><p>Encountered when the buffer is full.</p>
|
|||
|
|
</td></tr></table><h2 id="enums" class="section-header"><a href="#enums">Enums</a></h2>
|
|||
|
|
<table><tr class="module-item"><td><a class="enum" href="enum.Query.html" title="mcquery::Query enum">Query</a></td><td class="docblock-short"><p>The main data structure in this crate</p>
|
|||
|
|
</td></tr></table><h2 id="constants" class="section-header"><a href="#constants">Constants</a></h2>
|
|||
|
|
<table><tr class="module-item"><td><a class="constant" href="constant.SESSION_ID_MASK.html" title="mcquery::SESSION_ID_MASK constant">SESSION_ID_MASK</a></td><td class="docblock-short"><p>Bitmask to validate a session ID</p>
|
|||
|
|
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../";window.currentCrate = "mcquery";</script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>
|