Skip to main content

PayloadHeaderFields

Struct PayloadHeaderFields 

Source
pub struct PayloadHeaderFields { /* private fields */ }
Expand description

A shared generic-payload-header field set every concrete payload layer embeds (RFC 7296 §3.2).

It carries the three caller-overridable generic-header fields — Next Payload, the Critical flag, and Payload Length — as Fields so a builder setter can pin any of them while compile() auto-fills the rest. A concrete payload layer holds one of these alongside its body fields and forwards PayloadHeaderFields::next_payload_override, PayloadHeaderFields::payload_length_override, and PayloadHeaderFields::critical into its IkePayload impl.

Implementations§

Source§

impl PayloadHeaderFields

Source

pub fn new() -> Self

A generic-header field set with builder defaults: Next Payload and Payload Length unset (auto-filled), Critical defaulted to clear.

Source

pub fn set_next_payload(&mut self, next_payload: u8)

Pin the generic-header Next Payload explicitly (RFC 7296 §3.2).

Source

pub fn set_length(&mut self, length: u16)

Pin the generic-header Payload Length explicitly (RFC 7296 §3.2).

Source

pub fn set_critical(&mut self, critical: bool)

Set the Critical (C) flag explicitly (RFC 7296 §3.2).

Source

pub fn next_payload_override(&self) -> Option<u8>

Caller-set Next Payload override, if any.

Source

pub fn payload_length_override(&self) -> Option<u16>

Caller-set Payload Length override, if any.

Source

pub fn critical(&self) -> bool

The Critical (C) flag value (defaulted to clear).

Trait Implementations§

Source§

impl Clone for PayloadHeaderFields

Source§

fn clone(&self) -> PayloadHeaderFields

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 PayloadHeaderFields

Source§

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

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

impl Default for PayloadHeaderFields

Source§

fn default() -> Self

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

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> Same for T

Source§

type Output = T

Should always be Self
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.