Enum rustls::client::ServerName

#[non_exhaustive]
pub enum ServerName {
    DnsName(DnsName),
    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");

// or, alternatively...

let x = "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)

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 ServerName

pub(crate) fn for_sni(&self) -> Option<DnsNameRef<'_>>

Return the name that should go in the SNI extension. If None is returned, the SNI extension is not included in the handshake.

Trait Implementations

impl Clone for ServerName

fn clone(&self) -> ServerName

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ServerName

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

Formats the value using the given formatter.

impl Hash for ServerName

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

fn eq(&self, other: &ServerName) -> 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 TryFrom<&str> for ServerName

Attempt to make a ServerName from a string by parsing it as a DNS name.

type Error = InvalidDnsNameError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for ServerName

impl StructuralPartialEq for ServerName