Struct domain::base::opt::exterr::ExtendedError

pub struct ExtendedError<Octs> { /* private fields */ }

Option data for an extended DNS error.

The Extended DNS Error option allows a server to include more detailed information in a response to a failed query why it did. It contains a standardized ExtendedErrorCode for machines and an optional UTF-8 error text for humans.

Implementations

impl<Octs> ExtendedError<Octs>

pub fn new( code: ExtendedErrorCode, text: Option<Str<Octs>>, ) -> Result<Self, LongOptData>

where Octs: AsRef<[u8]>,

Creates a new value from a code and optional text.

Returns an error if text is present but is too long to fit into an option.

pub unsafe fn new_unchecked( code: ExtendedErrorCode, text: Option<Result<Str<Octs>, Octs>>, ) -> Self

Creates a new value without checking for the option length.

Safety

The caller must ensure that the length of the wire format of the value does not exceed 65,535 octets.

pub fn code(&self) -> ExtendedErrorCode

Returns the error code.

pub fn text(&self) -> Option<Result<&Str<Octs>, &Octs>>

Returns the text.

If there is no text, returns None. If there is text and it is correctly encoded UTF-8, returns Some(Ok(_)). If there is text but it is not UTF-8, returns Some(Err(_)).

pub fn text_slice(&self) -> Option<&[u8]>

where Octs: AsRef<[u8]>,

Returns the text as an octets slice.

pub fn set_text(&mut self, text: Str<Octs>)

Sets the text field.

pub fn is_private(&self) -> bool

Returns true if the code is in the private range.

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

where Octs: AsRef<[u8]>,

Trait Implementations

impl<Octs: Clone> Clone for ExtendedError<Octs>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Octs: AsRef<[u8]>> ComposeOptData for ExtendedError<Octs>

fn compose_len(&self) -> u16

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

impl<Octs: AsRef<[u8]>> Debug for ExtendedError<Octs>

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

Formats the value using the given formatter.

impl<Octs: AsRef<[u8]>> Display for ExtendedError<Octs>

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.

impl<Octs> From<ExtendedErrorCode> for ExtendedError<Octs>

fn from(code: ExtendedErrorCode) -> Self

Converts to this type from the input type.

impl<Octs> From<u16> for ExtendedError<Octs>

fn from(code: u16) -> Self

Converts to this type from the input type.

impl<Octs: AsRef<[u8]>> Hash for ExtendedError<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<Octs> OptData for ExtendedError<Octs>

fn code(&self) -> OptionCode

Returns the option code associated with this option.

impl<'a, Octs> ParseOptData<'a, Octs> for ExtendedError<Octs::Range<'a>>

where Octs: Octets + ?Sized,

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

Parses the option code data.

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

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

fn eq(&self, other: &ExtendedError<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> TryFrom<(ExtendedErrorCode, Str<Octs>)> for ExtendedError<Octs>

where Octs: AsRef<[u8]>,

type Error = LongOptData

The type returned in the event of a conversion error.

fn try_from( (code, text): (ExtendedErrorCode, Str<Octs>), ) -> Result<Self, Self::Error>

Performs the conversion.

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