Uttarayan Mondal
38 lines
15 KiB
HTML
38 lines
15 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="Provides a `saturating_sub()` method for `Ipv4Addr` and `Ipv6Addr`."><meta name="keywords" content="rust, rustlang, rust-lang, IpSub"><title>ipnet::IpSub - 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 trait"><!--[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='../ipnet/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class="location">Trait IpSub</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#associated-types">Associated Types</a><div class="sidebar-links"><a href="#associatedtype.Output">Output</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.saturating_sub">saturating_sub</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-IpSub%3CIpv4Addr%3E-for-Ipv4Addr">Ipv4Addr</a><a href="#impl-IpSub%3Cu32%3E-for-Ipv4Addr">Ipv4Addr</a><a href="#impl-IpSub%3CIpv6Addr%3E-for-Ipv6Addr">Ipv6Addr</a><a href="#impl-IpSub%3Cu128%3E-for-Ipv6Addr">Ipv6Addr</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class="location"><a href="index.html">ipnet</a></p><div id="sidebar-vars" data-name="IpSub" data-ty="trait" 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"><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">Trait <a href="index.html">ipnet</a>::<wbr><a class="trait" href="">IpSub</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">−</span>]</a></span><a class="srclink" href="../src/ipnet/ipext.rs.html#82-85" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait IpSub<RHS = Self> {
|
||
type <a href="#associatedtype.Output" class="type">Output</a>;
|
||
fn <a href="#tymethod.saturating_sub" class="fnname">saturating_sub</a>(self, rhs: RHS) -> Self::<a class="type" href="../ipnet/trait.IpSub.html#associatedtype.Output" title="type ipnet::IpSub::Output">Output</a>;
|
||
}</pre></div><div class="docblock"><p>Provides a <code>saturating_sub()</code> method for <code>Ipv4Addr</code> and <code>Ipv6Addr</code>.</p>
|
||
<p>Subtracting an integer from an IP address returns the modified IP
|
||
address. A <code>u32</code> may be subtracted from an IPv4 address and a <code>u128</code>
|
||
may be subtracted from an IPv6 address.</p>
|
||
<p>Subtracting an IP address from another IP address of the same type
|
||
returns an integer of the appropriate width. A <code>u32</code> for IPv4 and a
|
||
<code>u128</code> for IPv6. Subtracting IP addresses is useful for getting
|
||
the range between two IP addresses.</p>
|
||
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">net</span>::{<span class="ident">Ipv4Addr</span>, <span class="ident">Ipv6Addr</span>};
|
||
<span class="kw">use</span> <span class="ident">ipnet</span>::<span class="ident">IpSub</span>;
|
||
|
||
<span class="kw">let</span> <span class="ident">min</span>: <span class="ident">Ipv4Addr</span> <span class="op">=</span> <span class="string">"0.0.0.0"</span>.<span class="ident">parse</span>().<span class="ident">unwrap</span>();
|
||
<span class="kw">let</span> <span class="ident">ip1</span>: <span class="ident">Ipv4Addr</span> <span class="op">=</span> <span class="string">"192.168.1.5"</span>.<span class="ident">parse</span>().<span class="ident">unwrap</span>();
|
||
<span class="kw">let</span> <span class="ident">ip2</span>: <span class="ident">Ipv4Addr</span> <span class="op">=</span> <span class="string">"192.168.1.100"</span>.<span class="ident">parse</span>().<span class="ident">unwrap</span>();
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">min</span>.<span class="ident">saturating_sub</span>(<span class="ident">ip1</span>), <span class="number">0</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">ip2</span>.<span class="ident">saturating_sub</span>(<span class="ident">ip1</span>), <span class="number">95</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">min</span>.<span class="ident">saturating_sub</span>(<span class="number">5</span>), <span class="ident">min</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">ip2</span>.<span class="ident">saturating_sub</span>(<span class="number">95</span>), <span class="ident">ip1</span>);
|
||
|
||
<span class="kw">let</span> <span class="ident">min</span>: <span class="ident">Ipv6Addr</span> <span class="op">=</span> <span class="string">"::"</span>.<span class="ident">parse</span>().<span class="ident">unwrap</span>();
|
||
<span class="kw">let</span> <span class="ident">ip1</span>: <span class="ident">Ipv6Addr</span> <span class="op">=</span> <span class="string">"fd00::5"</span>.<span class="ident">parse</span>().<span class="ident">unwrap</span>();
|
||
<span class="kw">let</span> <span class="ident">ip2</span>: <span class="ident">Ipv6Addr</span> <span class="op">=</span> <span class="string">"fd00::64"</span>.<span class="ident">parse</span>().<span class="ident">unwrap</span>();
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">min</span>.<span class="ident">saturating_sub</span>(<span class="ident">ip1</span>), <span class="number">0</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">ip2</span>.<span class="ident">saturating_sub</span>(<span class="ident">ip1</span>), <span class="number">95</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">min</span>.<span class="ident">saturating_sub</span>(<span class="number">5u128</span>), <span class="ident">min</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">ip2</span>.<span class="ident">saturating_sub</span>(<span class="number">95u128</span>), <span class="ident">ip1</span>);</pre></div>
|
||
</div><h2 id="associated-types" class="small-section-header">Associated Types<a href="#associated-types" class="anchor"></a></h2><div class="methods"><h3 id="associatedtype.Output" class="method"><code>type <a href="#associatedtype.Output" class="type">Output</a></code><a class="srclink" href="../src/ipnet/ipext.rs.html#83" title="goto source code">[src]</a></h3></div><span class="loading-content">Loading content...</span><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><h3 id="tymethod.saturating_sub" class="method"><code>fn <a href="#tymethod.saturating_sub" class="fnname">saturating_sub</a>(self, rhs: RHS) -> Self::<a class="type" href="../ipnet/trait.IpSub.html#associatedtype.Output" title="type ipnet::IpSub::Output">Output</a></code><a class="srclink" href="../src/ipnet/ipext.rs.html#84" title="goto source code">[src]</a></h3></div><span class="loading-content">Loading content...</span><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><h3 id="impl-IpSub%3CIpv4Addr%3E-for-Ipv4Addr" class="impl"><code class="in-band">impl <a class="trait" href="../ipnet/trait.IpSub.html" title="trait ipnet::IpSub">IpSub</a><<a class="struct" href="https://doc.rust-lang.org/nightly/std/net/ip/struct.Ipv4Addr.html" title="struct std::net::ip::Ipv4Addr">Ipv4Addr</a>> for <a class="struct" href="https://doc.rust-lang.org/nightly/std/net/ip/struct.Ipv4Addr.html" title="struct std::net::ip::Ipv4Addr">Ipv4Addr</a></code><a href="#impl-IpSub%3CIpv4Addr%3E-for-Ipv4Addr" class="anchor"></a><a class="srclink" href="../src/ipnet/ipext.rs.html#172" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Output-1" class="type"><code>type <a href="#associatedtype.Output" class="type">Output</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code></h4><h4 id="method.saturating_sub" class="method hidden"><code>fn <a href="#method.saturating_sub" class="fnname">saturating_sub</a>(self, rhs: <a class="struct" href="https://doc.rust-lang.org/nightly/std/net/ip/struct.Ipv4Addr.html" title="struct std::net::ip::Ipv4Addr">Ipv4Addr</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code><a class="srclink" href="../src/ipnet/ipext.rs.html#172" title="goto source code">[src]</a></h4></div><h3 id="impl-IpSub%3Cu32%3E-for-Ipv4Addr" class="impl"><code class="in-band">impl <a class="trait" href="../ipnet/trait.IpSub.html" title="trait ipnet::IpSub">IpSub</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>> for <a class="struct" href="https://doc.rust-lang.org/nightly/std/net/ip/struct.Ipv4Addr.html" title="struct std::net::ip::Ipv4Addr">Ipv4Addr</a></code><a href="#impl-IpSub%3Cu32%3E-for-Ipv4Addr" class="anchor"></a><a class="srclink" href="../src/ipnet/ipext.rs.html#173" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Output-2" class="type"><code>type <a href="#associatedtype.Output" class="type">Output</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/std/net/ip/struct.Ipv4Addr.html" title="struct std::net::ip::Ipv4Addr">Ipv4Addr</a></code></h4><h4 id="method.saturating_sub-1" class="method hidden"><code>fn <a href="#method.saturating_sub" class="fnname">saturating_sub</a>(self, rhs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="struct" href="https://doc.rust-lang.org/nightly/std/net/ip/struct.Ipv4Addr.html" title="struct std::net::ip::Ipv4Addr">Ipv4Addr</a></code><a class="srclink" href="../src/ipnet/ipext.rs.html#173" title="goto source code">[src]</a></h4></div><h3 id="impl-IpSub%3CIpv6Addr%3E-for-Ipv6Addr" class="impl"><code class="in-band">impl <a class="trait" href="../ipnet/trait.IpSub.html" title="trait ipnet::IpSub">IpSub</a><<a class="struct" href="https://doc.rust-lang.org/nightly/std/net/ip/struct.Ipv6Addr.html" title="struct std::net::ip::Ipv6Addr">Ipv6Addr</a>> for <a class="struct" href="https://doc.rust-lang.org/nightly/std/net/ip/struct.Ipv6Addr.html" title="struct std::net::ip::Ipv6Addr">Ipv6Addr</a></code><a href="#impl-IpSub%3CIpv6Addr%3E-for-Ipv6Addr" class="anchor"></a><a class="srclink" href="../src/ipnet/ipext.rs.html#174" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Output-3" class="type"><code>type <a href="#associatedtype.Output" class="type">Output</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u128.html">u128</a></code></h4><h4 id="method.saturating_sub-2" class="method hidden"><code>fn <a href="#method.saturating_sub" class="fnname">saturating_sub</a>(self, rhs: <a class="struct" href="https://doc.rust-lang.org/nightly/std/net/ip/struct.Ipv6Addr.html" title="struct std::net::ip::Ipv6Addr">Ipv6Addr</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u128.html">u128</a></code><a class="srclink" href="../src/ipnet/ipext.rs.html#174" title="goto source code">[src]</a></h4></div><h3 id="impl-IpSub%3Cu128%3E-for-Ipv6Addr" class="impl"><code class="in-band">impl <a class="trait" href="../ipnet/trait.IpSub.html" title="trait ipnet::IpSub">IpSub</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u128.html">u128</a>> for <a class="struct" href="https://doc.rust-lang.org/nightly/std/net/ip/struct.Ipv6Addr.html" title="struct std::net::ip::Ipv6Addr">Ipv6Addr</a></code><a href="#impl-IpSub%3Cu128%3E-for-Ipv6Addr" class="anchor"></a><a class="srclink" href="../src/ipnet/ipext.rs.html#175" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Output-4" class="type"><code>type <a href="#associatedtype.Output" class="type">Output</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/std/net/ip/struct.Ipv6Addr.html" title="struct std::net::ip::Ipv6Addr">Ipv6Addr</a></code></h4><h4 id="method.saturating_sub-3" class="method hidden"><code>fn <a href="#method.saturating_sub" class="fnname">saturating_sub</a>(self, rhs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u128.html">u128</a>) -> <a class="struct" href="https://doc.rust-lang.org/nightly/std/net/ip/struct.Ipv6Addr.html" title="struct std::net::ip::Ipv6Addr">Ipv6Addr</a></code><a class="srclink" href="../src/ipnet/ipext.rs.html#175" title="goto source code">[src]</a></h4></div><span class="loading-content">Loading content...</span><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../implementors/ipnet/trait.IpSub.js" async></script></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> |