Struct domain::rdata::rfc1035::Txt

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

Txt record data.

Txt records hold descriptive text.

The Txt record type is defined in RFC 1035, section 3.3.14.

Implementations

impl<Octs: FromBuilder> Txt<Octs>

pub fn build_from_slice(text: &[u8]) -> Result<Self, ShortBuf>

where <Octs as FromBuilder>::Builder: EmptyBuilder + AsRef<[u8]> + AsMut<[u8]>,

Creates a new Txt record from a single character string.

impl<Octs> Txt<Octs>

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

where Octs: AsRef<[u8]>,

Creates new TXT record data from its encoded content.

impl Txt<[u8]>

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

Creates new TXT record data on an octets slice.

impl<Octs> Txt<Octs>

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

where Octs: AsRef<[u8]>,

pub fn scan<S: Scanner<Octets = Octs>>( scanner: &mut S, ) -> Result<Self, S::Error>

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

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

Returns an iterator over the text items.

The Txt format contains one or more length-delimited byte strings. This method returns an iterator over each of them.

pub fn iter_char_strs(&self) -> TxtCharStrIter<'_>

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

Returns the content if it consists of a single character string.

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn try_text<T: FromBuilder>( &self, ) -> Result<T, <<T as FromBuilder>::Builder as OctetsBuilder>::AppendError>

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

Returns the text content.

If the data is only one single character string, returns a simple clone of the slice with the data. If there are several character strings, their content will be copied together into one single, newly allocated bytes value.

Access to the individual character strings is possible via iteration.

pub fn text<T: FromBuilder>(&self) -> T

where <T as FromBuilder>::Builder: EmptyBuilder, <<T as FromBuilder>::Builder as OctetsBuilder>::AppendError: Into<Infallible>,

Trait Implementations

impl<Octs, Other> CanonicalOrd<Txt<Other>> for Txt<Octs>

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

fn canonical_cmp(&self, other: &Txt<Other>) -> Ordering

Returns the canonical ordering between self and other.

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

Returns whether self is canonically less than other.

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

Returns whether self is canonically less than or equal to other.

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

Returns whether self is canonically greater than other.

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

Returns whether self is canonically greater than or equal to other.

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Octs: AsRef<[u8]>> ComposeRecordData for Txt<Octs>

fn rdlen(&self, _compress: bool) -> Option<u16>

Returns the length of the record data if available.

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

Appends the wire format of the record data into target.

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

Appends the canonical wire format of the record data into target.

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

Appends the record data prefixed with its length.

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

Appends the record data prefixed with its length.

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

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

impl<O, N> From<Txt<O>> for AllRecordData<O, N>

fn from(value: Txt<O>) -> Self

Converts to this type from the input type.

impl<O, N> From<Txt<O>> for ZoneRecordData<O, N>

fn from(value: Txt<O>) -> Self

Converts to this type from the input type.

impl<Octs: AsRef<[u8]>> Hash for Txt<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<'a, Octs: AsRef<[u8]>> IntoIterator for &'a Txt<Octs>

type Item = &'a [u8]

The type of the elements being iterated over.

type IntoIter = TxtIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<Octs, SrcOcts> OctetsFrom<Txt<SrcOcts>> for Txt<Octs>

where Octs: OctetsFrom<SrcOcts>,

type Error = <Octs as OctetsFrom<SrcOcts>>::Error

fn try_octets_from(source: Txt<SrcOcts>) -> Result<Self, Self::Error>

Performs the conversion.

impl<Octs: AsRef<[u8]>> Ord for Txt<Octs>

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<'a, Octs> ParseRecordData<'a, Octs> for Txt<Octs::Range<'a>>

where Octs: Octets + ?Sized,

fn parse_rdata( rtype: Rtype, parser: &mut Parser<'a, Octs>, ) -> Result<Option<Self>, ParseError>

Parses the record data.

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

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

fn eq(&self, other: &Txt<Other>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<Octs, Other> PartialOrd<Txt<Other>> for Txt<Octs>

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

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<Octs> RecordData for Txt<Octs>

fn rtype(&self) -> Rtype

Returns the record type associated with this record data instance.

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