Skip to main content

IpcRouter

Struct IpcRouter 

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

HTTP-like IPC Router

Routes incoming IPC requests to appropriate handlers based on URL patterns. Supports static paths, path parameters, query strings, and multiple body formats.

Implementations§

Source§

impl IpcRouter

Source

pub fn new() -> IpcRouter

Creates a new empty IPC router

Source

pub fn builder() -> IpcRouterBuilder

Create a new router builder

Source

pub fn register( &mut self, method: &str, pattern: &str, handler: Box<dyn RouteHandler>, )

Registers a new route handler

§Arguments
  • method - HTTP method (informational, e.g., “GET”, “POST”)
  • pattern - URL pattern with optional parameters (e.g., “/user/:id”)
  • handler - Boxed handler implementing RouteHandler trait
§Example
router.register("POST", "/form/submit", Box::new(FormSubmitHandler));
router.register("GET", "/user/:id", Box::new(GetUserHandler));
Source

pub fn dispatch(&self, raw_request: &Value) -> IpcResponse

Dispatches an IPC request to the appropriate route handler

§Arguments
  • raw_request - Raw IPC request from JavaScript
§Returns
  • IpcResponse - HTTP-like response (includes 404 if no route matches)
Source

pub fn list_routes(&self) -> Vec<(String, String)>

Returns a list of all registered routes

Useful for debugging and introspection.

Source

pub fn start(&self)

Start the IPC message handler loop

This method sets up the eval channel and automatically handles incoming IPC requests, dispatching them to registered routes and sending responses back.

§Example
use dioxus::prelude::*;
use dioxus_ipc_bridge::prelude::*;

fn app() -> Element {
    let router = use_signal(|| {
        let mut r = IpcRouter::new();
        r.register("POST", "/greeting", Box::new(GreetingHandler));
        r
    });

    use_effect(move || {
        router.read().start();
    });

    rsx! { /* ... */ }
}

Trait Implementations§

Source§

impl Clone for IpcRouter

Source§

fn clone(&self) -> IpcRouter

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Default for IpcRouter

Source§

fn default() -> IpcRouter

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> InitializeFromFunction<T> for T

Source§

fn initialize_from_function(f: fn() -> T) -> T

Create an instance of this type from an initialization function
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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<Ret> SpawnIfAsync<(), Ret> for Ret

Source§

fn spawn(self) -> Ret

Spawn the value into the dioxus runtime if it is an async block
Source§

impl<T, O> SuperFrom<T> for O
where O: From<T>,

Source§

fn super_from(input: T) -> O

Convert from a type to another type.
Source§

impl<T, O, M> SuperInto<O, M> for T
where O: SuperFrom<T, M>,

Source§

fn super_into(self) -> O

Convert from a type to another type.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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<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