Struct RenderEffect

pub struct RenderEffect<T>
where
    T: 'static,
{ /* private fields */ }

A render effect is similar to an Effect, but with two key differences:

1. Its first run takes place immediately and synchronously: for example, if it is being used to drive a user interface, it will run during rendering, not on the next tick after rendering. (Hence “render effect.”)
2. It is canceled when the RenderEffect itself is dropped, rather than being stored in the reactive system and canceled when the Owner cleans up.

Unless you are implementing a rendering framework, or require one of these two characteristics, it is unlikely you will use render effects directly.

Like an Effect, a render effect runs only with the effects feature enabled.

Implementations

impl<T> RenderEffect<T>

where T: 'static,

pub fn new(fun: impl FnMut(Option<T>) -> T + 'static) -> RenderEffect<T>

Creates a new render effect, which immediately runs fun.

pub fn new_with_value( fun: impl FnMut(Option<T>) -> T + 'static, initial_value: Option<T>, ) -> RenderEffect<T>

Creates a new render effect with an initial value.

pub fn with_value_mut<U>(&self, fun: impl FnOnce(&mut T) -> U) -> Option<U>

Mutably accesses the current value.

pub fn take_value(&self) -> Option<T>

Takes the current value, replacing it with None.

impl<T> RenderEffect<T>

where T: Send + Sync + 'static,

pub fn new_isomorphic( fun: impl FnMut(Option<T>) -> T + Send + Sync + 'static, ) -> RenderEffect<T>

Creates a render effect that will run whether the effects feature is enabled or not.

Trait Implementations

impl<T> Debug for RenderEffect<T>

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

Formats the value using the given formatter.

impl<T> From<RenderEffect<T>> for RenderEffectState<T>

fn from(value: RenderEffect<T>) -> RenderEffectState<T>

Converts to this type from the input type.

impl<M> Mountable for RenderEffect<M>

where M: Mountable + 'static,

fn unmount(&mut self)

Detaches the view from the DOM.

fn mount(&mut self, parent: &Element, marker: Option<&Node>)

Mounts a node to the interface.

fn insert_before_this(&self, child: &mut dyn Mountable) -> bool

Inserts another Mountable type before this one. Returns false if this does not actually exist in the UI (for example, ()).

fn insert_before_this_or_marker( &self, parent: &Element, child: &mut dyn Mountable, marker: Option<&Node>, )

Inserts another Mountable type before this one, or before the marker if this one doesn’t exist in the UI (for example, ()).

impl<T> ToAnySubscriber for RenderEffect<T>

fn to_any_subscriber(&self) -> AnySubscriber

Converts this type to its type-erased equivalent.