Struct netstack3_base::socket::SocketIpAddr

pub struct SocketIpAddr<A: IpAddress>(/* private fields */);

An IP address that witnesses all required properties of a socket address.

Requires SpecifiedAddr because most contexts do not permit unspecified addresses; those that do can hold a Option<SocketIpAddr>.

Requires NonMappedAddr because mapped addresses (i.e. ipv4-mapped-ipv6 addresses) are converted from their original IP version to their target IP version when entering the stack.

Implementations

impl<A: IpAddress> SocketIpAddr<A>

pub fn new(addr: A) -> Option<SocketIpAddr<A>>

Constructs a SocketIpAddr if the address is compliant, else None.

pub fn new_from_witness(addr: NonMappedAddr<SpecifiedAddr<A>>) -> Self

Constructs a SocketIpAddr from the inner witness.

pub const unsafe fn new_unchecked(addr: A) -> SocketIpAddr<A>

Constructs a SocketIpAddr without verify the address’s properties.

Safety

Callers must ensure that the addr is both a SpecifiedAddr and a NonMappedAddr.

pub const unsafe fn new_from_specified_unchecked( addr: SpecifiedAddr<A>, ) -> SocketIpAddr<A>

Like SocketIpAddr::new_unchecked, but the address is specified.

Safety

Callers must ensure that the addr is a NonMappedAddr.

pub fn addr(self) -> A

Returns the inner address, dropping all witnesses.

pub fn into_inner(self) -> NonMappedAddr<SpecifiedAddr<A>>

Returns the inner address, including all witness types.

pub fn new_from_multicast(addr: MulticastAddr<A>) -> SocketIpAddr<A>

Constructs a SocketIpAddr from the given multicast address.

impl SocketIpAddr<Ipv4Addr>

pub fn new_ipv4_specified(addr: SpecifiedAddr<Ipv4Addr>) -> Self

Constructs a SocketIpAddr from a given specified IPv4 address.

impl SocketIpAddr<Ipv6Addr>

pub fn new_from_ipv6_non_mapped_unicast( addr: NonMappedAddr<UnicastAddr<Ipv6Addr>>, ) -> Self

Constructs a SocketIpAddr from the given [Ipv6DeviceAddr].

pub fn new_from_ipv6_source(addr: Ipv6SourceAddr) -> Option<Self>

Optionally constructs a SocketIpAddr from the given Ipv6SourceAddr, returning None if the given addr is Unspecified.

Trait Implementations

impl<A: IpAddress> AsRef<SpecifiedAddr<A>> for SocketIpAddr<A>

fn as_ref(&self) -> &SpecifiedAddr<A>

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

impl<A: Clone + IpAddress> Clone for SocketIpAddr<A>

fn clone(&self) -> SocketIpAddr<A>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A: IpAddress> Debug for SocketIpAddr<A>

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

Formats the value using the given formatter.

impl<A: IpAddress> Display for SocketIpAddr<A>

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

Formats the value using the given formatter.

impl<A: IpAddress> From<IpDeviceAddr<A>> for SocketIpAddr<A>

fn from(addr: IpDeviceAddr<A>) -> Self

Converts to this type from the input type.

impl<A: IpAddress> From<SocketIpAddr<A>> for SpecifiedAddr<A>

fn from(addr: SocketIpAddr<A>) -> Self

Converts to this type from the input type.

impl<A: IpAddress, IpType: Ip> GenericOverIp<IpType> for SocketIpAddr<A>

where IpType::Addr: IpAddress,

type Type = SocketIpAddr<<IpType as Ip>::Addr>

The type of Self when its IP-generic parameter is replaced with the type NewIp.

impl<A: Hash + IpAddress> Hash for SocketIpAddr<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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<A: PartialEq + IpAddress> PartialEq for SocketIpAddr<A>

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<A: IpAddress> ScopeableAddress for SocketIpAddr<A>

Allows SocketIpAddr to be used inside of a ZonedAddr.

type Scope = <A as ScopeableAddress>::Scope

The type of all non-global scopes.

fn scope(&self) -> Self::Scope

The scope of this address.

impl<A: IpAddress> TryFrom<SpecifiedAddr<A>> for SocketIpAddr<A>

type Error = AddrIsMappedError

The type returned in the event of a conversion error.

fn try_from(addr: SpecifiedAddr<A>) -> Result<Self, Self::Error>

Performs the conversion.

impl<A: Copy + IpAddress> Copy for SocketIpAddr<A>

impl<A: Eq + IpAddress> Eq for SocketIpAddr<A>

impl<A: IpAddress> StructuralPartialEq for SocketIpAddr<A>