Struct Cluster

pub struct Cluster { /* private fields */ }

An HTTP server cluster.

Trait Implementations

impl Application for Cluster

type Routes = Vec<fn(_: &mut ServiceConfig)>

Routes.

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

Registers default routes.

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

Registers routes with a server tag.

fn add_plugin(self, plugin: Plugin) -> Self

Adds a custom plugin.

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

Runs the application with an optional scheduler for async jobs.

fn boot() -> Self

where Self: Default,

Boots the application with the default initialization.

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

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

Boots the application with a custom initialization.

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

where Self: Sized,

Registers routes for debugger.

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

Returns a reference to the shared application state.

fn env() -> &'static Env

Returns the application env.

fn config() -> &'static Map<String, Value>

Returns a reference to the shared application config.

fn state_data() -> &'static Map<String, Value>

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 secret_key() -> &'static [u8]

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

fn project_dir() -> &'static PathBuf

Returns the project directory for the application.

fn config_dir() -> &'static PathBuf

Returns the config directory for the application.

fn shared_dir(name: &str) -> Cow<'_, PathBuf>

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

fn parse_path(path: &str) -> PathBuf

Parses an absolute path, or a path relative to the home dir ~/ or project dir.

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( url: &str, options: Option<&Map<String, Value>>, ) -> Result<Response, Error>

Available on crate feature http-client only.

Makes an HTTP request to the provided URL.

async fn fetch_json<T>( url: &str, options: Option<&Map<String, Value>>, ) -> Result<T, Error>

where T: DeserializeOwned,

Available on crate feature http-client only.

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

impl Default for Cluster

fn default() -> Cluster

Returns the “default value” for a type.