Struct domain::rdata::svcb::value::Mandatory

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

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§

source§

impl<Octs> Mandatory<Octs>

source

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.

source§

impl Mandatory<[u8]>

source

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.

source§

impl<Octs: ?Sized> Mandatory<Octs>

source

pub fn as_octets(&self) -> &Octs

Returns a reference to the underlying octets sequence.

source

pub fn as_slice(&self) -> &[u8]
where Octs: AsRef<[u8]>,

Returns a slice of the underlying octets sequence.

source§

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

source

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

Returns an iterator over the elements of the value.

source§

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

source

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.

source§

impl Mandatory<[u8]>

source

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.

source§

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

source

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.

source§

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

source

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§

source§

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

source§

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

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

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

source§

fn as_ref(&self) -> &Octs

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

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

source§

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

Returns a copy 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<Octs: AsRef<[u8]> + ?Sized> ComposeSvcParamValue for Mandatory<Octs>

source§

fn compose_len(&self) -> u16

Returns the length of the composed value.
source§

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.
source§

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

source§

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

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

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

source§

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

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

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

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

§

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

source§

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

Performs the conversion.
source§

impl<'a, Octs> ParseSvcParamValue<'a, Octs> for Mandatory<Octs::Range<'a>>
where Octs: Octets + ?Sized,

source§

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

Parse a parameter value from wire format. Read more
source§

impl<Octs, OtherOcts> PartialEq<Mandatory<OtherOcts>> for Mandatory<Octs>
where Octs: AsRef<[u8]>, OtherOcts: AsRef<[u8]>,

source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

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

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

source§

fn key(&self) -> SvcParamKey

Returns the parameter key of the value.
source§

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

Auto Trait Implementations§

§

impl<Octs> Freeze for Mandatory<Octs>
where Octs: Freeze + ?Sized,

§

impl<Octs> RefUnwindSafe for Mandatory<Octs>
where Octs: RefUnwindSafe + ?Sized,

§

impl<Octs> Send for Mandatory<Octs>
where Octs: Send + ?Sized,

§

impl<Octs> Sync for Mandatory<Octs>
where Octs: Sync + ?Sized,

§

impl<Octs> Unpin for Mandatory<Octs>
where Octs: Unpin + ?Sized,

§

impl<Octs> UnwindSafe for Mandatory<Octs>
where Octs: UnwindSafe + ?Sized,

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§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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<Source, Target> OctetsInto<Target> for Source
where Target: OctetsFrom<Source>,

§

type Error = <Target as OctetsFrom<Source>>::Error

source§

fn try_octets_into( self, ) -> Result<Target, <Source as OctetsInto<Target>>::Error>

Performs the conversion.
source§

fn octets_into(self) -> Target
where Self::Error: Into<Infallible>,

Performs an infallible conversion.
source§

impl<T> ToOwned for T
where T: Clone,

§

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> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

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>,

§

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<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

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