Struct trillium::Info

pub struct Info { /* private fields */ }

This struct represents information about the currently connected server.

It is passed to Handler::init and the Init handler.

Implementations

impl Info

pub fn server_description(&self) -> &str

Returns a user-displayable description of the server. This might be a string like “trillium x.y.z (trillium-tokio x.y.z)” or “my special application”.

pub fn listener_description(&self) -> &str

Returns a user-displayable string description of the location or port the listener is bound to, potentially as a url. Do not rely on the format of this string, as it will vary between server implementations and is intended for user display. Instead, use Info::tcp_socket_addr for any processing.

pub const fn tcp_socket_addr(&self) -> Option<&SocketAddr>

Returns the local_addr of a bound tcp listener, if such a thing exists for this server

pub fn server_description_mut(&mut self) -> &mut String

obtain a mutable borrow of the server description, suitable for appending information or replacing it

pub fn listener_description_mut(&mut self) -> &mut String

obtain a mutable borrow of the listener description, suitable for appending information or replacing it

Trait Implementations

impl Clone for Info

fn clone(&self) -> Info

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Info

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

Formats the value using the given formatter.

impl Default for Info

fn default() -> Self

Returns the “default value” for a type.

impl Display for Info

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

Formats the value using the given formatter.

impl From<&str> for Info

fn from(description: &str) -> Self

Converts to this type from the input type.

impl From<SocketAddr> for Info

fn from(s: SocketAddr) -> Self

Converts to this type from the input type.

impl From<SocketAddr> for Info

fn from(socket_addr: SocketAddr) -> Self

Converts to this type from the input type.