| <!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="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/ipnet-2.7.2/src/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../ipnet/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../ipnet/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" 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="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> |
| <span id="2">2</span> |
| <span id="3">3</span> |
| <span id="4">4</span> |
| <span id="5">5</span> |
| <span id="6">6</span> |
| <span id="7">7</span> |
| <span id="8">8</span> |
| <span id="9">9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <span id="35">35</span> |
| <span id="36">36</span> |
| <span id="37">37</span> |
| <span id="38">38</span> |
| <span id="39">39</span> |
| <span id="40">40</span> |
| <span id="41">41</span> |
| <span id="42">42</span> |
| <span id="43">43</span> |
| <span id="44">44</span> |
| <span id="45">45</span> |
| <span id="46">46</span> |
| <span id="47">47</span> |
| <span id="48">48</span> |
| <span id="49">49</span> |
| <span id="50">50</span> |
| <span id="51">51</span> |
| <span id="52">52</span> |
| <span id="53">53</span> |
| <span id="54">54</span> |
| <span id="55">55</span> |
| <span id="56">56</span> |
| <span id="57">57</span> |
| <span id="58">58</span> |
| <span id="59">59</span> |
| <span id="60">60</span> |
| <span id="61">61</span> |
| <span id="62">62</span> |
| <span id="63">63</span> |
| <span id="64">64</span> |
| <span id="65">65</span> |
| <span id="66">66</span> |
| <span id="67">67</span> |
| <span id="68">68</span> |
| <span id="69">69</span> |
| <span id="70">70</span> |
| <span id="71">71</span> |
| <span id="72">72</span> |
| <span id="73">73</span> |
| <span id="74">74</span> |
| <span id="75">75</span> |
| <span id="76">76</span> |
| <span id="77">77</span> |
| <span id="78">78</span> |
| <span id="79">79</span> |
| <span id="80">80</span> |
| <span id="81">81</span> |
| <span id="82">82</span> |
| <span id="83">83</span> |
| <span id="84">84</span> |
| <span id="85">85</span> |
| <span id="86">86</span> |
| <span id="87">87</span> |
| <span id="88">88</span> |
| <span id="89">89</span> |
| <span id="90">90</span> |
| <span id="91">91</span> |
| <span id="92">92</span> |
| <span id="93">93</span> |
| <span id="94">94</span> |
| <span id="95">95</span> |
| <span id="96">96</span> |
| <span id="97">97</span> |
| <span id="98">98</span> |
| </pre><pre class="rust"><code><span class="attribute">#![doc(html_root_url = <span class="string">"https://docs.rs/ipnet/2.7.2"</span>)] |
| </span><span class="doccomment">//! Types for IPv4 and IPv6 network addresses. |
| //! |
| //! This module provides types and useful methods for working with IPv4 |
| //! and IPv6 network addresses, commonly called IP prefixes. The new |
| //! [`IpNet`], [`Ipv4Net`], and [`Ipv6Net`] types build on the existing |
| //! [`IpAddr`], [`Ipv4Addr`], and [`Ipv6Addr`] types already provided in |
| //! Rust's standard library and align to their design to stay |
| //! consistent. |
| //! |
| //! The module also provides the [`IpSubnets`], [`Ipv4Subnets`], and |
| //! [`Ipv6Subnets`] types for iterating over the subnets contained in |
| //! an IP address range. The [`IpAddrRange`], [`Ipv4AddrRange`], and |
| //! [`Ipv6AddrRange`] types for iterating over IP addresses in a range. |
| //! And traits that extend `Ipv4Addr` and `Ipv6Addr` with methods for |
| //! addition, subtraction, bitwise-and, and bitwise-or operations that |
| //! are missing in Rust's standard library. |
| //! |
| //! The module only uses stable features so it is guaranteed to compile |
| //! using the stable toolchain. |
| //! |
| //! # Organization |
| //! |
| //! * [`IpNet`] represents an IP network address, either IPv4 or IPv6. |
| //! * [`Ipv4Net`] and [`Ipv6Net`] are respectively IPv4 and IPv6 network |
| //! addresses. |
| //! * [`IpSubnets`], [`Ipv4Subnets`], and [`Ipv6Subnets`] 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 |
| //! [`subnets()`] methods and used within the [`aggregate()`] methods. |
| //! * [`IpAddrRange`], [`Ipv4AddrRange`], and [`Ipv6AddrRange`] are |
| //! iterators that generate IP addresses. These can be created using |
| //! their constructors. They are also returned by the [`hosts()`] |
| //! methods. |
| //! * The [`IpAdd`], [`IpSub`], [`IpBitAnd`], [`IpBitOr`] traits extend |
| //! the [`Ipv4Addr`] and [`Ipv6Addr`] types with methods to perform |
| //! these operations. |
| //! |
| //! [`IpNet`]: enum.IpNet.html |
| //! [`Ipv4Net`]: struct.Ipv4Net.html |
| //! [`Ipv6Net`]: struct.Ipv6Net.html |
| //! [`IpAddr`]: https://doc.rust-lang.org/std/net/enum.IpAddr.html |
| //! [`Ipv4Addr`]: https://doc.rust-lang.org/std/net/struct.Ipv4Addr.html |
| //! [`Ipv6Addr`]: https://doc.rust-lang.org/std/net/struct.Ipv6Addr.html |
| //! [`IpSubnets`]: enum.IpSubnets.html |
| //! [`Ipv4Subnets`]: struct.Ipv4Subnets.html |
| //! [`Ipv6Subnets`]: struct.Ipv6Subnets.html |
| //! [`subnets()`]: enum.IpNet.html#method.subnets |
| //! [`aggregate()`]: enum.IpNet.html#method.aggregate |
| //! [`IpAddrRange`]: enum.IpAddrRange.html |
| //! [`Ipv4AddrRange`]: struct.Ipv4AddrRange.html |
| //! [`Ipv6AddrRange`]: struct.Ipv6AddrRange.html |
| //! [`hosts()`]: enum.IpNet.html#method.hosts |
| //! [`IpAdd`]: trait.IpAdd.html |
| //! [`IpSub`]: trait.IpSub.html |
| //! [`IpBitAnd`]: trait.IpBitAnd.html |
| //! [`IpBitOr`]: trait.IpBitOr.html |
| //! |
| //! # Serde support |
| //! |
| //! This library comes with support for [serde](https://serde.rs) but |
| //! it's not enabled by default. Use the `serde` [feature] to enable. |
| //! |
| //! ```toml |
| //! [dependencies] |
| //! ipnet = { version = "2", features = ["serde"] } |
| //! ``` |
| //! |
| //! For human readable formats (e.g. JSON) the `IpNet`, `Ipv4Net`, and |
| //! `Ipv6Net` types will serialize to their `Display` strings. |
| //! |
| //! For compact binary formats (e.g. Bincode) the `Ipv4Net` and |
| //! `Ipv6Net` types will serialize to a string of 5 and 17 bytes that |
| //! consist of the network address octects followed by the prefix |
| //! length. The `IpNet` type will serialize to an Enum with the V4 or V6 |
| //! variant index prepending the above string of 5 or 17 bytes. |
| //! |
| //! [feature]: https://doc.rust-lang.org/cargo/reference/manifest.html#the-features-section |
| |
| </span><span class="attribute">#[cfg(feature = <span class="string">"serde"</span>)] |
| </span><span class="kw">extern crate </span>serde; |
| <span class="attribute">#[cfg(feature = <span class="string">"schemars"</span>)] |
| </span><span class="kw">extern crate </span>schemars; |
| |
| <span class="kw">pub use </span><span class="self">self</span>::ipext::{IpAdd, IpSub, IpBitAnd, IpBitOr, IpAddrRange, Ipv4AddrRange, Ipv6AddrRange}; |
| <span class="kw">pub use </span><span class="self">self</span>::ipnet::{IpNet, Ipv4Net, Ipv6Net, PrefixLenError, IpSubnets, Ipv4Subnets, Ipv6Subnets}; |
| <span class="kw">pub use </span><span class="self">self</span>::parser::AddrParseError; |
| <span class="kw">pub use </span><span class="self">self</span>::mask::{ip_mask_to_prefix, ipv4_mask_to_prefix, ipv6_mask_to_prefix}; |
| |
| <span class="kw">mod </span>ipext; |
| <span class="kw">mod </span>ipnet; |
| <span class="kw">mod </span>parser; |
| <span class="kw">mod </span>mask; |
| <span class="attribute">#[cfg(feature = <span class="string">"serde"</span>)] |
| </span><span class="kw">mod </span>ipnet_serde; |
| <span class="attribute">#[cfg(feature = <span class="string">"schemars"</span>)] |
| </span><span class="kw">mod </span>ipnet_schemars; |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="ipnet" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
