Enum smoltcp::wire::IpAddress

#[non_exhaustive]
pub enum IpAddress {
    Unspecified,
    Ipv4(Ipv4Address),
    Ipv6(Ipv6Address),
}

An internetworking address.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Unspecified

An unspecified address. May be used as a placeholder for storage where the address is not assigned yet.

Ipv4(Ipv4Address)

An IPv4 address.

Ipv6(Ipv6Address)

An IPv6 address.

Implementations

impl Address

pub fn v4(a0: u8, a1: u8, a2: u8, a3: u8) -> Address

Create an address wrapping an IPv4 address with the given octets.

pub fn v6(
    a0: u16,
    a1: u16,
    a2: u16,
    a3: u16,
    a4: u16,
    a5: u16,
    a6: u16,
    a7: u16
) -> Address

Create an address wrapping an IPv6 address with the given octets.

pub fn as_bytes(&self) -> &[u8]

Return an address as a sequence of octets, in big-endian.

pub fn is_unicast(&self) -> bool

Query whether the address is a valid unicast address.

pub fn is_multicast(&self) -> bool

Query whether the address is a valid multicast address.

pub fn is_broadcast(&self) -> bool

Query whether the address is the broadcast address.

pub fn is_unspecified(&self) -> bool

Query whether the address falls into the “unspecified” range.

pub fn as_unspecified(&self) -> Address

Return an unspecified address that has the same IP version as self.

pub fn prefix_len(&self) -> Option<u8>

If self is a CIDR-compatible subnet mask, return Some(prefix_len), where prefix_len is the number of leading zeroes. Return None otherwise.

Trait Implementations

impl Clone for Address

fn clone(&self) -> Address

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Address

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

Formats the value using the given formatter.

impl Default for Address

fn default() -> Address

Returns the “default value” for a type.

impl Display for Address

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

Formats the value using the given formatter.

impl From<Address> for Address

fn from(addr: Ipv4Address) -> Self

Converts to this type from the input type.

impl From<Address> for Address

fn from(addr: Ipv6Address) -> Self

Converts to this type from the input type.

impl FromStr for IpAddress

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

Parse a string representation of an IP address.

type Err = ()

The associated error which can be returned from parsing.

impl Hash for Address

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 Ord for Address

fn cmp(&self, other: &Address) -> 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.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Address> for Address

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

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

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

This method tests for !=.

impl PartialOrd<Address> for Address

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

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

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

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

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

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

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

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

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

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

impl Copy for Address

impl Eq for Address

impl StructuralEq for Address

impl StructuralPartialEq for Address