Struct FeedGenerator 

pub struct FeedGenerator { /* private fields */ }

A feed generator that manages multiple feeds and produces Axum routes.

Example

let feeds = FeedGenerator::new("did:web:feeds.example.com")
    .feed("my-feed", "My Custom Feed", None, my_handler)
    .feed("other-feed", "Other Feed", Some("A description"), other_handler)
    .into_router();

Implementations

impl FeedGenerator

pub fn new(did: impl Into<String>) -> Self

Create a new feed generator with the given service DID.

The DID identifies this feed generator on the AT Protocol network (e.g. "did:web:feeds.example.com").

pub fn feed<F, Fut>( self, id: &str, display_name: &str, description: Option<&str>, handler: F, ) -> Self

where F: Fn(FeedRequest, AppState) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<FeedSkeleton, XrpcError>> + Send + 'static,

Register a feed with the given ID, display name, optional description, and handler function.

The handler is called each time a client requests the feed skeleton. It receives a FeedRequest and the AppState, and must return a FeedSkeleton or an XrpcError.

Example

async fn chronological(
    req: FeedRequest,
    state: AppState,
) -> Result<FeedSkeleton, XrpcError> {
    // query DB, build skeleton ...
    Ok(FeedSkeleton { feed: vec![], cursor: None })
}

let gen = FeedGenerator::new("did:web:example.com")
    .feed("chrono", "Chronological", Some("Latest posts"), chronological);

pub fn feed_with_config<F, Fut>(self, config: FeedConfig, handler: F) -> Self

where F: Fn(FeedRequest, AppState) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<FeedSkeleton, XrpcError>> + Send + 'static,

Register a feed from an existing FeedConfig and handler function.

This is useful when feed configurations are loaded from atrg.toml or another config source.

pub fn did(&self) -> &str

Return the service DID for this feed generator.

pub fn feed_count(&self) -> usize

Return the number of registered feeds.

pub fn into_router(self) -> Router<AppState>

Build an Axum router with the XRPC feed endpoints.

Registers:

• GET /xrpc/app.bsky.feed.describeFeedGenerator
• GET /xrpc/app.bsky.feed.getFeedSkeleton