rustls_pki_types

Enum ServerName

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

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)§

This enum is marked as 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§

source§

impl<'a> ServerName<'a>

source

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

Available on crate feature alloc only.

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

source

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

Available on crate feature std only.

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§

source§

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

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

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

source§

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

Formats the value using the given formatter. Read more
source§

impl From<IpAddr> for ServerName<'_>

source§

fn from(addr: IpAddr) -> Self

Converts to this type from the input type.
source§

impl From<IpAddr> for ServerName<'_>

Available on crate feature std only.
source§

fn from(addr: IpAddr) -> Self

Converts to this type from the input type.
source§

impl From<Ipv4Addr> for ServerName<'_>

source§

fn from(v4: Ipv4Addr) -> Self

Converts to this type from the input type.
source§

impl From<Ipv4Addr> for ServerName<'_>

Available on crate feature std only.
source§

fn from(v4: Ipv4Addr) -> Self

Converts to this type from the input type.
source§

impl From<Ipv6Addr> for ServerName<'_>

source§

fn from(v6: Ipv6Addr) -> Self

Converts to this type from the input type.
source§

impl From<Ipv6Addr> for ServerName<'_>

Available on crate feature std only.
source§

fn from(v6: Ipv6Addr) -> Self

Converts to this type from the input type.
source§

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

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl<'a> PartialEq for ServerName<'a>

source§

fn eq(&self, other: &ServerName<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<'a> TryFrom<&'a [u8]> for ServerName<'a>

source§

type Error = InvalidDnsNameError

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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.

source§

type Error = InvalidDnsNameError

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

impl TryFrom<String> for ServerName<'static>

Available on crate feature alloc only.
source§

type Error = InvalidDnsNameError

The type returned in the event of a conversion error.
source§

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.
source§

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

source§

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

Auto Trait Implementations§

§

impl<'a> Freeze for ServerName<'a>

§

impl<'a> RefUnwindSafe for ServerName<'a>

§

impl<'a> Send for ServerName<'a>

§

impl<'a> Sync for ServerName<'a>

§

impl<'a> Unpin for ServerName<'a>

§

impl<'a> UnwindSafe for ServerName<'a>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.