Skip to main content

UnifiedRouter

Struct UnifiedRouter 

Source
pub struct UnifiedRouter { /* private fields */ }
Available on crate feature client-router only.
Expand description

Unified router combining server and client routing capabilities.

This struct provides a unified interface for configuring both:

  • Server-side routes: HTTP methods, middleware, DI, ViewSets
  • Client-side routes: SPA navigation, history API, Page rendering

§Example

use reinhardt_urls::routers::UnifiedRouter;
use reinhardt_core::page::Page;

let router = UnifiedRouter::new()
    .server(|s| s.function("/api/health", Method::GET, health_handler))
    .client(|c| c.route("/", || home_page()));

Implementations§

Source§

impl UnifiedRouter

Source

pub fn new() -> UnifiedRouter

Available on crate feature test and non-WebAssembly and (non-WebAssembly or crate feature client-router) only.

Creates a new UnifiedRouter with default server and client routers.

Source

pub fn server<F>(self, f: F) -> UnifiedRouter

Available on crate feature test and non-WebAssembly and (non-WebAssembly or crate feature client-router) only.

Configure server-side routing with a closure.

The closure receives a ServerRouter and should return a configured router.

§Example
let router = UnifiedRouter::new()
    .server(|s| s
        .with_prefix("/api")
        .function("/users", Method::GET, list_users));
Source

pub fn client<F>(self, f: F) -> UnifiedRouter

Available on crate feature test and non-WebAssembly and (non-WebAssembly or crate feature client-router) only.

Configure client-side routing with a closure.

The closure receives a ClientRouter and should return a configured router.

§Example
let router = UnifiedRouter::new()
    .client(|c| c
        .route("/", || home_page())
        .route_path("/users/{id}", |Path(id): Path<i64>| user_page(id)));
Source

pub fn server_ref(&self) -> &ServerRouter

Available on crate feature test and non-WebAssembly and (non-WebAssembly or crate feature client-router) only.

Returns a reference to the server router.

Source

pub fn server_mut(&mut self) -> &mut ServerRouter

Available on crate feature test and non-WebAssembly and (non-WebAssembly or crate feature client-router) only.

Returns a mutable reference to the server router.

Source

pub fn client_ref(&self) -> &ClientRouter

Available on crate feature test and non-WebAssembly and (non-WebAssembly or crate feature client-router) only.

Returns a reference to the client router.

Source

pub fn client_mut(&mut self) -> &mut ClientRouter

Available on crate feature test and non-WebAssembly and (non-WebAssembly or crate feature client-router) only.

Returns a mutable reference to the client router.

Source

pub fn into_server(self) -> ServerRouter

Available on crate feature test and non-WebAssembly and (non-WebAssembly or crate feature client-router) only.

Consumes the router and returns the server router.

If this router has a DI context, deferred DI registrations are applied directly to its singleton scope. Otherwise they are stashed in the global registry for later application by the server.

Source

pub fn into_client(self) -> ClientRouter

Available on crate feature test and non-WebAssembly and (non-WebAssembly or crate feature client-router) only.

Consumes the router and returns the client router.

Source

pub fn into_parts(self) -> (ServerRouter, ClientRouter)

Available on crate feature test and non-WebAssembly and (non-WebAssembly or crate feature client-router) only.

Consumes the router and returns both parts.

Source

pub fn register_globally(self) -> ClientRouter

Available on crate feature test and non-WebAssembly and (non-WebAssembly or crate feature client-router) only.

Registers server router globally and returns client router.

This is a convenience method for full-stack applications that need to:

  1. Register the server router globally for HTTP request handling
  2. Keep the client router for SPA navigation
§Example
let client = UnifiedRouter::new()
    .server(|s| s.function("/api/data", Method::GET, handler))
    .client(|c| c.route("/", || home_page()))
    .register_globally();

// Server router is now globally registered
// Client router is returned for SPA use
Source

pub fn with_di_registrations(self, list: DiRegistrationList) -> UnifiedRouter

Available on crate feature test and non-WebAssembly and (non-WebAssembly or crate feature client-router) only.

Attach deferred DI registrations to this router.

When the router is consumed, these registrations are applied directly to the DI context’s singleton scope if one has been set via with_di_context. Otherwise they are stashed globally for later application (e.g., by the runall command).

Source

pub fn with_prefix(self, prefix: impl Into<String>) -> UnifiedRouter

Available on crate feature test and non-WebAssembly and (non-WebAssembly or crate feature client-router) only.

Set URL prefix for server router.

This is a convenience method that delegates to ServerRouter::with_prefix.

Source

pub fn with_namespace(self, namespace: impl Into<String>) -> UnifiedRouter

Available on crate feature test and non-WebAssembly and (non-WebAssembly or crate feature client-router) only.

Set namespace for server router.

This is a convenience method that delegates to ServerRouter::with_namespace.

Source

pub fn with_di_context(self, ctx: Arc<InjectionContext>) -> UnifiedRouter

Available on crate feature test and non-WebAssembly and (non-WebAssembly or crate feature client-router) only.

Set DI context for server router.

This is a convenience method that delegates to ServerRouter::with_di_context.

Source

pub fn with_middleware<M>(self, middleware: M) -> UnifiedRouter
where M: Middleware + 'static,

Available on crate feature test and non-WebAssembly and (non-WebAssembly or crate feature client-router) only.

Add middleware to server router.

This is a convenience method that delegates to ServerRouter::with_middleware.

Source

pub fn exclude(self, pattern: &str) -> UnifiedRouter

Available on crate feature test and non-WebAssembly and (non-WebAssembly or crate feature client-router) only.

Exclude a URL path from the most recently added server middleware.

This is a convenience method that delegates to ServerRouter::exclude.

Source

pub fn mount(self, prefix: &str, child: ServerRouter) -> UnifiedRouter

Available on crate feature test and non-WebAssembly and (non-WebAssembly or crate feature client-router) only.

Mount a child server router on this router.

This is a convenience method that delegates to ServerRouter::mount.

Source

pub fn mount_unified(self, prefix: &str, child: UnifiedRouter) -> UnifiedRouter

Available on crate feature test and non-WebAssembly and (non-WebAssembly or crate feature client-router) only.

Mount a child UnifiedRouter on this router.

Extracts the server router from the child and mounts it.

Source

pub fn endpoint<F, E>(self, f: F) -> UnifiedRouter
where F: FnOnce() -> E, E: EndpointInfo + Handler + 'static,

Available on crate feature test and non-WebAssembly and (non-WebAssembly or crate feature client-router) only.

Register an endpoint on server router.

This is a convenience method that delegates to ServerRouter::endpoint.

Source

pub fn function<F, Fut>( self, path: &str, method: Method, func: F, ) -> UnifiedRouter
where F: Fn(Request) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<Response, Error>> + Send + 'static,

Available on crate feature test and non-WebAssembly and (non-WebAssembly or crate feature client-router) only.

Register a function-based route on server router.

This is a convenience method that delegates to ServerRouter::function.

Source

pub fn function_named<F, Fut>( self, path: &str, method: Method, name: &str, func: F, ) -> UnifiedRouter
where F: Fn(Request) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<Response, Error>> + Send + 'static,

Available on crate feature test and non-WebAssembly and (non-WebAssembly or crate feature client-router) only.

Register a named function-based route on server router.

This is a convenience method that delegates to ServerRouter::function_named.

Trait Implementations§

Source§

impl DeeplinkRouterExt for UnifiedRouter

Source§

type Output = UnifiedRouter

The output type after adding deeplinks.
Adds deeplink handlers to the router. Read more
Source§

impl Default for UnifiedRouter

Available on non-WebAssembly only.
Source§

fn default() -> UnifiedRouter

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> Any for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Source§

fn type_name(&self) -> &'static str

Source§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> FmtForward for T

Source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
Source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
Source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
Source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
Source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
Source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
Source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
Source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
Source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. 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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<T> IntoResult<T> for T

Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

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

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

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

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

Source§

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
Source§

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<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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