Enum SsrMode

Source

pub enum SsrMode {
    OutOfOrder,
    PartiallyBlocked,
    InOrder,
    Async,
    Static(StaticRoute),
}

Expand description

Indicates which rendering mode should be used for this route during server-side rendering.

Leptos supports the following ways of rendering HTML that contains async data loaded under <Suspense/>.

Synchronous (use any mode except Async, don’t depend on any resource): Serve an HTML shell that includes fallback for any Suspense. Load data on the client (using create_local_resource), replacing fallback once they’re loaded.
- Pros: App shell appears very quickly: great TTFB (time to first byte).
- Cons: Resources load relatively slowly; you need to wait for JS + Wasm to load before even making a request.
Out-of-order streaming (OutOfOrder, the default): Serve an HTML shell that includes fallback for any Suspense. Load data on the server, streaming it down to the client as it resolves, and streaming down HTML for Suspense nodes.
- Pros: Combines the best of synchronous and Async, with a very fast shell and resources that begin loading on the server.
- Cons: Requires JS for suspended fragments to appear in correct order. Weaker meta tag support when it depends on data that’s under suspense (has already streamed down <head>)
Partially-blocked out-of-order streaming (PartiallyBlocked): Using create_blocking_resource with out-of-order streaming still sends fallbacks and relies on JavaScript to fill them in with the fragments. Partially-blocked streaming does this replacement on the server, making for a slower response but requiring no JavaScript to show blocking resources.
- Pros: Works better if JS is disabled.
- Cons: Slower initial response because of additional string manipulation on server.
In-order streaming (InOrder): Walk through the tree, returning HTML synchronously as in synchronous rendering and out-of-order streaming until you hit a Suspense. At that point, wait for all its data to load, then render it, then the rest of the tree.
- Pros: Does not require JS for HTML to appear in correct order.
- Cons: Loads the shell more slowly than out-of-order streaming or synchronous rendering because it needs to pause at every Suspense. Cannot begin hydration until the entire page has loaded, so earlier pieces of the page will not be interactive until the suspended chunks have loaded.
Async: Load all resources on the server. Wait until all data are loaded, and render HTML in one sweep.
- Pros: Better handling for meta tags (because you know async data even before you render the <head>). Faster complete load than synchronous because async resources begin loading on server.
- Cons: Slower load time/TTFB: you need to wait for all async resources to load before displaying anything on the client.
Static: Renders the page when the server starts up, or incrementally, using the configuration provided by a StaticRoute.

The mode defaults to out-of-order streaming. For a path that includes multiple nested routes, the most restrictive mode will be used: i.e., if even a single nested route asks for Async rendering, the whole initial request will be rendered Async. (Async is the most restricted requirement, followed by InOrder, PartiallyBlocked, and OutOfOrder.)

Variants§

§

OutOfOrder

Out-of-order streaming (OutOfOrder, the default): Serve an HTML shell that includes fallback for any Suspense. Load data on the server, streaming it down to the client as it resolves, and streaming down HTML for Suspense nodes. - Pros: Combines the best of synchronous and Async, with a very fast shell and resources that begin loading on the server. - Cons: Requires JS for suspended fragments to appear in correct order. Weaker meta tag support when it depends on data that’s under suspense (has already streamed down <head>)

§

PartiallyBlocked

Partially-blocked out-of-order streaming (PartiallyBlocked): Using create_blocking_resource with out-of-order streaming still sends fallbacks and relies on JavaScript to fill them in with the fragments. Partially-blocked streaming does this replacement on the server, making for a slower response but requiring no JavaScript to show blocking resources. - Pros: Works better if JS is disabled. - Cons: Slower initial response because of additional string manipulation on server.

§

InOrder

In-order streaming (InOrder): Walk through the tree, returning HTML synchronously as in synchronous rendering and out-of-order streaming until you hit a Suspense. At that point, wait for all its data to load, then render it, then the rest of the tree. - Pros: Does not require JS for HTML to appear in correct order. - Cons: Loads the shell more slowly than out-of-order streaming or synchronous rendering because it needs to pause at every Suspense. Cannot begin hydration until the entire page has loaded, so earlier pieces of the page will not be interactive until the suspended chunks have loaded.

§

Async

Async: Load all resources on the server. Wait until all data are loaded, and render HTML in one sweep.

Pros: Better handling for meta tags (because you know async data even before you render the <head>). Faster complete load than synchronous because async resources begin loading on server.
Cons: Slower load time/TTFB: you need to wait for all async resources to load before displaying anything on the client.

§

Static(StaticRoute)

Static: Renders the page when the server starts up, or incrementally, using the configuration provided by a StaticRoute.

SsrMode

Enum SsrMode Copy item path

Variants§

OutOfOrder

PartiallyBlocked

InOrder

Async

Static(StaticRoute)

Trait Implementations§

impl Clone for SsrMode

fn clone(&self) -> SsrMode

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

impl Debug for SsrMode

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

impl Default for SsrMode

fn default() -> SsrMode

impl Ord for SsrMode

fn cmp(&self, other: &SsrMode) -> Ordering

fn max(self, other: Self) -> Selfwhere Self: Sized,

fn min(self, other: Self) -> Selfwhere Self: Sized,

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized,

impl PartialEq for SsrMode

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

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

impl PartialOrd for SsrMode

fn partial_cmp(&self, other: &SsrMode) -> Option<Ordering>

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

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

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

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

impl Eq for SsrMode

impl StructuralPartialEq for SsrMode

Auto Trait Implementations§

impl Freeze for SsrMode

impl !RefUnwindSafe for SsrMode

impl Send for SsrMode

impl Sync for SsrMode

impl Unpin for SsrMode

impl UnsafeUnpin for SsrMode

impl !UnwindSafe for SsrMode

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> CloneToUninit for Twhere T: Clone,

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

impl<Q, K> Comparable<K> for Qwhere Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

fn compare(&self, key: &K) -> Ordering

impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

impl<T> From<T> for T

fn from(t: T) -> T

impl<E, T, Request, Encoding> FromReq<Patch<Encoding>, Request, E> for Twhere Request: Req<E> + Send + 'static, Encoding: Decodes<T>, E: FromServerFnError,

async fn from_req(req: Request) -> Result<T, E>

impl<E, T, Request, Encoding> FromReq<Post<Encoding>, Request, E> for Twhere Request: Req<E> + Send + 'static, Encoding: Decodes<T>, E: FromServerFnError,

async fn from_req(req: Request) -> Result<T, E>

impl<E, T, Request, Encoding> FromReq<Put<Encoding>, Request, E> for Twhere Request: Req<E> + Send + 'static, Encoding: Decodes<T>, E: FromServerFnError,

async fn from_req(req: Request) -> Result<T, E>

impl<E, Encoding, Response, T> FromRes<Patch<Encoding>, Response, E> for Twhere Response: ClientRes<E> + Send, Encoding: Decodes<T>, E: FromServerFnError,

async fn from_res(res: Response) -> Result<T, E>

impl<E, Encoding, Response, T> FromRes<Post<Encoding>, Response, E> for Twhere Response: ClientRes<E> + Send, Encoding: Decodes<T>, E: FromServerFnError,

async fn from_res(res: Response) -> Result<T, E>

impl<E, Encoding, Response, T> FromRes<Put<Encoding>, Response, E> for Twhere Response: ClientRes<E> + Send, Encoding: Decodes<T>, E: FromServerFnError,

async fn from_res(res: Response) -> Result<T, E>

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>where F: FnOnce(&Self) -> bool,

impl<E, T, Encoding, Request> IntoReq<Patch<Encoding>, Request, E> for Twhere Request: ClientReq<E>, Encoding: Encodes<T>, E: FromServerFnError,

fn into_req(self, path: &str, accepts: &str) -> Result<Request, E>

impl<E, T, Encoding, Request> IntoReq<Post<Encoding>, Request, E> for Twhere Request: ClientReq<E>, Encoding: Encodes<T>, E: FromServerFnError,

Enum SsrMode

fn max(self, other: Self) -> Self
where Self: Sized,

fn min(self, other: Self) -> Self
where Self: Sized,

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

impl<T> Any for T
where T: 'static + ?Sized,

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

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

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

impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

impl<E, T, Request, Encoding> FromReq<Patch<Encoding>, Request, E> for T
where Request: Req<E> + Send + 'static, Encoding: Decodes<T>, E: FromServerFnError,

impl<E, T, Request, Encoding> FromReq<Post<Encoding>, Request, E> for T
where Request: Req<E> + Send + 'static, Encoding: Decodes<T>, E: FromServerFnError,

impl<E, T, Request, Encoding> FromReq<Put<Encoding>, Request, E> for T
where Request: Req<E> + Send + 'static, Encoding: Decodes<T>, E: FromServerFnError,

impl<E, Encoding, Response, T> FromRes<Patch<Encoding>, Response, E> for T
where Response: ClientRes<E> + Send, Encoding: Decodes<T>, E: FromServerFnError,

impl<E, Encoding, Response, T> FromRes<Post<Encoding>, Response, E> for T
where Response: ClientRes<E> + Send, Encoding: Decodes<T>, E: FromServerFnError,

impl<E, Encoding, Response, T> FromRes<Put<Encoding>, Response, E> for T
where Response: ClientRes<E> + Send, Encoding: Decodes<T>, E: FromServerFnError,

impl<T, U> Into<U> for T
where U: From<T>,

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

impl<E, T, Encoding, Request> IntoReq<Patch<Encoding>, Request, E> for T
where Request: ClientReq<E>, Encoding: Encodes<T>, E: FromServerFnError,

impl<E, T, Encoding, Request> IntoReq<Post<Encoding>, Request, E> for T
where Request: ClientReq<E>, Encoding: Encodes<T>, E: FromServerFnError,

impl<E, T, Encoding, Request> IntoReq<Put<Encoding>, Request, E> for T
where Request: ClientReq<E>, Encoding: Encodes<T>, E: FromServerFnError,

impl<E, Response, Encoding, T> IntoRes<Patch<Encoding>, Response, E> for T
where Response: TryRes<E>, Encoding: Encodes<T>, E: FromServerFnError + Send, T: Send,

impl<E, Response, Encoding, T> IntoRes<Post<Encoding>, Response, E> for T
where Response: TryRes<E>, Encoding: Encodes<T>, E: FromServerFnError + Send, T: Send,

impl<E, Response, Encoding, T> IntoRes<Put<Encoding>, Response, E> for T
where Response: TryRes<E>, Encoding: Encodes<T>, E: FromServerFnError + Send, T: Send,

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

impl<T, U> TryFrom<U> for T
where U: Into<T>,

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,