Struct ServerRenderer

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

Available on crate feature ssr only.

A Yew Server-side Renderer.

This renderer spawns the rendering task to a Yew Runtime. and receives result when the rendering process has finished.

See yew::platform for more information.

Implementations

impl<COMP> ServerRenderer<COMP>

where COMP: BaseComponent, COMP::Properties: Default,

pub fn new() -> Self

Creates a ServerRenderer with default properties.

impl<COMP> ServerRenderer<COMP>

where COMP: BaseComponent,

pub fn with_props<F>(create_props: F) -> Self

where F: 'static + Send + FnOnce() -> COMP::Properties,

Creates a ServerRenderer with custom properties.

Note

The properties does not have to implement Send. However, the function to create properties needs to be Send.

pub fn with_runtime(self, rt: Runtime) -> Self

Sets the runtime the ServerRenderer will run the rendering task with.

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 Send + Stream<Item = String>

Renders Yew Application into a string Stream.

Trait Implementations

impl<COMP> Debug for ServerRenderer<COMP>

where COMP: BaseComponent,

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

Formats the value using the given formatter.

impl<COMP> Default for ServerRenderer<COMP>

where COMP: BaseComponent, COMP::Properties: Default,

fn default() -> Self

Returns the “default value” for a type.