Struct leptos_router::RouteListing

pub struct RouteListing { /* private fields */ }

A route that this application can serve.

Implementations

impl RouteListing

pub fn new( path: impl ToString, leptos_path: impl ToString, mode: SsrMode, methods: impl IntoIterator<Item = Method>, static_mode: Option<StaticMode>, ) -> Self

Create a route listing from its parts.

pub fn path(&self) -> &str

The path this route handles.

This should be formatted for whichever web server integegration is being used. (ex: leptos-actix.) When returned from leptos-router, it matches self.leptos_path().

pub fn leptos_path(&self) -> &str

The leptos-formatted path this route handles.

pub fn mode(&self) -> SsrMode

The rendering mode for this path.

pub fn methods(&self) -> impl Iterator<Item = Method> + '_

The HTTP request methods this path can handle.

pub fn static_mode(&self) -> Option<StaticMode>

Whether this route is statically rendered.

pub async fn build_static<IV>( &self, options: &LeptosOptions, app_fn: impl Fn() -> IV + Send + 'static + Clone, additional_context: impl Fn() + Send + 'static + Clone, params: &StaticParamsMap, ) -> Result<bool, Error>

where IV: IntoView + 'static,

Build a route statically, will return Ok(true) on success or Ok(false) when the route is not marked as statically rendered. All route parameters to use when resolving all paths to render should be passed in the params argument.

Trait Implementations

impl Clone for RouteListing

fn clone(&self) -> RouteListing

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RouteListing

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

Formats the value using the given formatter.

impl Default for RouteListing

fn default() -> RouteListing

Returns the “default value” for a type.

impl PartialEq for RouteListing

fn eq(&self, other: &RouteListing) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for RouteListing

impl StructuralPartialEq for RouteListing