Struct ppp::v2::Header

pub struct Header<'a> {
    pub header: Cow<'a, [u8]>,
    pub version: Version,
    pub command: Command,
    pub protocol: Protocol,
    pub addresses: Addresses,
}

A proxy protocol version 2 header.

Examples

use ppp::v2::{Addresses, AddressFamily, Command, Header, IPv4, ParseError, Protocol, PROTOCOL_PREFIX, Type, TypeLengthValue, Version};
let mut header = Vec::from(PROTOCOL_PREFIX);
header.extend([
   0x21, 0x12, 0, 16, 127, 0, 0, 1, 192, 168, 1, 1, 0, 80, 1, 187, 4, 0, 1, 42
]);

let addresses: Addresses = IPv4::new([127, 0, 0, 1], [192, 168, 1, 1], 80, 443).into();
let expected = Header {
   header: header.as_slice().into(),
   version: Version::Two,
   command: Command::Proxy,
   protocol: Protocol::Datagram,
   addresses
};
let actual = Header::try_from(header.as_slice()).unwrap();

assert_eq!(actual, expected);
assert_eq!(actual.tlvs().collect::<Vec<Result<TypeLengthValue<'_>, ParseError>>>(), vec![Ok(TypeLengthValue::new(Type::NoOp, &[42]))]);

Fields

header: Cow<'a, [u8]>

version: Version

command: Command

protocol: Protocol

addresses: Addresses

Implementations

impl<'a> Header<'a>

pub fn to_owned(&self) -> Header<'static>

Creates an owned clone of this Header.

pub fn length(&self) -> usize

The length of this Header’s payload in bytes.

pub fn len(&self) -> usize

The total length of this Header in bytes.

pub fn is_empty(&self) -> bool

Tests whether this Header’s underlying byte slice is empty.

pub fn address_family(&self) -> AddressFamily

The AddressFamily of this Header.

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

The bytes of the address portion of the payload.

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

The bytes of the TypeLengthValue portion of the payload.

pub fn tlvs(&self) -> TypeLengthValues<'_>

An Iterator of TypeLengthValues.

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

The underlying byte slice this Header is built on.

Trait Implementations

impl<'a> Clone for Header<'a>

fn clone(&self) -> Header<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Header<'a>

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

Formats the value using the given formatter.

impl<'a> Display for Header<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq<Header<'a>> for Header<'a>

fn eq(&self, other: &Header<'a>) -> bool

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

fn ne(&self, other: &Header<'a>) -> bool

This method tests for !=.

impl<'a> TryFrom<&'a [u8]> for Header<'a>

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(input: &'a [u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> StructuralPartialEq for Header<'a>