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 address (V2 and V3)

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.

For Version2 Tor support only OnionAddressV2 handling is supported. OnionAddressV2 can only be constructed from an address string.

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

pub fn clone(&self) -> InetAddr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for InetAddr

impl Debug for InetAddr

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

Formats the value using the given formatter.

impl Default for InetAddr

pub fn default() -> Self

Returns the "default value" for a type.

impl Display for InetAddr

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

Formats the value using the given formatter.

impl Eq for InetAddr

impl From<[u16; 8]> for InetAddr

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

Performs the conversion.

impl From<[u8; 16]> for InetAddr

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

Performs the conversion.

impl From<[u8; 4]> for InetAddr

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

Performs the conversion.

impl From<IpAddr> for InetAddr

pub fn from(value: IpAddr) -> Self

Performs the conversion.

impl From<Ipv4Addr> for InetAddr

pub fn from(addr: Ipv4Addr) -> Self

Performs the conversion.

impl From<Ipv6Addr> for InetAddr

pub fn from(addr: Ipv6Addr) -> Self

Performs the conversion.

impl FromStr for InetAddr

type Err = AddrParseError

The associated error which can be returned from parsing.

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

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

impl Hash for InetAddr

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

Feeds this value into the given Hasher.

pub 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

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<InetAddr> for InetAddr

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

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

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

This method tests for !=.

impl PartialOrd<InetAddr> for InetAddr

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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 StructuralEq for InetAddr

impl StructuralPartialEq for InetAddr

impl TryFrom<&'_ str> for InetAddr

type Error = <InetAddr as FromStr>::Err

The type returned in the event of a conversion error.

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

Performs the conversion.