Enum specifications::address::AddressOpt

pub enum AddressOpt {
    Ipv4(Ipv4Addr, Option<u16>),
    Ipv6(Ipv6Addr, Option<u16>),
    Hostname(String, Option<u16>),
}

Alternative to an Address that has an optional port part.

Variants

Ipv4(Ipv4Addr, Option<u16>)

It’s an Ipv4 address.

Ipv6(Ipv6Addr, Option<u16>)

It’s an Ipv6 address.

Hostname(String, Option<u16>)

It’s a hostname.

Implementations

impl AddressOpt

pub fn ipv4(b1: u8, b2: u8, b3: u8, b4: u8, port: Option<u16>) -> Self

Constructor for the AddressOpt that initializes it for the given IPv4 address.

Arguments

• b1: The first byte of the IPv4 address.
• b2: The second byte of the IPv4 address.
• b3: The third byte of the IPv4 address.
• b4: The fourth byte of the IPv4 address.
• port: The port for this address, if any.

Returns

A new AddressOpt instance.

pub fn from_ipv4(ipv4: impl Into<Ipv4Addr>, port: Option<u16>) -> Self

Constructor for the AddressOpt that initializes it for the given IPv4 address.

Arguments

• ipv4: The already constructed IPv4 address to use.
• port: The port for this address, if any.

Returns

A new AddressOpt instance.

pub fn ipv6( b1: u16, b2: u16, b3: u16, b4: u16, b5: u16, b6: u16, b7: u16, b8: u16, port: Option<u16>, ) -> Self

Constructor for the AddressOpt that initializes it for the given IPv6 address.

Arguments

• b1: The first pair of bytes of the IPv6 address.
• b2: The second pair of bytes of the IPv6 address.
• b3: The third pair of bytes of the IPv6 address.
• b4: The fourth pair of bytes of the IPv6 address.
• b5: The fifth pair of bytes of the IPv6 address.
• b6: The sixth pair of bytes of the IPv6 address.
• b7: The seventh pair of bytes of the IPv6 address.
• b8: The eight pair of bytes of the IPv6 address.
• port: The port for this address, if any.

Returns

A new AddressOpt instance.

pub fn from_ipv6(ipv6: impl Into<Ipv6Addr>, port: Option<u16>) -> Self

Constructor for the AddressOpt that initializes it for the given IPv6 address.

Arguments

• ipv6: The already constructed IPv6 address to use.
• port: The port for this address, if any.

Returns

A new AddressOpt instance.

pub fn hostname(hostname: impl Into<String>, port: Option<u16>) -> Self

Constructor for the AddressOpt that initializes it for the given hostname.

Arguments

• hostname: The hostname for this AddressOpt.
• port: The port for this address, if any.

Returns

A new AddressOpt instance.

pub fn domain(&self) -> Cow<'_, str>

Returns the domain-part, as a (serialized) string version.

Returns

A Cow<str> that either contains a reference to the already String hostname, or else a newly created string that is the serialized version of an IP.

pub fn port(&self) -> Option<u16>

Returns the port-part, as a number.

Returns

A u16 that is the port.

pub fn port_mut(&mut self) -> &mut Option<u16>

Returns the port-part as a mutable number.

Returns

A mutable reference to the u16 that is the port.

pub fn is_hostname(&self) -> bool

Returns if this AddressOpt is an AddressOpt::Hostname.

Returns

True if it is, false if it isn’t.

pub fn is_ip(&self) -> bool

Returns if this AddressOpt is an AddressOpt::Ipv4 or AddressOpt::Ipv6.

Returns

True if it is, false if it isn’t.

pub fn is_ipv4(&self) -> bool

Returns if this AddressOpt is an AddressOpt::Ipv4.

Returns

True if it is, false if it isn’t.

pub fn is_ipv6(&self) -> bool

Returns if this AddressOpt is an AddressOpt::Ipv6.

Returns

True if it is, false if it isn’t.

pub fn serialize(&self) -> impl '_ + Display

Returns a formatter that deterministically and parseably serializes the AddressOpt.

Trait Implementations

impl AsRef<AddressOpt> for AddressOpt

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for AddressOpt

fn clone(&self) -> AddressOpt

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AddressOpt

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AddressOpt

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for AddressOpt

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

Formats the value using the given formatter.

impl EnumDebug for AddressOpt

fn type_name() -> &'static str

Returns the static name of the type used for EnumDebug-printing.

fn variant_names() -> &'static [&'static str]

Returns all variants in the trait as a list of names.

fn variant_name(&self) -> &'static str

Returns the static name of the variant.

fn variant(&self) -> EnumDebugFormatter<'_, Self>

Returns a formatter for this enum that writes its variant name.

fn variants() -> Copied<Iter<'static, &'static str>>

Returns an iterator over all variants in this enum.

impl From<&AddressOpt> for AddressOpt

fn from(value: &AddressOpt) -> Self

Converts to this type from the input type.

impl From<&mut AddressOpt> for AddressOpt

fn from(value: &mut AddressOpt) -> Self

Converts to this type from the input type.

impl From<Address> for AddressOpt

fn from(value: Address) -> Self

Converts to this type from the input type.

impl FromStr for AddressOpt

type Err = AddressError

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 Serialize for AddressOpt

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<AddressOpt> for Address

type Error = AddressError

The type returned in the event of a conversion error.

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

Performs the conversion.