Struct Mandatory

pub struct Mandatory<Octs: ?Sized>(/* private fields */);

The “mandatory” service parameter value.

This value type lists the keys of the values that are considered essential for interpretation of the service binding. A client must understand all these keys in order be able to use a service bindings record.

A value of this type wraps an octets sequence that contains the integer values of the keys in network byte order. You can create a value of this type by providing an iterator over the keys to be included to the from_keys function. You can get an iterator over the keys in an existing value through the iter method.

Implementations

impl<Octs> Mandatory<Octs>

pub unsafe fn from_octets_unchecked(octets: Octs) -> Self

Creates a new value from octets without checking.

Safety

The caller has to ensure that octets contains a properly formated value of at most 65,535 octets.

impl Mandatory<[u8]>

pub unsafe fn from_slice_unchecked(slice: &[u8]) -> &Self

Creates a new value for a slice without checking.

Safety

The caller has to ensure that slice contains a properly formated value of at most 65,535 octets.

impl<Octs: ?Sized> Mandatory<Octs>

pub fn as_octets(&self) -> &Octs

Returns a reference to the underlying octets sequence.

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

where Octs: AsRef<[u8]>,

Returns a slice of the underlying octets sequence.

impl<Octs: AsRef<[u8]> + ?Sized> Mandatory<Octs>

pub fn iter(&self) -> MandatoryIter<'_, Octs>

Returns an iterator over the elements of the value.

impl<Octs: AsRef<[u8]>> Mandatory<Octs>

pub fn from_octets(octets: Octs) -> Result<Self, ParseError>

Creates a new mandatory value from an octets sequence.

The function checks that the octets sequence contains a properly encoded value of at most 65,535 octets. It does not check whether there are any duplicates in the data.

impl Mandatory<[u8]>

pub fn from_slice(slice: &[u8]) -> Result<&Self, ParseError>

Creates a new mandatory value from an octets slice.

The function checks that the octets slice contains a properly encoded value of at most 65,535 octets. It does not check whether there are any duplicates in the data.

impl<Octs: AsRef<[u8]>> Mandatory<Octs>

pub fn from_keys( keys: impl Iterator<Item = SvcParamKey>, ) -> Result<Self, BuildValueError>

where Octs: FromBuilder, <Octs as FromBuilder>::Builder: EmptyBuilder,

Creates a new value from a list of keys.

The created value will contain all the keys returned by the iterator in the order provided. The function does not check for duplicates.

Returns an error if the octets builder runs out of space or the resulting value would be longer than 65,535 octets.

impl<Octs: AsRef<[u8]>> Mandatory<Octs>

pub fn parse<'a, Src: Octets<Range<'a> = Octs> + ?Sized>( parser: &mut Parser<'a, Src>, ) -> Result<Self, ParseError>

Parses a mandatory value from its wire format.

Trait Implementations

impl<Octs: AsRef<[u8]> + ?Sized> AsRef<[u8]> for Mandatory<Octs>

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl<Octs> AsRef<Octs> for Mandatory<Octs>

fn as_ref(&self) -> &Octs

Converts this type into a shared reference of the (usually inferred) input type.

impl<Octs: Clone + ?Sized> Clone for Mandatory<Octs>

fn clone(&self) -> Mandatory<Octs>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Octs: AsRef<[u8]> + ?Sized> ComposeSvcParamValue for Mandatory<Octs>

fn compose_len(&self) -> u16

Returns the length of the composed value.

fn compose_value<Target: OctetsBuilder + ?Sized>( &self, target: &mut Target, ) -> Result<(), Target::AppendError>

Appends the wire format of the value to the end of target.

impl<Octs: Debug + ?Sized> Debug for Mandatory<Octs>

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

Formats the value using the given formatter.

impl<Octs: Octets + ?Sized> Display for Mandatory<Octs>

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

Formats the value using the given formatter.

impl<Octs> From<Mandatory<Octs>> for AllValues<Octs>

fn from(p: Mandatory<Octs>) -> Self

Converts to this type from the input type.

impl<Octs: AsRef<[u8]>> Hash for Mandatory<Octs>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<O, OO> OctetsFrom<Mandatory<O>> for Mandatory<OO>

where OO: OctetsFrom<O>,

type Error = <OO as OctetsFrom<O>>::Error

fn try_octets_from(source: Mandatory<O>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, Octs> ParseSvcParamValue<'a, Octs> for Mandatory<Octs::Range<'a>>

where Octs: Octets + ?Sized,

fn parse_value( key: SvcParamKey, parser: &mut Parser<'a, Octs>, ) -> Result<Option<Self>, ParseError>

Parse a parameter value from wire format.

impl<Octs, OtherOcts> PartialEq<Mandatory<OtherOcts>> for Mandatory<Octs>

where Octs: AsRef<[u8]>, OtherOcts: AsRef<[u8]>,

fn eq(&self, other: &Mandatory<OtherOcts>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Octs: ?Sized> SvcParamValue for Mandatory<Octs>

fn key(&self) -> SvcParamKey

Returns the parameter key of the value.

impl<Octs: AsRef<[u8]>> Eq for Mandatory<Octs>