Struct webpki::DnsNameRef

pub struct DnsNameRef<'a>(_);

A reference to a DNS Name suitable for use in the TLS Server Name Indication (SNI) extension and/or for use as the reference hostname for which to verify a certificate.

A DnsNameRef is guaranteed to be syntactically valid. The validity rules are specified in RFC 5280 Section 7.2, except that underscores are also allowed.

Eq, PartialEq, etc. are not implemented because name comparison frequently should be done case-insensitively and/or with other caveats that depend on the specific circumstances in which the comparison is done.

Implementations

impl<'a> DnsNameRef<'a>

pub fn try_from_ascii(dns_name: &'a [u8]) -> Result<Self, InvalidDnsNameError>

Constructs a DnsNameRef from the given input if the input is a syntactically-valid DNS name.

pub fn try_from_ascii_str(
    dns_name: &'a str
) -> Result<Self, InvalidDnsNameError>

Constructs a DnsNameRef from the given input if the input is a syntactically-valid DNS name.

pub fn to_owned(&self) -> DnsName

Constructs a DnsName from this DnsNameRef

Requires the alloc feature.

Trait Implementations

impl AsRef<[u8]> for DnsNameRef<'_>

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

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

impl<'a> Clone for DnsNameRef<'a>

fn clone(&self) -> DnsNameRef<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DnsNameRef<'_>

Requires the alloc feature.

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

Formats the value using the given formatter.

impl From<DnsNameRef<'_>> for DnsName

Requires the alloc feature.

fn from(dns_name: DnsNameRef<'_>) -> Self

Converts to this type from the input type.

impl<'a> From<DnsNameRef<'a>> for &'a str

fn from(DnsNameRef: DnsNameRef<'a>) -> Self

Converts to this type from the input type.

impl<'a> Copy for DnsNameRef<'a>