Struct postgres_inet::MaskedIpAddr

pub struct MaskedIpAddr { /* fields omitted */ }

An IP address, if necessary in CIDR notation.

Methods

impl MaskedIpAddr

pub fn new<I: Into<IpAddr>>(addr: I, cidr: u8) -> MaskedIpAddr

Creates a new MaskedIpAddr from components.

Do not pass an addr with bits set to the right of the netmask if you intend to insert this into a postgres cidr field.

Panics

Panics if the CIDR is greater than 32 for an IPv4 address, or is greater than 128 for an IPv6 address.

Examples

To represent an address:

let ip = Ipv4Addr::new(192, 0, 2, 142);
MaskedIpAddr::new(ip, 32);

To represent a network:

let network = Ipv6Addr::new(0x2001, 0x0DB8, 0, 0, 0, 0, 0, 0);
MaskedIpAddr::new(network, 32);

pub fn is_unspecified(&self) -> bool

Returns true for the special 'unspecified' address.

See the documentation for Ipv4Addr::is_unspecified and Ipv6Addr::is_unspecified for more details.

Examples

assert!(MaskedIpAddr::new(Ipv4Addr::new(0, 0, 0, 0), 32).is_unspecified());
assert!(MaskedIpAddr::new(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0), 128).is_unspecified());

pub fn is_loopback(&self) -> bool

Returns true if this is a loopback address.

See the documentation for Ipv4Addr::is_loopback and Ipv6Addr::is_loopback for more details.

Examples

assert!(MaskedIpAddr::new(Ipv4Addr::new(127, 0, 0, 1), 32).is_loopback());
assert!(MaskedIpAddr::new(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1), 128).is_loopback());

pub fn is_multicast(&self) -> bool

Returns true if this is a multicast address.

See the documentation for Ipv4Addr::is_multicast and Ipv6Addr::is_multicast for more details.

Examples

assert!(MaskedIpAddr::new(Ipv4Addr::new(224, 254, 0, 0), 32).is_multicast());
assert!(MaskedIpAddr::new(Ipv6Addr::new(0xff00, 0, 0, 0, 0, 0, 0, 0), 128).is_multicast());

pub fn is_ipv4(&self) -> bool

Returns true if this address is an IPv4 address, and false otherwise.

Examples

assert!(MaskedIpAddr::new(Ipv4Addr::new(203, 0, 113, 6), 32).is_ipv4());
assert!(!MaskedIpAddr::new(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0), 128).is_ipv4());

pub fn is_ipv6(&self) -> bool

Returns true if this address is an IPv6 address, and false otherwise.

Examples

assert!(!MaskedIpAddr::new(Ipv4Addr::new(203, 0, 113, 6), 32).is_ipv6());
assert!(MaskedIpAddr::new(Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0), 128).is_ipv6());

pub fn address(&self) -> IpAddr

Returns the contained IP address.

Examples

let ip = Ipv4Addr::new(192, 0, 2, 142);
assert_eq!(MaskedIpAddr::new(ip, 32).address(), ip);
let network = Ipv6Addr::new(0x2001, 0x0DB8, 0, 0, 0, 0, 0, 0);
assert_eq!(MaskedIpAddr::new(network, 32).address(), network);

pub fn cidr(&self) -> u8

Returns the contained CIDR.

Examples

assert_eq!(MaskedIpAddr::new(Ipv4Addr::new(192, 0, 2, 142), 32).cidr(), 32);
assert_eq!(MaskedIpAddr::new(Ipv6Addr::new(0x2001, 0x0DB8, 0, 0, 0, 0, 0, 0), 64).cidr(), 64);

pub fn netmask(&self) -> u8

Deprecated since 0.15.2

: Supported because of historical (and wrong) use of netmask instead of CIDR. Use MaskedIpAddr::cidr instead.

Returns the contained CIDR.

Examples

assert_eq!(MaskedIpAddr::new(Ipv4Addr::new(192, 0, 2, 142), 32).netmask(), 32);
assert_eq!(MaskedIpAddr::new(Ipv6Addr::new(0x2001, 0x0DB8, 0, 0, 0, 0, 0, 0), 64).netmask(), 64);

pub fn subnet_mask(&self) -> u128

Returns the subnet mask, calculated from the CIDR.

pub fn into_inner(self) -> (IpAddr, u8)

Consumes the MaskedIpAddr, returning the IP address and netmask.

Examples

let network = Ipv4Addr::new(198, 51, 100, 0);
assert_eq!(MaskedIpAddr::new(network, 24).into_inner(), (network.into(), 24));

Trait Implementations

impl Clone for MaskedIpAddr

fn clone(&self) -> MaskedIpAddr

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for MaskedIpAddr

impl From<Ipv4Addr> for MaskedIpAddr

fn from(ipv4: Ipv4Addr) -> MaskedIpAddr

Performs the conversion.

impl From<Ipv6Addr> for MaskedIpAddr

fn from(ipv6: Ipv6Addr) -> MaskedIpAddr

Performs the conversion.

impl From<IpAddr> for MaskedIpAddr

fn from(ip: IpAddr) -> MaskedIpAddr

Performs the conversion.

impl From<MaskedIpAddr> for IpAddr

fn from(mip: MaskedIpAddr) -> IpAddr

Performs the conversion.

impl From<[u8; 4]> for MaskedIpAddr

fn from(octets: [u8; 4]) -> MaskedIpAddr

Performs the conversion.

impl From<[u8; 16]> for MaskedIpAddr

fn from(octets: [u8; 16]) -> MaskedIpAddr

Performs the conversion.

impl From<[u16; 8]> for MaskedIpAddr

fn from(segments: [u16; 8]) -> MaskedIpAddr

Performs the conversion.

impl Eq for MaskedIpAddr

impl PartialOrd<MaskedIpAddr> for MaskedIpAddr

fn partial_cmp(&self, other: &MaskedIpAddr) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &MaskedIpAddr) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &MaskedIpAddr) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &MaskedIpAddr) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &MaskedIpAddr) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialEq<MaskedIpAddr> for MaskedIpAddr

fn eq(&self, other: &MaskedIpAddr) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &MaskedIpAddr) -> bool

This method tests for !=.

impl Ord for MaskedIpAddr

fn cmp(&self, other: &MaskedIpAddr) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

impl Debug for MaskedIpAddr

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Display for MaskedIpAddr

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Hash for MaskedIpAddr

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where     H: Hasher,

Feeds a slice of this type into the given [Hasher].

impl FromStr for MaskedIpAddr

type Err = MaskedIpAddrParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl ToSql for MaskedIpAddr

fn to_sql(     &self,     ty: &Type,     w: &mut Vec<u8> ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

Converts the value of self into the binary format of the specified Postgres Type, appending it to out.

fn accepts(ty: &Type) -> bool

Determines if a value of this type can be converted to the specified Postgres Type.

fn to_sql_checked(     &self,     ty: &Type,     out: &mut Vec<u8> ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

An adaptor method used internally by Rust-Postgres.

impl FromSql for MaskedIpAddr

fn from_sql(     _: &Type,     raw: &[u8] ) -> Result<Self, Box<dyn Error + Sync + Send + 'static>>

Creates a new value of this type from a buffer of data of the specified Postgres Type in its binary format.

fn accepts(ty: &Type) -> bool

Determines if a value of this type can be created from the specified Postgres Type.

fn from_sql_null(     ty: &Type ) -> Result<Self, Box<dyn Error + 'static + Send + Sync>>

Creates a new value of this type from a NULL SQL value.

fn from_sql_nullable(     ty: &Type,     raw: Option<&[u8]> ) -> Result<Self, Box<dyn Error + 'static + Send + Sync>>

A convenience function that delegates to from_sql and from_sql_null depending on the value of raw.