Enum rustls::pki_types::ServerName

#[non_exhaustive]
pub enum ServerName<'a> {
    DnsName(DnsName<'a>),
    IpAddress(IpAddr),
}

Encodes ways a client can know the expected name of the server.

This currently covers knowing the DNS name of the server, but will be extended in the future to supporting privacy-preserving names for the server (“ECH”). For this reason this enum is non_exhaustive.

Making one

If you have a DNS name as a &str, this type implements TryFrom<&str>, so you can do:

ServerName::try_from("example.com").expect("invalid DNS name");

If you have an owned String, you can use TryFrom directly:

let name = "example.com".to_string();
#[cfg(feature = "alloc")]
ServerName::try_from(name).expect("invalid DNS name");

which will yield a ServerName<'static> if successful.

or, alternatively…

let x: ServerName = "example.com".try_into().expect("invalid DNS name");

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

DnsName(DnsName<'a>)

The server is identified by a DNS name. The name is sent in the TLS Server Name Indication (SNI) extension.

IpAddress(IpAddr)

The server is identified by an IP address. SNI is not done.

Implementations

impl<'a> ServerName<'a>

pub fn to_owned(&self) -> ServerName<'static>

Produce an owned ServerName from this (potentially borrowed) ServerName.

pub fn to_str(&self) -> Cow<'_, str>

Return the string representation of this ServerName.

In the case of a ServerName::DnsName instance, this function returns a borrowed str. For a ServerName::IpAddress instance it returns an allocated String.

Trait Implementations

impl<'a> Clone for ServerName<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ServerName<'a>

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

Formats the value using the given formatter.

impl From<IpAddr> for ServerName<'_>

fn from(addr: IpAddr) -> ServerName<'_>

Converts to this type from the input type.

impl From<IpAddr> for ServerName<'_>

fn from(addr: IpAddr) -> ServerName<'_>

Converts to this type from the input type.

impl From<Ipv4Addr> for ServerName<'_>

fn from(v4: Ipv4Addr) -> ServerName<'_>

Converts to this type from the input type.

impl From<Ipv4Addr> for ServerName<'_>

fn from(v4: Ipv4Addr) -> ServerName<'_>

Converts to this type from the input type.

impl From<Ipv6Addr> for ServerName<'_>

fn from(v6: Ipv6Addr) -> ServerName<'_>

Converts to this type from the input type.

impl From<Ipv6Addr> for ServerName<'_>

fn from(v6: Ipv6Addr) -> ServerName<'_>

Converts to this type from the input type.

impl<'a> Hash for ServerName<'a>

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

where __H: Hasher,

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> PartialEq for ServerName<'a>

fn eq(&self, other: &ServerName<'a>) -> 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<'a> TryFrom<&'a [u8]> for ServerName<'a>

type Error = InvalidDnsNameError

The type returned in the event of a conversion error.

fn try_from( value: &'a [u8], ) -> Result<ServerName<'a>, <ServerName<'a> as TryFrom<&'a [u8]>>::Error>

Performs the conversion.

impl<'a> TryFrom<&'a str> for ServerName<'a>

Attempt to make a ServerName from a string by parsing as a DNS name or IP address.

type Error = InvalidDnsNameError

The type returned in the event of a conversion error.

fn try_from( s: &'a str, ) -> Result<ServerName<'a>, <ServerName<'a> as TryFrom<&'a str>>::Error>

Performs the conversion.

impl TryFrom<String> for ServerName<'static>

type Error = InvalidDnsNameError

The type returned in the event of a conversion error.

fn try_from( value: String, ) -> Result<ServerName<'static>, <ServerName<'static> as TryFrom<String>>::Error>

Performs the conversion.

impl<'a> Eq for ServerName<'a>

impl<'a> StructuralPartialEq for ServerName<'a>