Trait edm_core::application::Application

pub trait Application {
    type Routes;

    // Required methods
    fn register(self, routes: Self::Routes) -> Self;
    fn run_with<T: AsyncScheduler + Send + 'static>(self, scheduler: T);

    // Provided methods
    fn boot() -> Self
       where Self: Default { ... }
    fn boot_with<F>(init: F) -> Self
       where Self: Default,
             F: FnOnce(&'static State<Map>) { ... }
    fn register_with(self, server_tag: ServerTag, routes: Self::Routes) -> Self
       where Self: Sized { ... }
    fn register_debug(self, routes: Self::Routes) -> Self
       where Self: Sized { ... }
    fn sysinfo() -> Map { ... }
    fn openapi() -> OpenApi { ... }
    fn shared_state() -> &'static State<Map> { ... }
    fn env() -> &'static Env { ... }
    fn config() -> &'static Table { ... }
    fn state_data() -> &'static Map { ... }
    fn name() -> &'static str { ... }
    fn version() -> &'static str { ... }
    fn domain() -> &'static str { ... }
    fn project_dir() -> &'static PathBuf { ... }
    fn secret_key() -> &'static [u8]  { ... }
    fn shared_dir(name: &str) -> PathBuf { ... }
    fn spawn<T>(self, scheduler: T) -> Self
       where Self: Sized,
             T: Scheduler + Send + 'static { ... }
    fn run(self)
       where Self: Sized { ... }
    async fn load() { ... }
    async fn shutdown() { ... }
    async fn fetch(
        resource: &str,
        options: Option<&Map>
    ) -> Result<Response, Error> { ... }
    async fn fetch_json<T: DeserializeOwned>(
        resource: &str,
        options: Option<&Map>
    ) -> Result<T, Error> { ... }
}

Application interfaces.

Required Associated Types

type Routes

Routes.

Required Methods

fn register(self, routes: Self::Routes) -> Self

Registers default routes.

fn run_with<T: AsyncScheduler + Send + 'static>(self, scheduler: T)

Runs the application with an optional scheduler for async jobs.

Provided Methods

fn boot() -> Self

where Self: Default,

Boots the application. It also initializes the required directories and setups the default secret key, the tracing subscriber, the metrics exporter and a global HTTP client.

fn boot_with<F>(init: F) -> Self

where Self: Default, F: FnOnce(&'static State<Map>),

Boots the application with a custom initialization.

fn register_with(self, server_tag: ServerTag, routes: Self::Routes) -> Self

where Self: Sized,

Registers routes with a server tag.

fn register_debug(self, routes: Self::Routes) -> Self

where Self: Sized,

Registers routes for debugger.

fn sysinfo() -> Map

Gets the system’s information.

fn openapi() -> OpenApi

Gets the OpenAPI document.

fn shared_state() -> &'static State<Map>

Returns a reference to the shared application state.

fn env() -> &'static Env

Returns the application env.

fn config() -> &'static Table

Returns a reference to the shared application config.

fn state_data() -> &'static Map

Returns a reference to the shared application state data.

fn name() -> &'static str

Returns the application name.

fn version() -> &'static str

Returns the application version.

fn domain() -> &'static str

Returns the domain for the application.

fn project_dir() -> &'static PathBuf

Returns the project directory for the application.

fn secret_key() -> &'static [u8]

Returns the secret key for the application. It should have at least 64 bytes.

Note

This should only be used for internal services. Do not expose it to external users.

fn shared_dir(name: &str) -> PathBuf

Returns the shared directory with the specific name, which is defined in the dirs table.

fn spawn<T>(self, scheduler: T) -> Self

where Self: Sized, T: Scheduler + Send + 'static,

Spawns a new thread to run cron jobs.

fn run(self)

where Self: Sized,

Runs the application with a default job scheduler.

async fn load()

Loads resources after booting the application.

async fn shutdown()

Handles the graceful shutdown.

async fn fetch(resource: &str, options: Option<&Map>) -> Result<Response, Error>

Makes an HTTP request to the provided resource using reqwest.

async fn fetch_json<T: DeserializeOwned>( resource: &str, options: Option<&Map> ) -> Result<T, Error>

Makes an HTTP request to the provided resource and deserializes the response body via JSON.

Object Safety

This trait is not object safe.

Implementors