Skip to main content

AtrgApp

Struct AtrgApp 

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

The application builder. Accumulates user routers and configuration, then boots the full server when AtrgApp::run is called.

Implementations§

Source§

impl AtrgApp

Source

pub fn new() -> Self

Create a new, empty application builder.

Source

pub fn mount(self, router: Router<AppState>) -> Self

Mount an additional [axum::Router] into the application.

Routes are merged, so multiple calls to mount accumulate routes.

Source

pub fn with_auth_routes(self, router: Router<AppState>) -> Self

Register built-in auth routes (OAuth login/callback/logout, client-metadata, well-known).

The supplied router is merged before user routes so that atrg’s built-in endpoints take precedence.

§Example
use atrg_core::AtrgApp;

AtrgApp::new()
    .with_auth_routes(atrg_auth::routes::auth_router())
    // ...
Source

pub fn with_cleanup_task<F>(self, f: F) -> Self
where F: FnOnce(SqlitePool) + Send + 'static,

Register a background cleanup task that is spawned after the server starts. Typically used for periodic session / OAuth-state expiry.

The callback receives the [SqlitePool] and is expected to call tokio::spawn internally.

Source

pub fn on_event<F, Fut>(self, handler: F) -> Self
where F: Fn(JetstreamEvent, AppState) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<()>> + Send + 'static,

Register a Jetstream event handler.

The handler is called for every event received from the Jetstream firehose. It is spawned as a background task inside AtrgApp::run when [jetstream] is present in atrg.toml.

Source

pub fn on_firehose_event<F, Fut>(self, handler: F) -> Self
where F: Fn(FirehoseEvent, AppState) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<()>> + Send + 'static,

Register a firehose event handler.

The handler is called for every event received from the AT Protocol relay firehose (com.atproto.sync.subscribeRepos). It is spawned as a background task inside AtrgApp::run when [firehose] is present in atrg.toml.

Source

pub fn with_feed_generator(self, feed_router: Router<AppState>) -> Self

Mount a feed generator’s routes.

Pass the router produced by FeedGenerator::into_router() (from the atrg-feed crate). This is a semantic alias for mount that makes the builder read more clearly.

§Example
AtrgApp::new()
    .with_feed_generator(feed_gen.into_router())
Source

pub fn with_labeler(self, labeler_router: Router<AppState>) -> Self

Mount a labeler service’s routes.

Pass the router produced by labeler_routes() (from the atrg-label crate). This is a semantic alias for mount that makes the builder read more clearly.

§Example
AtrgApp::new()
    .with_labeler(atrg_label::routes::labeler_routes(service))
Source

pub async fn run(self) -> Result<()>

Boot the server.

This is the only async entry point. It:

  1. Initialises tracing (respects RUST_LOG).
  2. Loads atrg.toml (or $ATRG_CONFIG).
  3. Connects to SQLite and runs migrations.
  4. Builds AppState (including the identity resolver).
  5. Assembles the Axum router with CORS, tracing, and a JSON 404 fallback.
  6. Spawns optional cleanup tasks.
  7. Binds a TCP listener and serves.

Trait Implementations§

Source§

impl Default for AtrgApp

Source§

fn default() -> Self

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

Auto Trait Implementations§

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.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

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
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,