Struct domain_core::rdata::rfc1035::A

pub struct A { /* fields omitted */ }

A record data.

A records convey the IPv4 address of a host. The wire format is the 32 bit IPv4 address in network byte order. The master file format is the usual dotted notation.

The A record type is defined in RFC 1035, section 3.4.1.

Methods

impl A

pub fn new(addr: Ipv4Addr) -> A

Creates a new A record data from an IPv4 address.

pub fn from_octets(a: u8, b: u8, c: u8, d: u8) -> A

Creates a new A record from the IPv4 address components.

pub fn addr(&self) -> Ipv4Addr

pub fn set_addr(&mut self, addr: Ipv4Addr)

Methods from Deref<Target = Ipv4Addr>

pub const LOCALHOST: Ipv4Addr

pub const UNSPECIFIED: Ipv4Addr

pub const BROADCAST: Ipv4Addr

pub fn octets(&self) -> [u8; 4]

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

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 fn is_loopback(&self) -> bool

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 fn is_private(&self) -> bool

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 fn is_link_local(&self) -> bool

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 fn is_global(&self) -> bool

🔬 This is a nightly-only experimental API. (ip)

extra functionality has not been scrutinized to the level that it should be to be stable

Returns true if the address appears to be globally routable. See iana-ipv4-special-registry.

The following return false:

• private address (10.0.0.0/8, 172.16.0.0/12 and 192.168.0.0/16)
• the loopback address (127.0.0.0/8)
• the link-local address (169.254.0.0/16)
• the broadcast address (255.255.255.255/32)
• test addresses used for documentation (192.0.2.0/24, 198.51.100.0/24 and 203.0.113.0/24)
• the unspecified address (0.0.0.0)

Examples

#![feature(ip)]

use std::net::Ipv4Addr;

fn main() {
    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);
    assert_eq!(Ipv4Addr::new(0, 0, 0, 0).is_global(), false);
    assert_eq!(Ipv4Addr::new(80, 9, 12, 3).is_global(), true);
}

pub fn is_multicast(&self) -> bool

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 fn is_broadcast(&self) -> bool

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 fn is_documentation(&self) -> bool

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 fn to_ipv6_compatible(&self) -> Ipv6Addr

Converts this address to an IPv4-compatible IPv6 address.

a.b.c.d becomes ::a.b.c.d

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 fn to_ipv6_mapped(&self) -> Ipv6Addr

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 Compose for A

fn compose_len(&self) -> usize

Returns the number of bytes this value will need without compression.

fn compose<B: BufMut>(&self, buf: &mut B)

Appends the uncompressed representation of this value to buf.

impl Compress for A

fn compress(&self, buf: &mut Compressor) -> Result<(), ShortBuf>

Appends the wire-format representation of the value to buf.

impl Parse for A

type Err = <Ipv4Addr as Parse>::Err

The type of an error returned when parsing fails.

fn parse(parser: &mut Parser) -> Result<Self, Self::Err>

Extracts a value from the beginning of parser.

fn skip(parser: &mut Parser) -> Result<(), Self::Err>

Skips over a value of this type at the beginning of parser.

impl ParseAll for A

type Err = <Ipv4Addr as ParseAll>::Err

The type returned when parsing fails.

fn parse_all(parser: &mut Parser, len: usize) -> Result<Self, Self::Err>

Parses a value len bytes long from the beginning of the parser.

impl RtypeRecordData for A

const RTYPE: Rtype

The record type of a value of this type.

impl Scan for A

fn scan<C: CharSource>(scanner: &mut Scanner<C>) -> Result<Self, ScanError>

Scans a value from a master file.

impl AsRef<Ipv4Addr> for A

fn as_ref(&self) -> &Ipv4Addr

Performs the conversion.

impl AsMut<Ipv4Addr> for A

fn as_mut(&mut self) -> &mut Ipv4Addr

Performs the conversion.

impl From<Ipv4Addr> for A

fn from(addr: Ipv4Addr) -> Self

Performs the conversion.

impl From<A> for Ipv4Addr

fn from(a: A) -> Self

Performs the conversion.

impl<N> From<A> for MasterRecordData<N>

fn from(value: A) -> Self

Performs the conversion.

impl<N> From<A> for AllRecordData<N>

fn from(value: A) -> Self

Performs the conversion.

impl PartialEq<A> for A

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

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

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

This method tests for !=.

impl PartialOrd<A> for A

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

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

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

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

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

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

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

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

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

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

impl Eq for A

impl Ord for A

fn cmp(&self, other: &A) -> 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 Clone for A

fn clone(&self) -> A

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for A

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

Formats the value using the given formatter.

impl Display for A

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

Formats the value using the given formatter.

impl Deref for A

type Target = Ipv4Addr

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for A

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Hash for A

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 A

type Err = <Ipv4Addr as FromStr>::Err

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.