blob: ea7027f0377f74ef315344f08f8cda5d9a2cae2b [file] [log] [blame]
<!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 `bitor()` method for `Ipv4Addr` and `Ipv6Addr`."><meta name="keywords" content="rust, rustlang, rust-lang, IpBitOr"><title>IpBitOr in ipnet - Rust</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="sidebar-items.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 trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../ipnet/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><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><h2 class="location"><a href="#">IpBitOr</a></h2><div class="sidebar-elems"><section><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Output">Output</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.bitor">bitor</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-IpBitOr%3CIpv4Addr%3E-for-Ipv4Addr">Ipv4Addr</a></li><li><a href="#impl-IpBitOr%3Cu32%3E-for-Ipv4Addr">Ipv4Addr</a></li><li><a href="#impl-IpBitOr%3CIpv6Addr%3E-for-Ipv6Addr">Ipv6Addr</a></li><li><a href="#impl-IpBitOr%3Cu128%3E-for-Ipv6Addr">Ipv6Addr</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In ipnet</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><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="main-heading"><h1 class="fqn">Trait <a href="index.html">ipnet</a>::<wbr><a class="trait" href="#">IpBitOr</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../src/ipnet/ipext.rs.html#136-139">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="item-decl"><pre class="rust trait"><code>pub trait IpBitOr&lt;RHS&nbsp;=&nbsp;Self&gt; {
type <a href="#associatedtype.Output" class="associatedtype">Output</a>;
fn <a href="#tymethod.bitor" class="fnname">bitor</a>(self, rhs: RHS) -&gt; Self::<a class="associatedtype" href="trait.IpBitOr.html#associatedtype.Output" title="type ipnet::IpBitOr::Output">Output</a>;
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Provides a <code>bitor()</code> method for <code>Ipv4Addr</code> and <code>Ipv6Addr</code>.</p>
<h2 id="examples"><a href="#examples">Examples</a></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::IpBitOr;
<span class="kw">let </span>ip: Ipv4Addr = <span class="string">&quot;10.1.1.1&quot;</span>.parse().unwrap();
<span class="kw">let </span>mask: Ipv4Addr = <span class="string">&quot;0.0.0.255&quot;</span>.parse().unwrap();
<span class="kw">let </span>res: Ipv4Addr = <span class="string">&quot;10.1.1.255&quot;</span>.parse().unwrap();
<span class="macro">assert_eq!</span>(ip.bitor(mask), res);
<span class="macro">assert_eq!</span>(ip.bitor(<span class="number">0x000000ff</span>), res);
<span class="kw">let </span>ip: Ipv6Addr = <span class="string">&quot;fd00::1&quot;</span>.parse().unwrap();
<span class="kw">let </span>mask: Ipv6Addr = <span class="string">&quot;::ffff:ffff&quot;</span>.parse().unwrap();
<span class="kw">let </span>res: Ipv6Addr = <span class="string">&quot;fd00::ffff:ffff&quot;</span>.parse().unwrap();
<span class="macro">assert_eq!</span>(ip.bitor(mask), res);
<span class="macro">assert_eq!</span>(ip.bitor(u128::from(<span class="number">0xffffffffu32</span>)), res);</code></pre></div>
</div></details><h2 id="required-associated-types" class="small-section-header">Required Associated Types<a href="#required-associated-types" class="anchor"></a></h2><div class="methods"><section id="associatedtype.Output" class="method has-srclink"><a class="srclink rightside" href="../src/ipnet/ipext.rs.html#137">source</a><h4 class="code-header">type <a href="#associatedtype.Output" class="associatedtype">Output</a></h4></section></div><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><section id="tymethod.bitor" class="method has-srclink"><a class="srclink rightside" href="../src/ipnet/ipext.rs.html#138">source</a><h4 class="code-header">fn <a href="#tymethod.bitor" class="fnname">bitor</a>(self, rhs: RHS) -&gt; Self::<a class="associatedtype" href="trait.IpBitOr.html#associatedtype.Output" title="type ipnet::IpBitOr::Output">Output</a></h4></section></div><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-IpBitOr%3CIpv4Addr%3E-for-Ipv4Addr" class="impl has-srclink"><a class="srclink rightside" href="../src/ipnet/ipext.rs.html#203-208">source</a><a href="#impl-IpBitOr%3CIpv4Addr%3E-for-Ipv4Addr" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.IpBitOr.html" title="trait ipnet::IpBitOr">IpBitOr</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/std/net/ip_addr/struct.Ipv4Addr.html" title="struct std::net::ip_addr::Ipv4Addr">Ipv4Addr</a>&gt; for <a class="struct" href="https://doc.rust-lang.org/nightly/std/net/ip_addr/struct.Ipv4Addr.html" title="struct std::net::ip_addr::Ipv4Addr">Ipv4Addr</a></h3></section></summary><div class="impl-items"><section id="associatedtype.Output-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Output-1" 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/nightly/std/net/ip_addr/struct.Ipv4Addr.html" title="struct std::net::ip_addr::Ipv4Addr">Ipv4Addr</a></h4></section><section id="method.bitor" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/ipnet/ipext.rs.html#203-208">source</a><a href="#method.bitor" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.bitor" class="fnname">bitor</a>(self, rhs: <a class="struct" href="https://doc.rust-lang.org/nightly/std/net/ip_addr/struct.Ipv4Addr.html" title="struct std::net::ip_addr::Ipv4Addr">Ipv4Addr</a>) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/std/net/ip_addr/struct.Ipv4Addr.html" title="struct std::net::ip_addr::Ipv4Addr">Ipv4Addr</a></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-IpBitOr%3Cu32%3E-for-Ipv4Addr" class="impl has-srclink"><a class="srclink rightside" href="../src/ipnet/ipext.rs.html#203-208">source</a><a href="#impl-IpBitOr%3Cu32%3E-for-Ipv4Addr" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.IpBitOr.html" title="trait ipnet::IpBitOr">IpBitOr</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>&gt; for <a class="struct" href="https://doc.rust-lang.org/nightly/std/net/ip_addr/struct.Ipv4Addr.html" title="struct std::net::ip_addr::Ipv4Addr">Ipv4Addr</a></h3></section></summary><div class="impl-items"><section id="associatedtype.Output-2" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Output-2" 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/nightly/std/net/ip_addr/struct.Ipv4Addr.html" title="struct std::net::ip_addr::Ipv4Addr">Ipv4Addr</a></h4></section><section id="method.bitor-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/ipnet/ipext.rs.html#203-208">source</a><a href="#method.bitor-1" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.bitor" class="fnname">bitor</a>(self, rhs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/std/net/ip_addr/struct.Ipv4Addr.html" title="struct std::net::ip_addr::Ipv4Addr">Ipv4Addr</a></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-IpBitOr%3CIpv6Addr%3E-for-Ipv6Addr" class="impl has-srclink"><a class="srclink rightside" href="../src/ipnet/ipext.rs.html#203-208">source</a><a href="#impl-IpBitOr%3CIpv6Addr%3E-for-Ipv6Addr" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.IpBitOr.html" title="trait ipnet::IpBitOr">IpBitOr</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/std/net/ip_addr/struct.Ipv6Addr.html" title="struct std::net::ip_addr::Ipv6Addr">Ipv6Addr</a>&gt; for <a class="struct" href="https://doc.rust-lang.org/nightly/std/net/ip_addr/struct.Ipv6Addr.html" title="struct std::net::ip_addr::Ipv6Addr">Ipv6Addr</a></h3></section></summary><div class="impl-items"><section id="associatedtype.Output-3" class="associatedtype trait-impl has-srclink"><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/nightly/std/net/ip_addr/struct.Ipv6Addr.html" title="struct std::net::ip_addr::Ipv6Addr">Ipv6Addr</a></h4></section><section id="method.bitor-2" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/ipnet/ipext.rs.html#203-208">source</a><a href="#method.bitor-2" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.bitor" class="fnname">bitor</a>(self, rhs: <a class="struct" href="https://doc.rust-lang.org/nightly/std/net/ip_addr/struct.Ipv6Addr.html" title="struct std::net::ip_addr::Ipv6Addr">Ipv6Addr</a>) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/std/net/ip_addr/struct.Ipv6Addr.html" title="struct std::net::ip_addr::Ipv6Addr">Ipv6Addr</a></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-IpBitOr%3Cu128%3E-for-Ipv6Addr" class="impl has-srclink"><a class="srclink rightside" href="../src/ipnet/ipext.rs.html#203-208">source</a><a href="#impl-IpBitOr%3Cu128%3E-for-Ipv6Addr" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.IpBitOr.html" title="trait ipnet::IpBitOr">IpBitOr</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u128.html">u128</a>&gt; for <a class="struct" href="https://doc.rust-lang.org/nightly/std/net/ip_addr/struct.Ipv6Addr.html" title="struct std::net::ip_addr::Ipv6Addr">Ipv6Addr</a></h3></section></summary><div class="impl-items"><section id="associatedtype.Output-4" class="associatedtype trait-impl has-srclink"><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/nightly/std/net/ip_addr/struct.Ipv6Addr.html" title="struct std::net::ip_addr::Ipv6Addr">Ipv6Addr</a></h4></section><section id="method.bitor-3" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/ipnet/ipext.rs.html#203-208">source</a><a href="#method.bitor-3" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.bitor" class="fnname">bitor</a>(self, rhs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u128.html">u128</a>) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/std/net/ip_addr/struct.Ipv6Addr.html" title="struct std::net::ip_addr::Ipv6Addr">Ipv6Addr</a></h4></section></div></details><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"></div><script src="../implementors/ipnet/ipext/trait.IpBitOr.js" data-ignore-extern-crates="std" async></script></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>