Struct ProjectContext 

pub struct ProjectContext<S: BootstrapPhase = Initialized> { /* private fields */ }

Shared context and configs for all apps. Used in conjunction with the Project trait.

Implementations

impl<S: BootstrapPhase<Config = Arc<ProjectConfig>>> ProjectContext<S>

pub fn config(&self) -> &ProjectConfig

Returns the configuration for the project.

Examples

use cot::request::{Request, RequestExt};
use cot::response::Response;

async fn index(request: Request) -> cot::Result<Response> {
    let config = request.context().config();
    // can also be accessed via:
    let config = request.project_config();

    let db_url = &config.database.url;

    // ...
}

impl<S: BootstrapPhase<Apps = Vec<Box<dyn App>>>> ProjectContext<S>

pub fn apps(&self) -> &[Box<dyn App>]

Returns the apps for the project.

Examples

use cot::request::{Request, RequestExt};
use cot::response::Response;

async fn index(request: Request) -> cot::Result<Response> {
    let apps = request.context().apps();

    // ...
}

impl<S: BootstrapPhase<Router = Arc<Router>>> ProjectContext<S>

pub fn router(&self) -> &Arc<Router>

Returns the router for the project.

Examples

use cot::request::{Request, RequestExt};
use cot::response::Response;

async fn index(request: Request) -> cot::Result<Response> {
    let router = request.context().config();
    // can also be accessed via:
    let router = request.router();

    let num_routes = router.routes().len();

    // ...
}

impl<S: BootstrapPhase<AuthBackend = Arc<dyn AuthBackend>>> ProjectContext<S>

pub fn auth_backend(&self) -> &Arc<dyn AuthBackend>

Returns the authentication backend for the project.

Examples

use cot::request::{Request, RequestExt};
use cot::response::Response;

async fn index(request: Request) -> cot::Result<Response> {
    let auth_backend = request.context().auth_backend();
    // ...
}

impl<S: BootstrapPhase<Email = Email>> ProjectContext<S>

pub fn email(&self) -> &Email

Available on crate feature email only.

Returns the email service for the project.

Examples

use cot::request::{Request, RequestExt};
use cot::response::Response;

async fn index(request: Request) -> cot::Result<Response> {
    let email = request.context().email();
    // ...
}

impl<S: BootstrapPhase<Cache = Cache>> ProjectContext<S>

pub fn cache(&self) -> &Cache

Available on crate feature cache only.

Returns the cache for the project.

Examples

use cot::request::{Request, RequestExt};
use cot::response::Response;

async fn index(request: Request) -> cot::Result<Response> {
    let cache = request.context().cache();
    // ...
}

impl<S: BootstrapPhase<Database = Option<Database>>> ProjectContext<S>

pub fn try_database(&self) -> Option<&Database>

Available on crate feature db only.

Returns the database for the project, if it is enabled.

Examples

use cot::request::{Request, RequestExt};
use cot::response::Response;

async fn index(request: Request) -> cot::Result<Response> {
    let database = request.context().try_database();
    if let Some(database) = database {
        // do something with the database
    } else {
        // database is not enabled
    }
}

pub fn database(&self) -> &Database

Available on crate feature db only.

Returns the database for the project, if it is enabled.

Panics

This method panics if the database is not enabled.

Examples

use cot::request::{Request, RequestExt};
use cot::response::Response;

async fn index(request: Request) -> cot::Result<Response> {
    let database = request.context().database();
    // use the database
}

Trait Implementations

impl<S: BootstrapPhase> Debug for ProjectContext<S>

where S::Config: Debug, S::Router: Debug, S::Database: Debug, S::Cache: Debug, S::Email: Debug,

fn fmt(&self, __derive_more_f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.