Struct domain::base::opt::keytag::KeyTag

pub struct KeyTag<Octs: ?Sized> { /* private fields */ }

Option data for the edns-key-tag option.

This option allows a client to indicate the key tags of the trust anchor keys they are using to validate responses. The option contains a sequence of key tags.

Implementations

impl<Octs> KeyTag<Octs>

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

where Octs: AsRef<[u8]>,

Creates a new value from its content in wire format.

The function returns an error if the octets do not encode a valid edns-key-tag option: the length needs to be an even number of octets and no longer than 65,536 octets.

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

Creates a new value from its wire-format content without checking.

Safety

The caller needs to ensure that octets is a valid key tag. The length needs to be an even number of octets and no longer than 65,536 octets.

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

impl KeyTag<[u8]>

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

Creates a key tag value from a slice.

Returns an error if slice does not contain a valid key tag.

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

Creates a key tag value from a slice without checking.

Safety

The caller needs to ensure that slice contains a valid key tag. The length needs to be an even number of octets and no longer than 65,536 octets.

impl<Octs: ?Sized> KeyTag<Octs>

pub fn as_octets(&self) -> &Octs

Returns a reference to the underlying octets.

The octets contain the key tag value in its wire format: a sequence of u16 in network byte order.

pub fn into_octets(self) -> Octs

where Octs: Sized,

Converts the value to the underlying octets.

The octets contain the key tag value in its wire format: a sequence of u16 in network byte order.

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

where Octs: AsRef<[u8]>,

Returns a slice of the underlying octets.

The slice will contain the key tag value in its wire format: a sequence of u16 in network byte order.

pub fn as_slice_mut(&mut self) -> &mut [u8]

where Octs: AsMut<[u8]>,

Returns a mutable slice of the underlying octets.

The slice will contain the key tag value in its wire format: a sequence of u16 in network byte order.

pub fn iter(&self) -> KeyTagIter<'_>

where Octs: AsRef<[u8]>,

Returns an iterator over the individual key tags.

Trait Implementations

impl<Octs: AsMut<[u8]> + ?Sized> AsMut<[u8]> for KeyTag<Octs>

fn as_mut(&mut self) -> &mut [u8]

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

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

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

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

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

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

Immutably borrows from an owned value.

impl<Octs> BorrowMut<[u8]> for KeyTag<Octs>

where Octs: AsMut<[u8]> + AsRef<[u8]> + ?Sized,

fn borrow_mut(&mut self) -> &mut [u8]

Mutably borrows from an owned value.

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

fn compose_len(&self) -> u16

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

impl<Octets: AsRef<[u8]> + ?Sized> Debug for KeyTag<Octets>

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

Formats the value using the given formatter.

impl<Octets: AsRef<[u8]> + ?Sized> Display for KeyTag<Octets>

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

Formats the value using the given formatter.

impl<Octs, Name> From<KeyTag<Octs>> for AllOptData<Octs, Name>

fn from(value: KeyTag<Octs>) -> Self

Converts to this type from the input type.

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

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

Feeds this value into the given Hasher.

impl<'a, Octs: AsRef<[u8]> + ?Sized> IntoIterator for &'a KeyTag<Octs>

type Item = u16

The type of the elements being iterated over.

type IntoIter = KeyTagIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<Octs: ?Sized> OptData for KeyTag<Octs>

fn code(&self) -> OptionCode

Returns the option code associated with this option.

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

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

impl<'a, Octs: Octets> ParseOptData<'a, Octs> for KeyTag<Octs::Range<'a>>

fn parse_option( code: OptionCode, parser: &mut Parser<'a, Octs>, ) -> Result<Option<Self>, ParseError>

Parses the option code data.

impl<Octs, Other> PartialEq<Other> for KeyTag<Octs>

where Octs: AsRef<[u8]> + ?Sized, Other: AsRef<[u8]> + ?Sized,

fn eq(&self, other: &Other) -> 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, Other> PartialOrd<Other> for KeyTag<Octs>

where Octs: AsRef<[u8]> + ?Sized, Other: AsRef<[u8]> + ?Sized,

fn partial_cmp(&self, other: &Other) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

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