Struct ArclyPluginContext 

pub struct ArclyPluginContext { /* private fields */ }

Implementations

impl ArclyPluginContext

pub fn provide<T: Send + Sync + 'static>(&mut self, value: T)

Inject a singleton of type T into the DI container. Resolves later via Inject<T> in any controller / service / interceptor.

Order: every plugin’s on_init runs first, then all provide<T> closures are applied in declaration order, then the container freezes. So one plugin can read another’s provision in on_start but not in on_init.

pub fn add_route<F, Fut>( &mut self, method: HttpMethod, path: &'static str, handler: F, )

where F: Fn(RequestContext) -> Fut + Send + Sync + 'static, Fut: Future<Output = Response> + Send + 'static,

Register a route. The handler receives a fully-built RequestContext — including DI access via ctx.inject::<T>() — and returns a Response. The path is mounted verbatim under the application root.

pub fn add_get<F, Fut>(&mut self, path: &'static str, handler: F)

where F: Fn(RequestContext) -> Fut + Send + Sync + 'static, Fut: Future<Output = Response> + Send + 'static,

Shortcut: register a GET.

pub fn modify_openapi<F>(&mut self, f: F)

where F: FnOnce(&mut Value) + Send + Sync + 'static,

Mutate the assembled OpenAPI document at launch time.

pub fn require_env(&self, key: &'static str) -> Result<String, PluginError>

Read a required environment variable.

Returns Err(PluginError) with stage Init if the variable is absent or contains non-UTF-8 bytes, so callers can propagate it cleanly with ?.

pub fn env_or(&self, key: &str, default: impl Into<String>) -> String

Read an environment variable with a fallback default.

pub fn register_global_interceptor(&mut self, ic: &'static dyn Interceptor)

Attach an interceptor that fires on every route registered via the macros. Plugin routes opt in separately if they want it.

Trait Implementations

impl Default for ArclyPluginContext

fn default() -> Self

Returns the “default value” for a type.