dioxus_ssr::renderer

Struct Renderer

Source
pub struct Renderer {
    pub pre_render: bool,
    /* private fields */
}
Expand description

A virtualdom renderer that caches the templates it has seen for faster rendering

Fields§

§pre_render: bool

Choose to write ElementIDs into elements so the page can be re-hydrated later on

Implementations§

Source§

impl Renderer

Source

pub fn new() -> Self

Source

pub fn set_render_components( &mut self, callback: impl Fn(&mut Renderer, &mut dyn Write, &VirtualDom, ScopeId) -> Result + Send + Sync + 'static, )

Set the callback that the renderer uses to render components

Source

pub fn reset_render_components(&mut self)

Reset the callback that the renderer uses to render components

Source

pub fn render(&mut self, dom: &VirtualDom) -> String

Source

pub fn render_to<W: Write + ?Sized>( &mut self, buf: &mut W, dom: &VirtualDom, ) -> Result

Source

pub fn render_element(&mut self, element: Element) -> String

Render an element to a string

Source

pub fn render_element_to<W: Write + ?Sized>( &mut self, buf: &mut W, element: Element, ) -> Result

Render an element to the buffer

Source

pub fn reset_hydration(&mut self)

Reset the renderer hydration state

Source

pub fn render_scope<W: Write + ?Sized>( &mut self, buf: &mut W, dom: &VirtualDom, scope: ScopeId, ) -> Result

Trait Implementations§

Source§

impl Default for Renderer

Source§

fn default() -> Renderer

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

Auto Trait Implementations§

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<Ret> SpawnIfAsync<(), Ret> for Ret

Source§

fn spawn(self) -> Ret

Spawn the value into the dioxus runtime if it is an async block
Source§

impl<T, O> SuperFrom<T> for O
where O: From<T>,

Source§

fn super_from(input: T) -> O

Convert from a type to another type.
Source§

impl<T, O, M> SuperInto<O, M> for T
where O: SuperFrom<T, M>,

Source§

fn super_into(self) -> O

Convert from a type to another type.
Source§

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

Source§

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>,

Source§

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