Struct Immortal

pub struct Immortal { /* private fields */ }

Immortal middleware and routing configuration, as well as the session manager.

Implementations

impl Immortal

pub fn new() -> Self

Construct a new Immortal server

pub fn listen<S>(&self, socket_addr: S) -> Result<(), ImmortalError<'_>>

where S: Into<SocketAddr>,

Listens for incoming connections, with as many threads as the system has available for parallelism

pub fn listen_with<S>( &self, socket_addr: S, thread_count: usize, ) -> Result<(), ImmortalError<'_>>

where S: Into<SocketAddr>,

Listens for incoming connections using a specific amount of threads

If threading feature is not present, thread_count will be ignored

pub fn process_buffer(&mut self, request_buffer: &[u8]) -> Vec<u8>

Pass a buffer through the HTTP implementation without listening on a port or dispatching tasks to threads.

pub fn add_middleware(&mut self, func: Handler)

Adds middleware that gets executed just before the router.

if a middleware handler produces a redirect, all of the following middleware handlers are skipped and the redirect is yielded, if middleware produces a redirect, the router is bypassed and custom routes do not run.

pub fn register(&mut self, method: &str, route: &str, func: Handler) -> bool

Calls into the router to register a function Returns true if a route was registered

pub fn unregister(&mut self, method: &str, route: &str) -> bool

Calls into the router to unregister a function Returns true if a route was unregistered

pub fn fallback(&mut self, func: Handler)

Registers the fallback function for when a request is not caught by the router or for if you want to handle all requests manually

pub fn set_session_duration(&self, duration: Duration)

sets the maximum duration that a session may be allowed to persist for regardless of inactivity

pub fn set_inactive_duration(&self, duration: Duration)

Sets the server-side session inactivity expiry duration

pub fn set_prune_rate(&self, duration: Duration)

Sets the prune rate for sessions, will attempt to prune old sessions every duration

pub fn disable_sessions(&mut self)

Configures sessions to be disabled, clears existing server-side sessions

pub fn enable_sessions(&mut self)

Configures sessions to be enabled

Trait Implementations

impl Default for Immortal

fn default() -> Immortal

Returns the “default value” for a type.

impl Drop for Immortal

fn drop(&mut self)

Executes the destructor for this type.