Skip to main content

Application

Struct Application 

Source
pub struct Application<M = NoMigrator>
where M: MigratorTrait,
{ /* private fields */ }
Expand description

Application builder for Ferro framework

Use this to configure and run your Ferro application with a fluent API.

Implementations§

Source§

impl Application<NoMigrator>

Source

pub fn new() -> Self

Create a new application builder

Source§

impl<M> Application<M>
where M: MigratorTrait,

Source

pub fn config<F>(self, f: F) -> Self
where F: FnOnce() + 'static,

Register a configuration function

This function is called early during startup to register application configuration.

§Example
App::new()
    .config(config::register_all)
Source

pub fn bootstrap<F, Fut>(self, f: F) -> Self
where F: FnOnce() -> Fut + Send + 'static, Fut: Future<Output = ()> + Send + 'static,

Register a bootstrap function

This async function is called to register services, middleware, and other application components.

§Example
App::new()
    .bootstrap(bootstrap::register)
Source

pub fn routes<F>(self, f: F) -> Self
where F: FnOnce() -> Router + Send + 'static,

Register a routes function

This function returns the application’s router configuration.

§Example
App::new()
    .routes(routes::register)
Source

pub fn migrations<NewM>(self) -> Application<NewM>
where NewM: MigratorTrait,

Configure the migrator type for database migrations

§Example
Application::new()
    .migrations::<migrations::Migrator>()
Source

pub fn seeders<F>(self, f: F) -> Self
where F: FnOnce() -> SeederRegistry + Send + 'static,

Register a seeders function

This function returns the application’s seeder registry for database seeding.

§Example
Application::new()
    .seeders(seeders::register)
Source

pub async fn run(self)

Run the application

This parses CLI arguments and executes the appropriate command:

  • serve (default): Run the web server
  • db:migrate: Run pending migrations
  • db:status: Show migration status
  • db:rollback: Rollback migrations
  • db:fresh: Drop and re-run all migrations
  • schedule:*: Scheduler commands

Trait Implementations§

Source§

impl Default for Application<NoMigrator>

Source§

fn default() -> Self

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

Auto Trait Implementations§

§

impl<M> Freeze for Application<M>

§

impl<M = NoMigrator> !RefUnwindSafe for Application<M>

§

impl<M = NoMigrator> !Send for Application<M>

§

impl<M = NoMigrator> !Sync for Application<M>

§

impl<M> Unpin for Application<M>
where M: Unpin,

§

impl<M> UnsafeUnpin for Application<M>

§

impl<M = NoMigrator> !UnwindSafe for Application<M>

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

Source§

fn len(&self) -> usize

The number of items that this chain link consists of.
Source§

fn append_to(self, v: &mut Vec<T>)

Append the elements in this link to the chain.
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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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