Skip to main content

RawIpSocketConfig

Struct RawIpSocketConfig 

Source
pub struct RawIpSocketConfig {
    pub family: Option<PublicationAddressFamily>,
    pub bind_addr: Option<IpAddr>,
    pub interface_addr: Option<IpAddr>,
    pub interface_index: Option<u32>,
}
Expand description

Configuration for one generic raw-IP transmit socket.

An egress selector is mandatory. Supplying a local bind address or an interface address resolves a concrete interface index; supplying only an interface index requires an explicit address family.

Fields§

§family: Option<PublicationAddressFamily>

Expected IP family. It is inferred from an IP-address selector when omitted, but is required for an index-only configuration.

§bind_addr: Option<IpAddr>

Optional exact local address used to bind the raw socket.

§interface_addr: Option<IpAddr>

Optional local address identifying the required egress interface.

§interface_index: Option<u32>

Optional required egress interface index.

Implementations§

Source§

impl RawIpSocketConfig

Source

pub fn new() -> Self

Creates a generic raw-IP socket configuration with inferred family.

Source

pub fn ipv4() -> Self

Creates an IPv4 raw-IP socket configuration.

Source

pub fn ipv6() -> Self

Creates an IPv6 raw-IP socket configuration.

Source

pub fn with_family(self, family: PublicationAddressFamily) -> Self

Pins the expected family for supplied datagrams.

Source

pub fn with_bind_addr(self, bind_addr: impl Into<IpAddr>) -> Self

Binds the raw socket to this exact local IP address when the platform supports it.

Source

pub fn with_interface_addr(self, interface_addr: impl Into<IpAddr>) -> Self

Selects the required egress interface by one of its local addresses.

Source

pub fn with_interface_index(self, interface_index: u32) -> Self

Selects the required egress interface by its operating-system index.

Source

pub fn validate(&self) -> Result<(), MctxError>

Validates the structural configuration before privileged socket setup.

Trait Implementations§

Source§

impl Clone for RawIpSocketConfig

Source§

fn clone(&self) -> RawIpSocketConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RawIpSocketConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for RawIpSocketConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for RawIpSocketConfig

Source§

impl Hash for RawIpSocketConfig

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for RawIpSocketConfig

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for RawIpSocketConfig

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.