34 lines
14 KiB
HTML
34 lines
14 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`."><title>IpSub in ipnet - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="ipnet" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">IpSub</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../ipnet/index.html">ipnet</a><span class="version">2.11.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">IpSub</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#examples" title="Examples">Examples</a></li></ul><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Output" title="Output">Output</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.saturating_sub" title="saturating_sub">saturating_sub</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-IpSub%3Cu32%3E-for-Ipv4Addr" title="Ipv4Addr">Ipv4Addr</a></li><li><a href="#impl-IpSub-for-Ipv4Addr" title="Ipv4Addr">Ipv4Addr</a></li><li><a href="#impl-IpSub%3Cu128%3E-for-Ipv6Addr" title="Ipv6Addr">Ipv6Addr</a></li><li><a href="#impl-IpSub-for-Ipv6Addr" title="Ipv6Addr">Ipv6Addr</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate ipnet</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="index.html">ipnet</a></div><h1>Trait <span class="trait">IpSub</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/ipnet/ipext.rs.html#91-94">Source</a> </span></div><pre class="rust item-decl"><code>pub trait IpSub<RHS = Self> {
|
|
type <a href="#associatedtype.Output" class="associatedtype">Output</a>;
|
|
|
|
// Required method
|
|
fn <a href="#tymethod.saturating_sub" class="fn">saturating_sub</a>(self, rhs: RHS) -> Self::<a class="associatedtype" href="trait.IpSub.html#associatedtype.Output" title="type ipnet::IpSub::Output">Output</a>;
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><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>
|
|
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::net::{Ipv4Addr, Ipv6Addr};
|
|
<span class="kw">use </span>ipnet::IpSub;
|
|
|
|
<span class="kw">let </span>min: Ipv4Addr = <span class="string">"0.0.0.0"</span>.parse().unwrap();
|
|
<span class="kw">let </span>ip1: Ipv4Addr = <span class="string">"192.168.1.5"</span>.parse().unwrap();
|
|
<span class="kw">let </span>ip2: Ipv4Addr = <span class="string">"192.168.1.100"</span>.parse().unwrap();
|
|
|
|
<span class="macro">assert_eq!</span>(min.saturating_sub(ip1), <span class="number">0</span>);
|
|
<span class="macro">assert_eq!</span>(ip2.saturating_sub(ip1), <span class="number">95</span>);
|
|
<span class="macro">assert_eq!</span>(min.saturating_sub(<span class="number">5</span>), min);
|
|
<span class="macro">assert_eq!</span>(ip2.saturating_sub(<span class="number">95</span>), ip1);
|
|
|
|
<span class="kw">let </span>min: Ipv6Addr = <span class="string">"::"</span>.parse().unwrap();
|
|
<span class="kw">let </span>ip1: Ipv6Addr = <span class="string">"fd00::5"</span>.parse().unwrap();
|
|
<span class="kw">let </span>ip2: Ipv6Addr = <span class="string">"fd00::64"</span>.parse().unwrap();
|
|
|
|
<span class="macro">assert_eq!</span>(min.saturating_sub(ip1), <span class="number">0</span>);
|
|
<span class="macro">assert_eq!</span>(ip2.saturating_sub(ip1), <span class="number">95</span>);
|
|
<span class="macro">assert_eq!</span>(min.saturating_sub(<span class="number">5u128</span>), min);
|
|
<span class="macro">assert_eq!</span>(ip2.saturating_sub(<span class="number">95u128</span>), ip1);</code></pre></div></div></details><h2 id="required-associated-types" class="section-header">Required Associated Types<a href="#required-associated-types" class="anchor">§</a></h2><div class="methods"><section id="associatedtype.Output" class="method"><a class="src rightside" href="../src/ipnet/ipext.rs.html#92">Source</a><h4 class="code-header">type <a href="#associatedtype.Output" class="associatedtype">Output</a></h4></section></div><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><section id="tymethod.saturating_sub" class="method"><a class="src rightside" href="../src/ipnet/ipext.rs.html#93">Source</a><h4 class="code-header">fn <a href="#tymethod.saturating_sub" class="fn">saturating_sub</a>(self, rhs: RHS) -> Self::<a class="associatedtype" href="trait.IpSub.html#associatedtype.Output" title="type ipnet::IpSub::Output">Output</a></h4></section></div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-IpSub-for-Ipv4Addr" class="impl"><a class="src rightside" href="../src/ipnet/ipext.rs.html#187">Source</a><a href="#impl-IpSub-for-Ipv4Addr" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.IpSub.html" title="trait ipnet::IpSub">IpSub</a> for <a class="struct" href="https://doc.rust-lang.org/1.93.1/core/net/ip_addr/struct.Ipv4Addr.html" title="struct core::net::ip_addr::Ipv4Addr">Ipv4Addr</a></h3></section></summary><div class="impl-items"><section id="associatedtype.Output-1" class="associatedtype trait-impl"><a class="src rightside" href="../src/ipnet/ipext.rs.html#187">Source</a><a href="#associatedtype.Output-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Output" class="associatedtype">Output</a> = <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u32.html">u32</a></h4></section><section id="method.saturating_sub" class="method trait-impl"><a class="src rightside" href="../src/ipnet/ipext.rs.html#187">Source</a><a href="#method.saturating_sub" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.saturating_sub" class="fn">saturating_sub</a>(self, rhs: <a class="struct" href="https://doc.rust-lang.org/1.93.1/core/net/ip_addr/struct.Ipv4Addr.html" title="struct core::net::ip_addr::Ipv4Addr">Ipv4Addr</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u32.html">u32</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-IpSub-for-Ipv6Addr" class="impl"><a class="src rightside" href="../src/ipnet/ipext.rs.html#189">Source</a><a href="#impl-IpSub-for-Ipv6Addr" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.IpSub.html" title="trait ipnet::IpSub">IpSub</a> for <a class="struct" href="https://doc.rust-lang.org/1.93.1/core/net/ip_addr/struct.Ipv6Addr.html" title="struct core::net::ip_addr::Ipv6Addr">Ipv6Addr</a></h3></section></summary><div class="impl-items"><section id="associatedtype.Output-2" class="associatedtype trait-impl"><a class="src rightside" href="../src/ipnet/ipext.rs.html#189">Source</a><a href="#associatedtype.Output-2" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Output" class="associatedtype">Output</a> = <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u128.html">u128</a></h4></section><section id="method.saturating_sub-1" class="method trait-impl"><a class="src rightside" href="../src/ipnet/ipext.rs.html#189">Source</a><a href="#method.saturating_sub-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.saturating_sub" class="fn">saturating_sub</a>(self, rhs: <a class="struct" href="https://doc.rust-lang.org/1.93.1/core/net/ip_addr/struct.Ipv6Addr.html" title="struct core::net::ip_addr::Ipv6Addr">Ipv6Addr</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u128.html">u128</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-IpSub%3Cu32%3E-for-Ipv4Addr" class="impl"><a class="src rightside" href="../src/ipnet/ipext.rs.html#188">Source</a><a href="#impl-IpSub%3Cu32%3E-for-Ipv4Addr" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.IpSub.html" title="trait ipnet::IpSub">IpSub</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u32.html">u32</a>> for <a class="struct" href="https://doc.rust-lang.org/1.93.1/core/net/ip_addr/struct.Ipv4Addr.html" title="struct core::net::ip_addr::Ipv4Addr">Ipv4Addr</a></h3></section></summary><div class="impl-items"><section id="associatedtype.Output-3" class="associatedtype trait-impl"><a class="src rightside" href="../src/ipnet/ipext.rs.html#188">Source</a><a href="#associatedtype.Output-3" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Output" class="associatedtype">Output</a> = <a class="struct" href="https://doc.rust-lang.org/1.93.1/core/net/ip_addr/struct.Ipv4Addr.html" title="struct core::net::ip_addr::Ipv4Addr">Ipv4Addr</a></h4></section><section id="method.saturating_sub-2" class="method trait-impl"><a class="src rightside" href="../src/ipnet/ipext.rs.html#188">Source</a><a href="#method.saturating_sub-2" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.saturating_sub" class="fn">saturating_sub</a>(self, rhs: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u32.html">u32</a>) -> <a class="struct" href="https://doc.rust-lang.org/1.93.1/core/net/ip_addr/struct.Ipv4Addr.html" title="struct core::net::ip_addr::Ipv4Addr">Ipv4Addr</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-IpSub%3Cu128%3E-for-Ipv6Addr" class="impl"><a class="src rightside" href="../src/ipnet/ipext.rs.html#190">Source</a><a href="#impl-IpSub%3Cu128%3E-for-Ipv6Addr" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.IpSub.html" title="trait ipnet::IpSub">IpSub</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u128.html">u128</a>> for <a class="struct" href="https://doc.rust-lang.org/1.93.1/core/net/ip_addr/struct.Ipv6Addr.html" title="struct core::net::ip_addr::Ipv6Addr">Ipv6Addr</a></h3></section></summary><div class="impl-items"><section id="associatedtype.Output-4" class="associatedtype trait-impl"><a class="src rightside" href="../src/ipnet/ipext.rs.html#190">Source</a><a href="#associatedtype.Output-4" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Output" class="associatedtype">Output</a> = <a class="struct" href="https://doc.rust-lang.org/1.93.1/core/net/ip_addr/struct.Ipv6Addr.html" title="struct core::net::ip_addr::Ipv6Addr">Ipv6Addr</a></h4></section><section id="method.saturating_sub-3" class="method trait-impl"><a class="src rightside" href="../src/ipnet/ipext.rs.html#190">Source</a><a href="#method.saturating_sub-3" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.saturating_sub" class="fn">saturating_sub</a>(self, rhs: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u128.html">u128</a>) -> <a class="struct" href="https://doc.rust-lang.org/1.93.1/core/net/ip_addr/struct.Ipv6Addr.html" title="struct core::net::ip_addr::Ipv6Addr">Ipv6Addr</a></h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../trait.impl/ipnet/ipext/trait.IpSub.js" data-ignore-extern-crates="core" async></script></section></div></main></body></html> |