Struct netstack3_ip::socket::SocketHopLimits

pub struct SocketHopLimits<I: Ip> {
    pub unicast: Option<NonZeroU8>,
    pub multicast: Option<NonZeroU8>,
    pub version: IpVersionMarker<I>,
}

The configurable hop limits for a socket.

Fields

unicast: Option<NonZeroU8>

Unicast hop limit.

multicast: Option<NonZeroU8>

Multicast hop limit.

version: IpVersionMarker<I>

An unused marker type signifying the IP version for which these hop limits are valid. Including this helps prevent using the wrong hop limits when operating on dualstack sockets.

Implementations

impl<I: Ip> SocketHopLimits<I>

pub fn set_unicast(value: Option<NonZeroU8>) -> impl FnOnce(&mut Self)

Returns a function that updates the unicast hop limit.

pub fn set_multicast(value: Option<NonZeroU8>) -> impl FnOnce(&mut Self)

Returns a function that updates the multicast hop limit.

pub fn get_limits_with_defaults(&self, defaults: &HopLimits) -> HopLimits

Returns the hop limits, or the provided defaults if unset.

pub fn hop_limit_for_dst( &self, destination: &SpecifiedAddr<I::Addr>, ) -> Option<NonZeroU8>

Returns the appropriate hop limit to use for the given destination addr.

Trait Implementations

impl<I: Clone + Ip> Clone for SocketHopLimits<I>

fn clone(&self) -> SocketHopLimits<I>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I: Debug + Ip> Debug for SocketHopLimits<I>

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

Formats the value using the given formatter.

impl<I: Default + Ip> Default for SocketHopLimits<I>

fn default() -> SocketHopLimits<I>

Returns the “default value” for a type.

impl<I: PartialEq + Ip> PartialEq for SocketHopLimits<I>

fn eq(&self, other: &SocketHopLimits<I>) -> 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<I: Copy + Ip> Copy for SocketHopLimits<I>

impl<I: Eq + Ip> Eq for SocketHopLimits<I>

impl<I: Ip> StructuralPartialEq for SocketHopLimits<I>