1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
use crate::{handlers::*, LongPollingServiceContext};
use axum::{routing::post, Extension, Router};
use core::fmt::Debug;
use std::sync::Arc;
/// A builder to construct `axum::Route` of CometD server.
#[derive(Debug)]
pub struct RouterBuilder {
subscribe_base_path: &'static str,
handshake_base_path: &'static str,
connect_base_path: &'static str,
disconnect_base_path: &'static str,
}
impl Default for RouterBuilder {
#[inline(always)]
fn default() -> Self {
Self {
subscribe_base_path: "/",
handshake_base_path: "",
connect_base_path: "",
disconnect_base_path: "",
}
}
}
impl RouterBuilder {
/// Construct a new `RouterBuilder`.
#[inline(always)]
pub fn new() -> Self {
Self::default()
}
/// Return a `axum::Router`.
///
/// # Example
/// ```rust,no_run
/// use std::sync::Arc;
/// use axum_cometd::RouterBuilder;
///
/// # let context = axum_cometd::LongPollingServiceContextBuilder::new().build();
/// let app = RouterBuilder::new().build::<()>(Arc::clone(&context));
/// ```
#[inline(always)]
pub fn build<CustomData>(
self,
context: Arc<LongPollingServiceContext<(), CustomData>>,
) -> Router
where
CustomData: Send + Sync + 'static,
{
self.build_with_additional_data(context)
.layer(Extension(()))
}
/// Return a `axum::Router`.
///
/// # Example
/// ```rust,no_run
/// use std::sync::Arc;
/// use axum::Extension;
/// use axum_cometd::RouterBuilder;
///
/// # let context = axum_cometd::LongPollingServiceContextBuilder::new().build::<ContextData, ()>();
/// #[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()),
/// }));
/// ```
#[inline]
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,
{
let Self {
subscribe_base_path,
handshake_base_path,
connect_base_path,
disconnect_base_path,
} = self;
Router::new()
.route(subscribe_base_path, post(subscribe))
.route(&format!("{handshake_base_path}/handshake"), post(handshake))
.route(&format!("{connect_base_path}/connect"), post(connect))
.route(
&format!("{disconnect_base_path}/disconnect"),
post(disconnect),
)
.with_state(context)
}
/// Set subscribe base-path for routers.
///
/// # Example
/// ```rust,no_run
/// use std::sync::Arc;
/// use axum_cometd::RouterBuilder;
///
/// # let context = axum_cometd::LongPollingServiceContextBuilder::new().build();
/// let app = RouterBuilder::new()
/// // Ex: `/` -> `/bar`
/// .subscribe_base_path("/bar")
/// .build::<()>(Arc::clone(&context));
/// ```
#[inline(always)]
#[must_use]
pub const fn subscribe_base_path(self, path: &'static str) -> Self {
Self {
subscribe_base_path: path,
..self
}
}
/// Set handshake base-path for routers.
///
/// # Example
/// ```rust,no_run
/// use std::sync::Arc;
/// use axum_cometd::RouterBuilder;
///
/// # let context = axum_cometd::LongPollingServiceContextBuilder::new().build();
/// let app = RouterBuilder::new()
/// // Ex: `/handshake` -> `/bar/handshake`
/// .handshake_base_path("/bar")
/// .build::<()>(Arc::clone(&context));
/// ```
#[inline(always)]
#[must_use]
pub const fn handshake_base_path(self, path: &'static str) -> Self {
Self {
handshake_base_path: path,
..self
}
}
/// Set connect base-path for routers.
///
/// # Example
/// ```rust,no_run
/// use std::sync::Arc;
/// use axum_cometd::RouterBuilder;
///
/// # let context = axum_cometd::LongPollingServiceContextBuilder::new().build();
/// let app = RouterBuilder::new()
/// // Ex: `/connect` -> `/bar/connect`
/// .connect_base_path("/bar")
/// .build::<()>(Arc::clone(&context));
/// ```
#[inline(always)]
#[must_use]
pub const fn connect_base_path(self, path: &'static str) -> Self {
Self {
connect_base_path: path,
..self
}
}
/// Set disconnect base-path for routers.
///
/// # Example
/// ```rust,no_run
/// use std::sync::Arc;
/// use axum_cometd::RouterBuilder;
///
/// # let context = axum_cometd::LongPollingServiceContextBuilder::new().build();
/// let app = RouterBuilder::new()
/// // Ex: `/disconnect` -> `/bar/disconnect`
/// .disconnect_base_path("/bar")
/// .build::<()>(Arc::clone(&context));
/// ```
#[inline(always)]
#[must_use]
pub const fn disconnect_base_path(self, path: &'static str) -> Self {
Self {
disconnect_base_path: path,
..self
}
}
}