Struct yew::LocalServerRenderer

pub struct LocalServerRenderer<COMP>where
    COMP: BaseComponent,{ /* private fields */ }

Available on crate feature ssr only.

A Yew Server-side Renderer that renders on the current thread.

Note

This renderer does not spawn its own runtime and can only be used when:

• wasm-bindgen-futures is selected as the backend of Yew runtime.
• running within a Runtime.
• running within a tokio LocalSet.

Implementations

impl<COMP> LocalServerRenderer<COMP>where
    COMP: BaseComponent,
    COMP::Properties: Default,

pub fn new() -> Self

Creates a LocalServerRenderer with default properties.

impl<COMP> LocalServerRenderer<COMP>where
    COMP: BaseComponent,

pub fn with_props(props: COMP::Properties) -> Self

Creates a LocalServerRenderer with custom properties.

pub fn hydratable(self, val: bool) -> Self

Sets whether an the rendered result is hydratable.

Defaults to true.

When this is sets to true, the rendered artifact will include additional information to assist with the hydration process.

pub async fn render(self) -> String

Renders Yew Application.

pub async fn render_to_string(self, w: &mut String)

Renders Yew Application to a String.

pub fn render_stream(self) -> impl Stream<Item = String>

Renders Yew Application into a string Stream

Trait Implementations

impl<COMP: Debug> Debug for LocalServerRenderer<COMP>where
    COMP: BaseComponent,
    COMP::Properties: Debug,

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

Formats the value using the given formatter.

impl<COMP> Default for LocalServerRenderer<COMP>where
    COMP: BaseComponent,
    COMP::Properties: Default,

fn default() -> Self

Returns the “default value” for a type.