pub struct LocalServerRenderer<COMP>
where COMP: BaseComponent,
{ /* private fields */ }
Available on crate feature ssr only.
Expand description

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§

source§

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

source

pub fn new() -> Self

Creates a LocalServerRenderer with default properties.

source§

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

source

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

Creates a LocalServerRenderer with custom properties.

source

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.

source

pub async fn render(self) -> String

Renders Yew Application.

source

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

Renders Yew Application to a String.

source

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

Renders Yew Application into a string Stream

Trait Implementations§

source§

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

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<COMP> RefUnwindSafe for LocalServerRenderer<COMP>

§

impl<COMP> Send for LocalServerRenderer<COMP>
where <COMP as BaseComponent>::Properties: Send,

§

impl<COMP> Sync for LocalServerRenderer<COMP>
where <COMP as BaseComponent>::Properties: Sync,

§

impl<COMP> Unpin for LocalServerRenderer<COMP>
where <COMP as BaseComponent>::Properties: Unpin,

§

impl<COMP> UnwindSafe for LocalServerRenderer<COMP>

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

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

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

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

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoPropValue<Option<T>> for T

source§

fn into_prop_value(self) -> Option<T>

Convert self to a value of a Properties struct.
source§

impl<T> IntoPropValue<T> for T

source§

fn into_prop_value(self) -> T

Convert self to a value of a Properties struct.
source§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

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

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

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

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more