Struct RouterBuilder 

pub struct RouterBuilder { /* private fields */ }

A builder to construct axum::Route of CometD server.

Implementations

impl RouterBuilder

pub fn new() -> Self

Construct a new RouterBuilder.

pub fn build<CustomData>( self, context: Arc<LongPollingServiceContext<(), CustomData>>, ) -> Router

where CustomData: Send + Sync + 'static,

Return a axum::Router.

Example

use std::sync::Arc;
use axum_cometd::RouterBuilder;

let app = RouterBuilder::new().build::<()>(Arc::clone(&context));

pub fn build_with_additional_data<AdditionalData, CustomData>( self, context: Arc<LongPollingServiceContext<AdditionalData, CustomData>>, ) -> Router

where AdditionalData: Clone + Send + Sync + 'static, CustomData: Send + Sync + 'static,

Return a axum::Router.

Example

use std::sync::Arc;
use axum::Extension;
use axum_cometd::RouterBuilder;

#[derive(Clone)]
struct ContextData {
    server_name: String,
}

let app = RouterBuilder::new()
    .build_with_additional_data(Arc::clone(&context))
    .layer(Extension(ContextData {
        server_name: std::env::var("SERVER_NAME").unwrap_or_else(|_| "Skalica".to_owned()),
    }));

pub const fn subscribe_base_path(self, path: &'static str) -> Self

Set subscribe base-path for routers.

Example

use std::sync::Arc;
use axum_cometd::RouterBuilder;

let app = RouterBuilder::new()
    // Ex: `/` -> `/bar`
    .subscribe_base_path("/bar")
    .build::<()>(Arc::clone(&context));

pub const fn handshake_base_path(self, path: &'static str) -> Self

Set handshake base-path for routers.

Example

use std::sync::Arc;
use axum_cometd::RouterBuilder;

let app = RouterBuilder::new()
    // Ex: `/handshake` -> `/bar/handshake`
    .handshake_base_path("/bar")
    .build::<()>(Arc::clone(&context));

pub const fn connect_base_path(self, path: &'static str) -> Self

Set connect base-path for routers.

Example

use std::sync::Arc;
use axum_cometd::RouterBuilder;

let app = RouterBuilder::new()
    // Ex: `/connect` -> `/bar/connect`
    .connect_base_path("/bar")
    .build::<()>(Arc::clone(&context));

pub const fn disconnect_base_path(self, path: &'static str) -> Self

Set disconnect base-path for routers.

Example

use std::sync::Arc;
use axum_cometd::RouterBuilder;

let app = RouterBuilder::new()
    // Ex: `/disconnect` -> `/bar/disconnect`
    .disconnect_base_path("/bar")
    .build::<()>(Arc::clone(&context));

Trait Implementations

impl Debug for RouterBuilder

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

Formats the value using the given formatter.

impl Default for RouterBuilder

fn default() -> Self

Returns the “default value” for a type.