Enum inet2_addr::InetAddr

#[non_exhaustive]
pub enum InetAddr {
    IPv4(Ipv4Addr),
    IPv6(Ipv6Addr),
}

A universal address covering IPv4, IPv6 and Tor in a single byte sequence of 32 bytes.

Holds either:

• IPv4-to-IPv6 address
• IPv6 address
• Tor Onion address (V3 only)

NB: we are using [TorPublicKeyV3] instead of OnionAddressV3, since OnionAddressV3 keeps checksum and other information which can be reconstructed from [TorPublicKeyV3]. The 2-byte checksum in OnionAddressV3 is designed for human-readable part that checks that the address was typed in correctly. In computer-stored digital data it may be deterministically regenerated and does not add any additional security.

Tor addresses are distinguished by the fact that last 16 bits must be set to 0

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.

IPv4(Ipv4Addr)

IP address of V4 standard

IPv6(Ipv6Addr)

IP address of V6 standard

Implementations

impl InetAddr

pub fn to_ipv6(&self) -> Option<Ipv6Addr>

Returns an IPv6 address, constructed from IPv4 data; or, if Onion address is used, Option::None

pub fn to_ipv4(&self) -> Option<Ipv6Addr>

Returns an IPv4 address, if any, or Option::None

pub fn is_tor(&self) -> bool

Determines whether provided address is a Tor address. Always returns fales (the library is built without tor feature; use it to enable Tor addresses).

pub fn to_onion_v2(&self) -> Option<()>

Always returns Option::None (the library is built without tor feature; use it to enable Tor addresses).

pub fn to_onion(&self) -> Option<()>

Always returns Option::None (the library is built without tor feature; use it to enable Tor addresses).

Trait Implementations

impl Clone for InetAddr

fn clone(&self) -> InetAddr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InetAddr

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

Formats the value using the given formatter.

impl Default for InetAddr

fn default() -> Self

Returns the “default value” for a type.

impl Display for InetAddr

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

Formats the value using the given formatter.

impl From<[u16; 8]> for InetAddr

fn from(value: [u16; 8]) -> Self

Converts to this type from the input type.

impl From<[u8; 16]> for InetAddr

fn from(value: [u8; 16]) -> Self

Converts to this type from the input type.

impl From<[u8; 4]> for InetAddr

fn from(value: [u8; 4]) -> Self

Converts to this type from the input type.

impl From<InetAddr> for IpAddr

fn from(addr: InetAddr) -> Self

Converts to this type from the input type.

impl From<IpAddr> for InetAddr

fn from(value: IpAddr) -> Self

Converts to this type from the input type.

impl From<Ipv4Addr> for InetAddr

fn from(addr: Ipv4Addr) -> Self

Converts to this type from the input type.

impl From<Ipv6Addr> for InetAddr

fn from(addr: Ipv6Addr) -> Self

Converts to this type from the input type.

impl FromStr for InetAddr

type Err = AddrParseError

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 Hash for InetAddr

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 InetAddr

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

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

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

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

This method tests for !=.

impl PartialOrd<InetAddr> for InetAddr

fn partial_cmp(&self, other: &Self) -> 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 TryFrom<&'_ str> for InetAddr

type Error = <InetAddr as FromStr>::Err

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for InetAddr

impl Eq for InetAddr

impl StructuralEq for InetAddr

impl StructuralPartialEq for InetAddr