Struct packet_formats::udp::UdpPacket

pub struct UdpPacket<B> { /* private fields */ }

A UDP packet.

A UdpPacket shares its underlying memory with the byte slice it was parsed from or serialized to, meaning that no copying or extra allocation is necessary.

A UdpPacket - whether parsed using parse or created using serialize - maintains the invariant that the checksum is always valid.

Implementations

impl<B: ByteSlice> UdpPacket<B>

pub fn body(&self) -> &[u8]

The packet body.

pub fn into_body(self) -> B

Consumes this packet and returns the body.

Note that the returned B has the same lifetime as the buffer from which this packet was parsed. By contrast, the body method returns a slice with the same lifetime as the receiver.

pub fn src_port(&self) -> Option<NonZeroU16>

The source UDP port, if any.

The source port is optional, and may have been omitted by the sender.

pub fn dst_port(&self) -> NonZeroU16

The destination UDP port.

pub fn checksummed(&self) -> bool

Did this packet have a checksum?

On IPv4, the sender may optionally omit the checksum. If this function returns false, the sender omitted the checksum, and parse will not have validated it.

On IPv6, it is guaranteed that checksummed will return true because IPv6 requires a checksum, and so any UDP packet missing one will fail validation in parse.

pub fn builder<A: IpAddress>(&self, src_ip: A, dst_ip: A) -> UdpPacketBuilder<A>

Constructs a builder with the same contents as this packet.

pub fn into_serializer<'a, A: IpAddress>( self, src_ip: A, dst_ip: A ) -> impl Serializer<Buffer = EmptyBuf> + Debug + 'a

where B: 'a,

Consumes this packet and constructs a [Serializer] with the same contents.

The returned Serializer has the Buffer type [EmptyBuf], which means it is not able to reuse the buffer backing this UdpPacket when serializing, and will always need to allocate a new buffer.

By consuming self instead of taking it by-reference, into_serializer is able to return a Serializer whose lifetime is restricted by the lifetime of the buffer from which this UdpPacket was parsed rather than by the lifetime on &self, which may be more restricted.

Trait Implementations

impl<B: ByteSlice, A: IpAddress> FromRaw<UdpPacketRaw<B>, UdpParseArgs<A>> for UdpPacket<B>

type Error = ParseError

The type of error that may happen during validation.

fn try_from_raw_with( raw: UdpPacketRaw<B>, args: UdpParseArgs<A> ) -> Result<Self, Self::Error>

Attempts to create Self from the raw form in raw with args.

impl<B: ByteSlice, A: IpAddress> ParsablePacket<B, UdpParseArgs<A>> for UdpPacket<B>

type Error = ParseError

The type of errors returned from parse and parse_mut.

fn parse_metadata(&self) -> ParseMetadata

Gets metadata about this packet required by [GrowBuffer::undo_parse].

fn parse<BV: BufferView<B>>( buffer: BV, args: UdpParseArgs<A> ) -> ParseResult<Self>

Parses a packet from a buffer.