servius/rapr-rs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
gh-pages
rapr-rs/docs/ipnet/index.html
T
github-actions[bot] a4995c672b Auto Generated Documentation
2021-03-26 19:20:48 +00:00

71 lines
11 KiB
HTML
Raw Permalink 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 `ipnet` crate."><meta name="keywords" content="rust, rustlang, rust-lang, ipnet"><title>ipnet - 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='../ipnet/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class="location">Crate ipnet</p><div class="block version"><p>Version 2.3.0</p></div><div class="sidebar-elems"><a id="all-types" href="all.html"><p>See all ipnet'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="#traits">Traits</a></li></ul></div><p class="location"></p><div id="sidebar-vars" data-name="ipnet" data-ty="mod" data-relpath="../"></div></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="in-band">Crate <a class="mod" href="">ipnet</a></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/ipnet/lib.rs.html#1-93" title="goto source code">[src]</a></span></h1><div class="docblock"><p>Types for IPv4 and IPv6 network addresses.</p>
<p>This module provides types and useful methods for working with IPv4
and IPv6 network addresses, commonly called IP prefixes. The new
<a href="enum.IpNet.html"><code>IpNet</code></a>, <a href="struct.Ipv4Net.html"><code>Ipv4Net</code></a>, and <a href="struct.Ipv6Net.html"><code>Ipv6Net</code></a> types build on the existing
<a href="https://doc.rust-lang.org/std/net/enum.IpAddr.html"><code>IpAddr</code></a>, <a href="https://doc.rust-lang.org/std/net/struct.Ipv4Addr.html"><code>Ipv4Addr</code></a>, and <a href="https://doc.rust-lang.org/std/net/struct.Ipv6Addr.html"><code>Ipv6Addr</code></a> types already provided in
Rust's standard library and align to their design to stay
consistent.</p>
<p>The module also provides the <a href="enum.IpSubnets.html"><code>IpSubnets</code></a>, <a href="struct.Ipv4Subnets.html"><code>Ipv4Subnets</code></a>, and
<a href="struct.Ipv6Subnets.html"><code>Ipv6Subnets</code></a> types for interating over the subnets contained in
an IP address range. The <a href="enum.IpAddrRange.html"><code>IpAddrRange</code></a>, <a href="struct.Ipv4AddrRange.html"><code>Ipv4AddrRange</code></a>, and
<a href="struct.Ipv6AddrRange.html"><code>Ipv6AddrRange</code></a> types for iterating over IP addresses in a range.
And traits that extend <code>Ipv4Addr</code> and <code>Ipv6Addr</code> with methods for
addition, subtraction, bitwise-and, and bitwise-or operations that
are missing in Rust's standard library.</p>
<p>The module only uses stable features so it is guaranteed to compile
using the stable toolchain.</p>
<h1 id="organization" class="section-header"><a href="#organization">Organization</a></h1>
<ul>
<li><a href="enum.IpNet.html"><code>IpNet</code></a> represents an IP network address, either IPv4 or IPv6.</li>
<li><a href="struct.Ipv4Net.html"><code>Ipv4Net</code></a> and <a href="struct.Ipv6Net.html"><code>Ipv6Net</code></a> are respectively IPv4 and IPv6 network
addresses.</li>
<li><a href="enum.IpSubnets.html"><code>IpSubnets</code></a>, <a href="struct.Ipv4Subnets.html"><code>Ipv4Subnets</code></a>, and <a href="struct.Ipv6Subnets.html"><code>Ipv6Subnets</code></a> are iterators
that generate the smallest set of IP network addresses bound by an
IP address range and minimum prefix length. These can be created
using their constructors. They are also returned by the
<a href="enum.IpNet.html#method.subnets"><code>subnets()</code></a> methods and used within the <a href="enum.IpNet.html#method.aggregate"><code>aggregate()</code></a> methods.</li>
<li><a href="enum.IpAddrRange.html"><code>IpAddrRange</code></a>, <a href="struct.Ipv4AddrRange.html"><code>Ipv4AddrRange</code></a>, and <a href="struct.Ipv6AddrRange.html"><code>Ipv6AddrRange</code></a> are
iterators that generate IP addresses. These can be created using
their constructors. They are also returned by the <a href="enum.IpNet.html#method.hosts"><code>hosts()</code></a>
methods.</li>
<li>The <a href="trait.IpAdd.html"><code>IpAdd</code></a>, <a href="trait.IpSub.html"><code>IpSub</code></a>, <a href="trait.IpBitAnd.html"><code>IpBitAnd</code></a>, <a href="trait.IpBitOr.htmll"><code>IpBitOr</code></a> traits extend
the <a href="https://doc.rust-lang.org/std/net/struct.Ipv4Addr.html"><code>Ipv4Addr</code></a> and <a href="https://doc.rust-lang.org/std/net/struct.Ipv6Addr.html"><code>Ipv6Addr</code></a> types with methods to perform
these operations.</li>
</ul>
<h1 id="serde-support" class="section-header"><a href="#serde-support">Serde support</a></h1>
<p>This library comes with support for <a href="https://serde.rs">serde</a> but
it's not enabled by default. Use the <code>serde</code> <a href="https://doc.rust-lang.org/cargo/reference/manifest.html#the-features-section">feature</a> to enable.</p>
<pre><code class="language-toml">[dependencies]
ipnet = { version = &quot;2&quot;, features = [&quot;serde&quot;] }
</code></pre>
<p>For human readable formats (e.g. JSON) the <code>IpNet</code>, <code>Ipv4Net</code>, and
<code>Ipv6Net</code> types will serialize to their <code>Display</code> strings.</p>
<p>For compact binary formats (e.g. Bincode) the <code>Ipv4Net</code> and
<code>Ipv6Net</code> types will serialize to a string of 5 and 17 bytes that
consist of the network address octects followed by the prefix
length. The <code>IpNet</code> type will serialize to an Enum with the V4 or V6
variant index prepending the above string of 5 or 17 bytes.</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.AddrParseError.html" title="ipnet::AddrParseError struct">AddrParseError</a></td><td class="docblock-short"><p>An error which can be returned when parsing an IP network address.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Ipv4AddrRange.html" title="ipnet::Ipv4AddrRange struct">Ipv4AddrRange</a></td><td class="docblock-short"><p>An <code>Iterator</code> over a range of IPv4 addresses.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Ipv4Net.html" title="ipnet::Ipv4Net struct">Ipv4Net</a></td><td class="docblock-short"><p>An IPv4 network address.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Ipv4Subnets.html" title="ipnet::Ipv4Subnets struct">Ipv4Subnets</a></td><td class="docblock-short"><p>An <code>Iterator</code> that generates IPv4 network addresses.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Ipv6AddrRange.html" title="ipnet::Ipv6AddrRange struct">Ipv6AddrRange</a></td><td class="docblock-short"><p>An <code>Iterator</code> over a range of IPv6 addresses.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Ipv6Net.html" title="ipnet::Ipv6Net struct">Ipv6Net</a></td><td class="docblock-short"><p>An IPv6 network address.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Ipv6Subnets.html" title="ipnet::Ipv6Subnets struct">Ipv6Subnets</a></td><td class="docblock-short"><p>An <code>Iterator</code> that generates IPv6 network addresses.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PrefixLenError.html" title="ipnet::PrefixLenError struct">PrefixLenError</a></td><td class="docblock-short"><p>An error which can be returned when the prefix length is invalid.</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.IpAddrRange.html" title="ipnet::IpAddrRange enum">IpAddrRange</a></td><td class="docblock-short"><p>An <code>Iterator</code> over a range of IP addresses, either IPv4 or IPv6.</p>
</td></tr><tr class="module-item"><td><a class="enum" href="enum.IpNet.html" title="ipnet::IpNet enum">IpNet</a></td><td class="docblock-short"><p>An IP network address, either IPv4 or IPv6.</p>
</td></tr><tr class="module-item"><td><a class="enum" href="enum.IpSubnets.html" title="ipnet::IpSubnets enum">IpSubnets</a></td><td class="docblock-short"><p>An <code>Iterator</code> that generates IP network addresses, either IPv4 or
IPv6.</p>
</td></tr></table><h2 id="traits" class="section-header"><a href="#traits">Traits</a></h2>
<table><tr class="module-item"><td><a class="trait" href="trait.IpAdd.html" title="ipnet::IpAdd trait">IpAdd</a></td><td class="docblock-short"><p>Provides a <code>saturating_add()</code> method for <code>Ipv4Addr</code> and <code>Ipv6Addr</code>.</p>
</td></tr><tr class="module-item"><td><a class="trait" href="trait.IpBitAnd.html" title="ipnet::IpBitAnd trait">IpBitAnd</a></td><td class="docblock-short"><p>Provides a <code>bitand()</code> method for <code>Ipv4Addr</code> and <code>Ipv6Addr</code>.</p>
</td></tr><tr class="module-item"><td><a class="trait" href="trait.IpBitOr.html" title="ipnet::IpBitOr trait">IpBitOr</a></td><td class="docblock-short"><p>Provides a <code>bitor()</code> method for <code>Ipv4Addr</code> and <code>Ipv6Addr</code>.</p>
</td></tr><tr class="module-item"><td><a class="trait" href="trait.IpSub.html" title="ipnet::IpSub trait">IpSub</a></td><td class="docblock-short"><p>Provides a <code>saturating_sub()</code> method for <code>Ipv4Addr</code> and <code>Ipv6Addr</code>.</p>
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../" data-current-crate="ipnet"></div>
<script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>
Reference in New Issue View Git Blame Copy Permalink