Skip to main content

Ultimo

Struct Ultimo 

Source
pub struct Ultimo { /* private fields */ }
Expand description

Main Ultimo application

Implementations§

Source§

impl Ultimo

Source

pub fn new() -> Self

Create a new Ultimo application

By default, adds X-Powered-By: Ultimo header to all responses. To disable this, use new_without_defaults() instead.

Source

pub fn new_without_defaults() -> Self

Create a new Ultimo application without default middleware

Use this if you don’t want the X-Powered-By: Ultimo header or want full control over middleware configuration.

Source

pub fn max_body_size(&mut self, bytes: usize) -> &mut Self

Set the maximum request body size in bytes.

Requests whose body exceeds this are rejected with 413 Payload Too Large (and, on the live server, the oversized body is not buffered). Defaults to no limit — setting one is recommended for production.

Source

pub fn trust_proxy(&mut self, trust: bool) -> &mut Self

Trust X-Forwarded-For / Forwarded headers for Context::client_ip.

Only enable when the app sits behind a trusted proxy/load balancer — these headers are client-spoofable, so trusting them on a directly-exposed server lets clients forge their IP. Defaults to false.

Source

pub fn get( &mut self, path: &str, handler: impl IntoHandler + 'static, ) -> &mut Self

Add a GET route

Source

pub fn post( &mut self, path: &str, handler: impl IntoHandler + 'static, ) -> &mut Self

Add a POST route

Source

pub fn put( &mut self, path: &str, handler: impl IntoHandler + 'static, ) -> &mut Self

Add a PUT route

Source

pub fn delete( &mut self, path: &str, handler: impl IntoHandler + 'static, ) -> &mut Self

Add a DELETE route

Source

pub fn patch( &mut self, path: &str, handler: impl IntoHandler + 'static, ) -> &mut Self

Add a PATCH route

Source

pub fn options( &mut self, path: &str, handler: impl IntoHandler + 'static, ) -> &mut Self

Add an OPTIONS route

Source

pub fn use_middleware(&mut self, middleware: BoxedMiddleware) -> &mut Self

Add global middleware

Source

pub async fn oneshot(&self, req: HyperRequest<Full<Bytes>>) -> Response

Dispatch a fully-buffered request through the app in-process (no socket).

Source

pub async fn listen(self, addr: &str) -> Result<()>

Start the HTTP server

Trait Implementations§

Source§

impl Default for Ultimo

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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, 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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more