Enum rocket::listener::Endpoint

#[non_exhaustive]
pub enum Endpoint {
    Tcp(SocketAddr),
    Quic(SocketAddr),
    Unix(PathBuf),
    Tls(Arc<Endpoint>, Option<Box<TlsConfig>>),
    Custom(Arc<dyn CustomEndpoint>),
}

Conversions

• &str - parse with FromStr
• tokio::net::unix::SocketAddr - must be path: Endpoint::Unix
• PathBuf - infallibly as Endpoint::Unix

Syntax

The string syntax is:

endpoint = 'tcp' ':' socket | 'quic' ':' socket | 'unix' ':' path | socket
socket := IP_ADDR | SOCKET_ADDR
path := PATH

IP_ADDR := `std::net::IpAddr` string as defined by Rust
SOCKET_ADDR := `std::net::SocketAddr` string as defined by Rust
PATH := `PathBuf` (any UTF-8) string as defined by Rust

If IP_ADDR is specified in socket, port defaults to 8000.

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.

Tcp(SocketAddr)

Quic(SocketAddr)

Unix(PathBuf)

Tls(Arc<Endpoint>, Option<Box<TlsConfig>>)

Custom(Arc<dyn CustomEndpoint>)

Implementations

impl Endpoint

pub fn new<T: CustomEndpoint>(value: T) -> Endpoint

pub fn tcp(&self) -> Option<SocketAddr>

pub fn quic(&self) -> Option<SocketAddr>

pub fn socket_addr(&self) -> Option<SocketAddr>

pub fn ip(&self) -> Option<IpAddr>

pub fn port(&self) -> Option<u16>

pub fn unix(&self) -> Option<&Path>

pub fn tls(&self) -> Option<&Endpoint>

pub fn tls_config(&self) -> Option<&TlsConfig>

pub fn mtls_config(&self) -> Option<&MtlsConfig>

pub fn downcast<T: 'static>(&self) -> Option<&T>

pub fn is_tcp(&self) -> bool

pub fn is_quic(&self) -> bool

pub fn is_unix(&self) -> bool

pub fn is_tls(&self) -> bool

pub fn with_tls(self, tls: &TlsConfig) -> Endpoint

pub fn assume_tls(self) -> Endpoint

Trait Implementations

impl Clone for Endpoint

fn clone(&self) -> Endpoint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Endpoint

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

Formats the value using the given formatter.

impl Default for Endpoint

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Endpoint

fn deserialize<D: Deserializer<'de>>(de: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for Endpoint

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

Formats the value using the given formatter.

impl From<PathBuf> for Endpoint

fn from(value: PathBuf) -> Self

Converts to this type from the input type.

impl From<SocketAddr> for Endpoint

fn from(value: SocketAddr) -> Self

Converts to this type from the input type.

impl From<SocketAddrV4> for Endpoint

fn from(value: SocketAddrV4) -> Self

Converts to this type from the input type.

impl From<SocketAddrV6> for Endpoint

fn from(value: SocketAddrV6) -> Self

Converts to this type from the input type.

impl<'r> FromRequest<'r> for &'r Endpoint

type Error = Infallible

The associated error to be returned if derivation fails.

fn from_request<'life0, 'async_trait>( request: &'r Request<'life0>, ) -> Pin<Box<dyn Future<Output = Outcome<Self, Infallible>> + Send + 'async_trait>>

where Self: 'async_trait, 'r: 'async_trait, 'life0: 'async_trait,

Derives an instance of Self from the incoming request metadata.

impl FromStr for Endpoint

type Err = AddrParseError

The associated error which can be returned from parsing.

fn from_str(string: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq<Path> for Endpoint

fn eq(&self, other: &Path) -> 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 PartialEq<PathBuf> for Endpoint

fn eq(&self, other: &PathBuf) -> 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 PartialEq for Endpoint

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

type Error = AddrParseError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<SocketAddr> for Endpoint

type Error = Error

The type returned in the event of a conversion error.

fn try_from(v: SocketAddr) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Endpoint