Skip to main content

App

Struct App 

Source
pub struct App { /* private fields */ }
Expand description

The main application builder for Celerix.

Provides a minimal API to register HTTP routes (via axum), queue consumers, and scheduled tasks — all targeting Cloudflare Workers.

Implementations§

Source§

impl App

Source

pub fn new() -> App

Create a new, empty application.

Source

pub fn get<H, T>(&mut self, path: &str, handler: H) -> &mut App
where H: Handler<T, ()> + Clone + Send + 'static, T: 'static,

Register a GET route.

Source

pub fn post<H, T>(&mut self, path: &str, handler: H) -> &mut App
where H: Handler<T, ()> + Clone + Send + 'static, T: 'static,

Register a POST route.

Source

pub fn put<H, T>(&mut self, path: &str, handler: H) -> &mut App
where H: Handler<T, ()> + Clone + Send + 'static, T: 'static,

Register a PUT route.

Source

pub fn delete<H, T>(&mut self, path: &str, handler: H) -> &mut App
where H: Handler<T, ()> + Clone + Send + 'static, T: 'static,

Register a DELETE route.

Source

pub fn patch<H, T>(&mut self, path: &str, handler: H) -> &mut App
where H: Handler<T, ()> + Clone + Send + 'static, T: 'static,

Register a PATCH route.

Source

pub fn router(&mut self, router: Router) -> &mut App

Merge a full axum Router (for advanced use-cases / nesting).

Source

pub fn nest(&mut self, path: &str, router: Router) -> &mut App

Nest a router under a prefix path.

Source

pub fn queue<H>(&mut self, queue_name: &str, handler: H) -> &mut App
where H: QueueHandler,

Register a raw queue consumer for the given queue name.

Source

pub fn schedule<F, Fut>(&mut self, handler: F) -> ScheduleBuilder<'_>
where F: Fn(Ctx) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<(), Error>> + 'static,

Register a scheduled task. Returns a builder to set the interval.

app.schedule(|| async {
    worker::console_log!("runs every 5s");
    Ok(())
}).every_five_seconds();

app.schedule(|| async {
    worker::console_log!("custom cron");
    Ok(())
}).cron("*/5 * * * *");

Register a scheduled task. Returns a builder to set the interval.

The closure receives a Ctx with access to queue() and storage().

app.schedule(|ctx| async move {
    let count = ctx.storage().get("counter").await?.unwrap_or_default();
    info!("counter = {count}");
    Ok(())
}).every_minute();
Source

pub fn into_router(self) -> Router

Consume the app and return the built axum Router.

Source

pub fn queue_handlers(&self) -> &HashMap<String, Box<dyn QueueHandler>>

Get a reference to queue handlers.

Source

pub fn take_scheduled_tasks(&mut self) -> Vec<ScheduledTask>

Take the scheduled tasks.

Trait Implementations§

Source§

impl Default for App

Source§

fn default() -> App

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

Auto Trait Implementations§

§

impl Freeze for App

§

impl !RefUnwindSafe for App

§

impl Send for App

§

impl Sync for App

§

impl Unpin for App

§

impl UnsafeUnpin for App

§

impl !UnwindSafe for App

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> 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, 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<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more
Source§

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more
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