Struct ProtectedRoute 

pub struct ProtectedRoute {
    _marker: PhantomData<()>,
    function_component: FunctionComponent<Self>,
}

A component that protects routes by enforcing authentication and optional administrator privileges.

This component uses the backend’s validation middleware by fetching the current user’s authentication and admin status from the /api/users/current endpoint (which requires a valid JWT token). Based on the AuthState and the admin_page property, it either renders its children or redirects the user.

Behavior

• Initial Load: Displays “Loading…” while checking authentication status via the backend.
• Not Authenticated: Redirects to the login page (crate::Route::Login).
• Authenticated (valid JWT token from backend):
  • If admin_page is true:
    • If the user is an administrator (is_admin: Some(true)), it renders children.
    • If the user is not an administrator (is_admin: Some(false)), it redirects to the permission denied page (crate::Route::PermissionDenied).
    • If admin status is still being checked (is_admin: None), it displays “Checking permissions…”.
  • If admin_page is false: It renders children directly, as only authentication is required.

Example Usage

html! {
    <ProtectedRoute admin_page={true}>
        <AdminDashboard />
    </ProtectedRoute>
}

Fields

_marker: PhantomData<()>

function_component: FunctionComponent<Self>

Trait Implementations

impl BaseComponent for ProtectedRoute

where Self: 'static,

type Message = ()

The Component’s Message.

type Properties = ProtectedRouteProps

The Component’s Properties.

fn create(ctx: &Context<Self>) -> Self

Creates a component.

fn update(&mut self, _ctx: &Context<Self>, _msg: Self::Message) -> bool

Updates component’s internal state.

fn changed( &mut self, _ctx: &Context<Self>, _old_props: &Self::Properties, ) -> bool

React to changes of component properties.

fn view(&self, ctx: &Context<Self>) -> HtmlResult

Returns a component layout to be rendered.

fn rendered(&mut self, _ctx: &Context<Self>, _first_render: bool)

Notified after a layout is rendered.

fn destroy(&mut self, _ctx: &Context<Self>)

Notified before a component is destroyed.

fn prepare_state(&self) -> Option<String>

Prepares the server-side state.

impl Debug for ProtectedRoute

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

Formats the value using the given formatter.

impl FunctionProvider for ProtectedRoute

type Properties = ProtectedRouteProps

Properties for the Function Component.

fn run(ctx: &mut HookContext, props: &Self::Properties) -> HtmlResult

Render the component. This function returns the Html to be rendered for the component.