Skip to main content

OptionView

Struct OptionView 

Source
pub struct OptionView<'a>(/* private fields */);
Expand description

Zero-copy view into a variable-length SD option in a buffer.

Wire layout:

  • [0..2]: length (u16 BE) = total_size - 3
  • [2]: option type (u8)
  • [3]: reserved/discard flag (u8)
  • [4..]: type-specific data

Implementations§

Source§

impl<'a> OptionView<'a>

Source

pub fn option_type(&self) -> Result<OptionType, Error>

Returns the option type.

§Errors

Returns Error::InvalidOptionType if the type byte is unrecognized.

Source

pub fn wire_size(&self) -> usize

Total wire size of this option (length field value + 3).

Source

pub fn as_ipv4(&self) -> Result<(Ipv4Addr, TransportProtocol, u16), Error>

Parse as IPv4 endpoint/multicast/SD option. Returns (ip, protocol, port).

§Errors

Returns Error::InvalidOptionTransportProtocol if the protocol byte is unrecognized.

Source

pub fn as_ipv6(&self) -> Result<(Ipv6Addr, TransportProtocol, u16), Error>

Parse as IPv6 endpoint/multicast/SD option. Returns (ip, protocol, port).

§Errors

Returns Error::InvalidOptionTransportProtocol if the protocol byte is unrecognized.

Source

pub fn configuration_bytes(&self) -> &'a [u8]

Raw configuration bytes (for Configuration options).

Source

pub fn as_load_balancing(&self) -> Result<(u16, u16), Error>

Parse as load-balancing option. Returns (priority, weight).

§Errors

Currently always succeeds; the Result return type is reserved for future validation.

Source

pub fn to_owned(&self) -> Result<Options, Error>

Converts this view into an owned Options.

§Errors

Returns an error if the option type is unrecognized, the transport protocol byte is invalid, or the configuration string exceeds MAX_CONFIGURATION_STRING_LENGTH.

§Panics

Panics if a configuration string passes the length check but fails to fit into the heapless buffer (unreachable in practice).

Trait Implementations§

Source§

impl<'a> Clone for OptionView<'a>

Source§

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

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for OptionView<'a>

Source§

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

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

impl<'a> Copy for OptionView<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for OptionView<'a>

§

impl<'a> RefUnwindSafe for OptionView<'a>

§

impl<'a> Send for OptionView<'a>

§

impl<'a> Sync for OptionView<'a>

§

impl<'a> Unpin for OptionView<'a>

§

impl<'a> UnsafeUnpin for OptionView<'a>

§

impl<'a> UnwindSafe for OptionView<'a>

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

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more