Struct klickhouse::Ipv4 [−][src]
pub struct Ipv4(pub Ipv4Addr);
Expand description
Wrapper type for Clickhouse IPv4
type.
Methods from Deref<Target = Ipv4Addr>
pub const LOCALHOST: Ipv4Addr
1.30.0[src]
pub const UNSPECIFIED: Ipv4Addr
1.30.0[src]
pub const BROADCAST: Ipv4Addr
1.30.0[src]
pub const fn octets(&self) -> [u8; 4]
1.0.0 (const: 1.50.0)[src]
pub const fn octets(&self) -> [u8; 4]
1.0.0 (const: 1.50.0)[src]Returns the four eight-bit integers that make up this address.
Examples
use std::net::Ipv4Addr; let addr = Ipv4Addr::new(127, 0, 0, 1); assert_eq!(addr.octets(), [127, 0, 0, 1]);
pub const fn is_unspecified(&self) -> bool
1.12.0 (const: 1.32.0)[src]
pub const fn is_unspecified(&self) -> bool
1.12.0 (const: 1.32.0)[src]Returns true
for the special ‘unspecified’ address (0.0.0.0).
This property is defined in UNIX Network Programming, Second Edition, W. Richard Stevens, p. 891; see also ip7.
Examples
use std::net::Ipv4Addr; assert_eq!(Ipv4Addr::new(0, 0, 0, 0).is_unspecified(), true); assert_eq!(Ipv4Addr::new(45, 22, 13, 197).is_unspecified(), false);
pub const fn is_loopback(&self) -> bool
1.7.0 (const: 1.50.0)[src]
pub const fn is_loopback(&self) -> bool
1.7.0 (const: 1.50.0)[src]Returns true
if this is a loopback address (127.0.0.0/8).
This property is defined by IETF RFC 1122.
Examples
use std::net::Ipv4Addr; assert_eq!(Ipv4Addr::new(127, 0, 0, 1).is_loopback(), true); assert_eq!(Ipv4Addr::new(45, 22, 13, 197).is_loopback(), false);
pub const fn is_private(&self) -> bool
1.7.0 (const: 1.50.0)[src]
pub const fn is_private(&self) -> bool
1.7.0 (const: 1.50.0)[src]Returns true
if this is a private address.
The private address ranges are defined in IETF RFC 1918 and include:
- 10.0.0.0/8
- 172.16.0.0/12
- 192.168.0.0/16
Examples
use std::net::Ipv4Addr; assert_eq!(Ipv4Addr::new(10, 0, 0, 1).is_private(), true); assert_eq!(Ipv4Addr::new(10, 10, 10, 10).is_private(), true); assert_eq!(Ipv4Addr::new(172, 16, 10, 10).is_private(), true); assert_eq!(Ipv4Addr::new(172, 29, 45, 14).is_private(), true); assert_eq!(Ipv4Addr::new(172, 32, 0, 2).is_private(), false); assert_eq!(Ipv4Addr::new(192, 168, 0, 2).is_private(), true); assert_eq!(Ipv4Addr::new(192, 169, 0, 2).is_private(), false);
pub const fn is_link_local(&self) -> bool
1.7.0 (const: 1.50.0)[src]
pub const fn is_link_local(&self) -> bool
1.7.0 (const: 1.50.0)[src]Returns true
if the address is link-local (169.254.0.0/16).
This property is defined by IETF RFC 3927.
Examples
use std::net::Ipv4Addr; assert_eq!(Ipv4Addr::new(169, 254, 0, 0).is_link_local(), true); assert_eq!(Ipv4Addr::new(169, 254, 10, 65).is_link_local(), true); assert_eq!(Ipv4Addr::new(16, 89, 10, 65).is_link_local(), false);
pub const fn is_global(&self) -> bool
[src]
🔬 This is a nightly-only experimental API. (ip
)
pub const fn is_global(&self) -> bool
[src]ip
)Returns true
if the address appears to be globally routable.
See iana-ipv4-special-registry.
The following return false
:
- private addresses (see
Ipv4Addr::is_private()
) - the loopback address (see
Ipv4Addr::is_loopback()
) - the link-local address (see
Ipv4Addr::is_link_local()
) - the broadcast address (see
Ipv4Addr::is_broadcast()
) - addresses used for documentation (see
Ipv4Addr::is_documentation()
) - the unspecified address (see
Ipv4Addr::is_unspecified()
), and the whole 0.0.0.0/8 block - addresses reserved for future protocols (see
Ipv4Addr::is_ietf_protocol_assignment()
, except192.0.0.9/32
and192.0.0.10/32
which are globally routable - addresses reserved for future use (see
Ipv4Addr::is_reserved()
- addresses reserved for networking devices benchmarking (see
Ipv4Addr::is_benchmarking()
)
Examples
#![feature(ip)] use std::net::Ipv4Addr; // private addresses are not global assert_eq!(Ipv4Addr::new(10, 254, 0, 0).is_global(), false); assert_eq!(Ipv4Addr::new(192, 168, 10, 65).is_global(), false); assert_eq!(Ipv4Addr::new(172, 16, 10, 65).is_global(), false); // the 0.0.0.0/8 block is not global assert_eq!(Ipv4Addr::new(0, 1, 2, 3).is_global(), false); // in particular, the unspecified address is not global assert_eq!(Ipv4Addr::new(0, 0, 0, 0).is_global(), false); // the loopback address is not global assert_eq!(Ipv4Addr::new(127, 0, 0, 1).is_global(), false); // link local addresses are not global assert_eq!(Ipv4Addr::new(169, 254, 45, 1).is_global(), false); // the broadcast address is not global assert_eq!(Ipv4Addr::new(255, 255, 255, 255).is_global(), false); // the address space designated for documentation is not global assert_eq!(Ipv4Addr::new(192, 0, 2, 255).is_global(), false); assert_eq!(Ipv4Addr::new(198, 51, 100, 65).is_global(), false); assert_eq!(Ipv4Addr::new(203, 0, 113, 6).is_global(), false); // shared addresses are not global assert_eq!(Ipv4Addr::new(100, 100, 0, 0).is_global(), false); // addresses reserved for protocol assignment are not global assert_eq!(Ipv4Addr::new(192, 0, 0, 0).is_global(), false); assert_eq!(Ipv4Addr::new(192, 0, 0, 255).is_global(), false); // addresses reserved for future use are not global assert_eq!(Ipv4Addr::new(250, 10, 20, 30).is_global(), false); // addresses reserved for network devices benchmarking are not global assert_eq!(Ipv4Addr::new(198, 18, 0, 0).is_global(), false); // All the other addresses are global assert_eq!(Ipv4Addr::new(1, 1, 1, 1).is_global(), true); assert_eq!(Ipv4Addr::new(80, 9, 12, 3).is_global(), true);
pub const fn is_shared(&self) -> bool
[src]
🔬 This is a nightly-only experimental API. (ip
)
pub const fn is_shared(&self) -> bool
[src]ip
)Returns true
if this address is part of the Shared Address Space defined in
IETF RFC 6598 (100.64.0.0/10
).
Examples
#![feature(ip)] use std::net::Ipv4Addr; assert_eq!(Ipv4Addr::new(100, 64, 0, 0).is_shared(), true); assert_eq!(Ipv4Addr::new(100, 127, 255, 255).is_shared(), true); assert_eq!(Ipv4Addr::new(100, 128, 0, 0).is_shared(), false);
pub const fn is_ietf_protocol_assignment(&self) -> bool
[src]
🔬 This is a nightly-only experimental API. (ip
)
pub const fn is_ietf_protocol_assignment(&self) -> bool
[src]ip
)Returns true
if this address is part of 192.0.0.0/24
, which is reserved to
IANA for IETF protocol assignments, as documented in IETF RFC 6890.
Note that parts of this block are in use:
192.0.0.8/32
is the “IPv4 dummy address” (see IETF RFC 7600)192.0.0.9/32
is the “Port Control Protocol Anycast” (see IETF RFC 7723)192.0.0.10/32
is used for NAT traversal (see IETF RFC 8155)
Examples
#![feature(ip)] use std::net::Ipv4Addr; assert_eq!(Ipv4Addr::new(192, 0, 0, 0).is_ietf_protocol_assignment(), true); assert_eq!(Ipv4Addr::new(192, 0, 0, 8).is_ietf_protocol_assignment(), true); assert_eq!(Ipv4Addr::new(192, 0, 0, 9).is_ietf_protocol_assignment(), true); assert_eq!(Ipv4Addr::new(192, 0, 0, 255).is_ietf_protocol_assignment(), true); assert_eq!(Ipv4Addr::new(192, 0, 1, 0).is_ietf_protocol_assignment(), false); assert_eq!(Ipv4Addr::new(191, 255, 255, 255).is_ietf_protocol_assignment(), false);
pub const fn is_benchmarking(&self) -> bool
[src]
🔬 This is a nightly-only experimental API. (ip
)
pub const fn is_benchmarking(&self) -> bool
[src]ip
)Returns true
if this address part of the 198.18.0.0/15
range, which is reserved for
network devices benchmarking. This range is defined in IETF RFC 2544 as 192.18.0.0
through 198.19.255.255
but errata 423 corrects it to 198.18.0.0/15
.
Examples
#![feature(ip)] use std::net::Ipv4Addr; assert_eq!(Ipv4Addr::new(198, 17, 255, 255).is_benchmarking(), false); assert_eq!(Ipv4Addr::new(198, 18, 0, 0).is_benchmarking(), true); assert_eq!(Ipv4Addr::new(198, 19, 255, 255).is_benchmarking(), true); assert_eq!(Ipv4Addr::new(198, 20, 0, 0).is_benchmarking(), false);
pub const fn is_reserved(&self) -> bool
[src]
🔬 This is a nightly-only experimental API. (ip
)
pub const fn is_reserved(&self) -> bool
[src]ip
)Returns true
if this address is reserved by IANA for future use. IETF RFC 1112
defines the block of reserved addresses as 240.0.0.0/4
. This range normally includes the
broadcast address 255.255.255.255
, but this implementation explicitly excludes it, since
it is obviously not reserved for future use.
Warning
As IANA assigns new addresses, this method will be updated. This may result in non-reserved addresses being treated as reserved in code that relies on an outdated version of this method.
Examples
#![feature(ip)] use std::net::Ipv4Addr; assert_eq!(Ipv4Addr::new(240, 0, 0, 0).is_reserved(), true); assert_eq!(Ipv4Addr::new(255, 255, 255, 254).is_reserved(), true); assert_eq!(Ipv4Addr::new(239, 255, 255, 255).is_reserved(), false); // The broadcast address is not considered as reserved for future use by this implementation assert_eq!(Ipv4Addr::new(255, 255, 255, 255).is_reserved(), false);
pub const fn is_multicast(&self) -> bool
1.7.0 (const: 1.50.0)[src]
pub const fn is_multicast(&self) -> bool
1.7.0 (const: 1.50.0)[src]Returns true
if this is a multicast address (224.0.0.0/4).
Multicast addresses have a most significant octet between 224 and 239, and is defined by IETF RFC 5771.
Examples
use std::net::Ipv4Addr; assert_eq!(Ipv4Addr::new(224, 254, 0, 0).is_multicast(), true); assert_eq!(Ipv4Addr::new(236, 168, 10, 65).is_multicast(), true); assert_eq!(Ipv4Addr::new(172, 16, 10, 65).is_multicast(), false);
pub const fn is_broadcast(&self) -> bool
1.7.0 (const: 1.50.0)[src]
pub const fn is_broadcast(&self) -> bool
1.7.0 (const: 1.50.0)[src]Returns true
if this is a broadcast address (255.255.255.255).
A broadcast address has all octets set to 255 as defined in IETF RFC 919.
Examples
use std::net::Ipv4Addr; assert_eq!(Ipv4Addr::new(255, 255, 255, 255).is_broadcast(), true); assert_eq!(Ipv4Addr::new(236, 168, 10, 65).is_broadcast(), false);
pub const fn is_documentation(&self) -> bool
1.7.0 (const: 1.50.0)[src]
pub const fn is_documentation(&self) -> bool
1.7.0 (const: 1.50.0)[src]Returns true
if this address is in a range designated for documentation.
This is defined in IETF RFC 5737:
- 192.0.2.0/24 (TEST-NET-1)
- 198.51.100.0/24 (TEST-NET-2)
- 203.0.113.0/24 (TEST-NET-3)
Examples
use std::net::Ipv4Addr; assert_eq!(Ipv4Addr::new(192, 0, 2, 255).is_documentation(), true); assert_eq!(Ipv4Addr::new(198, 51, 100, 65).is_documentation(), true); assert_eq!(Ipv4Addr::new(203, 0, 113, 6).is_documentation(), true); assert_eq!(Ipv4Addr::new(193, 34, 17, 19).is_documentation(), false);
pub const fn to_ipv6_compatible(&self) -> Ipv6Addr
1.0.0 (const: 1.50.0)[src]
pub const fn to_ipv6_compatible(&self) -> Ipv6Addr
1.0.0 (const: 1.50.0)[src]Converts this address to an IPv4-compatible IPv6
address.
a.b.c.d becomes ::a.b.c.d
This isn’t typically the method you want; these addresses don’t typically
function on modern systems. Use to_ipv6_mapped
instead.
Examples
use std::net::{Ipv4Addr, Ipv6Addr}; assert_eq!( Ipv4Addr::new(192, 0, 2, 255).to_ipv6_compatible(), Ipv6Addr::new(0, 0, 0, 0, 0, 0, 49152, 767) );
pub const fn to_ipv6_mapped(&self) -> Ipv6Addr
1.0.0 (const: 1.50.0)[src]
pub const fn to_ipv6_mapped(&self) -> Ipv6Addr
1.0.0 (const: 1.50.0)[src]Converts this address to an IPv4-mapped IPv6
address.
a.b.c.d becomes ::ffff:a.b.c.d
Examples
use std::net::{Ipv4Addr, Ipv6Addr}; assert_eq!(Ipv4Addr::new(192, 0, 2, 255).to_ipv6_mapped(), Ipv6Addr::new(0, 0, 0, 0, 0, 65535, 49152, 767));
Trait Implementations
impl Ord for Ipv4
[src]
impl Ord for Ipv4
[src]impl PartialOrd<Ipv4> for Ipv4
[src]
impl PartialOrd<Ipv4> for Ipv4
[src]fn partial_cmp(&self, other: &Ipv4) -> Option<Ordering>
[src]
fn partial_cmp(&self, other: &Ipv4) -> Option<Ordering>
[src]This method returns an ordering between self
and other
values if one exists. Read more
#[must_use]fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]fn lt(&self, other: &Rhs) -> bool
1.0.0[src]This method tests less than (for self
and other
) and is used by the <
operator. Read more
#[must_use]fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]fn le(&self, other: &Rhs) -> bool
1.0.0[src]This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
impl Copy for Ipv4
[src]
impl Eq for Ipv4
[src]
impl StructuralEq for Ipv4
[src]
impl StructuralPartialEq for Ipv4
[src]
Auto Trait Implementations
impl RefUnwindSafe for Ipv4
impl Send for Ipv4
impl Sync for Ipv4
impl Unpin for Ipv4
impl UnwindSafe for Ipv4
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<Q, K> Equivalent<K> for Q where
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,
[src]
impl<Q, K> Equivalent<K> for Q where
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,
[src]pub fn equivalent(&self, key: &K) -> bool
[src]
pub fn equivalent(&self, key: &K) -> bool
[src]Compare self to key
and return true
if they are equal.
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more