Skip to main content

App

Struct App 

Source
pub struct App<S> { /* private fields */ }
Expand description

A ling-http application: an axum Router pre-wired with the middleware every service on this framework wants (tracing, timeouts, a body-size cap, CORS), plus HTTPS serving helpers.

S is your application state (typically a struct holding a crate::db::Db and any config), shared across handlers via axum’s State extractor.

Implementations§

Source§

impl<S> App<S>
where S: Clone + Send + Sync + 'static,

Source

pub fn new() -> Self

Starts from an empty router with sane default middleware: request tracing, a 60s timeout, and a 25 MiB request body cap (override with .max_body_bytes if a route needs to accept larger uploads, e.g. crate tarballs).

Source

pub fn max_body_bytes(self, bytes: usize) -> Self

Raises the request body size cap. Call this before merging in routes that need to accept large uploads.

Source

pub fn merge(self, routes: Router<S>) -> Self

Merges routes (from .route(...) calls or crate::mvc::resource) into the app.

Source

pub fn with_state(self, state: S) -> Router

Attaches the shared application state, finishing the router.

Trait Implementations§

Source§

impl<S> Default for App<S>
where S: Clone + Send + Sync + 'static,

Source§

fn default() -> Self

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

Auto Trait Implementations§

§

impl<S> !RefUnwindSafe for App<S>

§

impl<S> !UnwindSafe for App<S>

§

impl<S> Freeze for App<S>
where Router<S>: Freeze,

§

impl<S> Send for App<S>
where Router<S>: Send,

§

impl<S> Sync for App<S>
where Router<S>: Sync,

§

impl<S> Unpin for App<S>
where Router<S>: Unpin,

§

impl<S> UnsafeUnpin for App<S>
where Router<S>: UnsafeUnpin,

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

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. 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.
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