Enum smoltcp::wire::IpRepr

#[non_exhaustive]
pub enum IpRepr {
    Unspecified {
        src_addr: Address,
        dst_addr: Address,
        protocol: Protocol,
        payload_len: usize,
        hop_limit: u8,
    },
    Ipv4(Ipv4Repr),
    Ipv6(Ipv6Repr),
}

An IP packet representation.

This enum abstracts the various versions of IP packets. It either contains a concrete high-level representation for some IP protocol version, or an unspecified representation, which permits the IpAddress::Unspecified addresses.

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.

Unspecified

Fields

src_addr: Address

dst_addr: Address

protocol: Protocol

payload_len: usize

hop_limit: u8

Ipv4(Ipv4Repr)

Ipv6(Ipv6Repr)

Implementations

impl Repr

pub fn version(&self) -> Version

Return the protocol version.

pub fn src_addr(&self) -> Address

Return the source address.

pub fn dst_addr(&self) -> Address

Return the destination address.

pub fn protocol(&self) -> Protocol

Return the protocol.

pub fn payload_len(&self) -> usize

Return the payload length.

pub fn set_payload_len(&mut self, length: usize)

Set the payload length.

pub fn hop_limit(&self) -> u8

Return the TTL value.

pub fn lower(&self, fallback_src_addrs: &[Cidr]) -> Result<Repr>

Convert an unspecified representation into a concrete one, or return Err(Error::Unaddressable) if not possible.

Panics

This function panics if source and destination addresses belong to different families, or the destination address is unspecified, since this indicates a logic error.

pub fn buffer_len(&self) -> usize

Return the length of a header that will be emitted from this high-level representation.

Panics

This function panics if invoked on an unspecified representation.

pub fn emit<T: AsRef<[u8]> + AsMut<[u8]>>(
    &self,
    buffer: T,
    _checksum_caps: &ChecksumCapabilities
)

Emit this high-level representation into a buffer.

Panics

This function panics if invoked on an unspecified representation.

pub fn total_len(&self) -> usize

Return the total length of a packet that will be emitted from this high-level representation.

This is the same as repr.buffer_len() + repr.payload_len().

Panics

This function panics if invoked on an unspecified representation.

Trait Implementations

impl Clone for Repr

fn clone(&self) -> Repr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Repr

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

Formats the value using the given formatter.

impl From<Repr> for Repr

fn from(repr: Ipv4Repr) -> Repr

Converts to this type from the input type.

impl From<Repr> for Repr

fn from(repr: Ipv6Repr) -> Repr

Converts to this type from the input type.

impl PartialEq<Repr> for Repr

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

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

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

This method tests for !=.

impl Eq for Repr

impl StructuralEq for Repr

impl StructuralPartialEq for Repr