ReadSignal

flams_router_vscode

Struct ReadSignal 

pub struct ReadSignal<T, S = SyncStorage> {
    pub(crate) inner: ArenaItem<ArcReadSignal<T>, S>,
}
Expand description

An arena-allocated getter for a reactive signal.

A signal is a piece of data that may change over time, and notifies other code when it has changed.

This is an arena-allocated signal, which is Copy and is disposed when its reactive Owner cleans up. For a reference-counted signal that lives as long as a reference to it is alive, see ArcReadSignal.

§Core Trait Implementations

  • .get() clones the current value of the signal. If you call it within an effect, it will cause that effect to subscribe to the signal, and to re-run whenever the value of the signal changes.
    • .get_untracked() clones the value of the signal without reactively tracking it.
  • .read() returns a guard that allows accessing the value of the signal by reference. If you call it within an effect, it will cause that effect to subscribe to the signal, and to re-run whenever the value of the signal changes.
    • .read_untracked() gives access to the current value of the signal without reactively tracking it.
  • .with() allows you to reactively access the signal’s value without cloning by applying a callback function.
    • .with_untracked() allows you to access the signal’s value by applying a callback function without reactively tracking it.
  • .to_stream() converts the signal to an async stream of values.
  • ::from_stream() converts an async stream of values into a signal containing the latest value.

§Examples

let (count, set_count) = signal(0);

// calling .get() clones and returns the value
assert_eq!(count.get(), 0);
// calling .read() accesses the value by reference
assert_eq!(count.read(), 0);

Fields§

§inner: ArenaItem<ArcReadSignal<T>, S>

Trait Implementations§

§

impl<V, S> AddAnyAttr for ReadSignal<V, S>
where V: RenderHtml + Clone + Send + Sync + 'static, <V as Render>::State: 'static, ReadSignal<V, S>: Get<Value = V>, S: Storage<V> + Storage<Option<V>> + Send + Sync + 'static,

§

type Output<SomeNewAttr: Attribute> = ReadSignal<V, S>

The new type once the attribute has been added.
§

fn add_any_attr<NewAttr>( self, _attr: NewAttr, ) -> <ReadSignal<V, S> as AddAnyAttr>::Output<NewAttr>
where NewAttr: Attribute,

Adds an attribute to the view.
§

impl<V, S> AttributeValue for ReadSignal<V, S>
where V: AttributeValue + Send + Sync + Clone + 'static, <V as AttributeValue>::State: 'static, ReadSignal<V, S>: Get<Value = V>, S: Storage<V> + Storage<Option<V>> + Send + Sync + 'static,

§

type AsyncOutput = ReadSignal<V, S>

The type once all async data have loaded.
§

type State = RenderEffect<<V as AttributeValue>::State>

The state that should be retained between building and rebuilding.
§

type Cloneable = ReadSignal<V, S>

A version of the value that can be cloned. This can be the same type, or a reference-counted type. Generally speaking, this does not need to refer to the same data, but should behave in the same way. So for example, making an event handler cloneable should probably make it reference-counted (so that a FnMut() continues mutating the same closure), but making a String cloneable does not necessarily need to make it an Arc<str>, as two different clones of a String will still have the same value.
§

type CloneableOwned = ReadSignal<V, S>

A cloneable type that is also 'static. This is used for spreading across types when the spreadable attribute needs to be owned. In some cases (&'a str to Arc<str>, etc.) the owned cloneable type has worse performance than the cloneable type, so they are separate.
§

fn html_len(&self) -> usize

An approximation of the actual length of this attribute in HTML.
§

fn to_html(self, key: &str, buf: &mut String)

Renders the attribute value to HTML.
§

fn to_template(_key: &str, _buf: &mut String)

Renders the attribute value to HTML for a <template>.
§

fn hydrate<const FROM_SERVER: bool>( self, key: &str, el: &Element, ) -> <ReadSignal<V, S> as AttributeValue>::State

Adds interactivity as necessary, given DOM nodes that were created from HTML that has either been rendered on the server, or cloned for a <template>.
§

fn build( self, el: &Element, key: &str, ) -> <ReadSignal<V, S> as AttributeValue>::State

Adds this attribute to the element during client-side rendering.
§

fn rebuild( self, key: &str, state: &mut <ReadSignal<V, S> as AttributeValue>::State, )

Applies a new value for the attribute.
§

fn into_cloneable(self) -> <ReadSignal<V, S> as AttributeValue>::Cloneable

Converts this attribute into an equivalent that can be cloned.
§

fn into_cloneable_owned( self, ) -> <ReadSignal<V, S> as AttributeValue>::CloneableOwned

Converts this attributes into an equivalent that can be cloned and is 'static.
§

fn dry_resolve(&mut self)

“Runs” the attribute without other side effects. For primitive types, this is a no-op. For reactive types, this can be used to gather data about reactivity or about asynchronous data that needs to be loaded.
§

async fn resolve(self) -> <ReadSignal<V, S> as AttributeValue>::AsyncOutput

“Resolves” this into a form that is not waiting for any asynchronous data.
§

impl<T, S> Clone for ReadSignal<T, S>

§

fn clone(&self) -> ReadSignal<T, S>

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
§

impl<T, S> Debug for ReadSignal<T, S>
where S: Debug,

§

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

Formats the value using the given formatter. Read more
§

impl<T, S> DefinedAt for ReadSignal<T, S>

§

fn defined_at(&self) -> Option<&'static Location<'static>>

Returns the location at which the signal was defined. This is usually simply None in release mode.
§

impl<T, S> Dispose for ReadSignal<T, S>

§

fn dispose(self)

Disposes of the signal. This: Read more
§

impl<T> From<ArcReadSignal<T>> for ReadSignal<T>
where T: Send + Sync + 'static,

§

fn from(value: ArcReadSignal<T>) -> ReadSignal<T>

Converts to this type from the input type.
§

impl<T> From<ReadSignal<Option<T>>> for MaybeProp<T>
where T: Send + Sync,

§

fn from(value: ReadSignal<Option<T>>) -> MaybeProp<T>

Converts to this type from the input type.
§

impl<T> From<ReadSignal<Option<T>, LocalStorage>> for MaybeProp<T, LocalStorage>
where T: Send + Sync,

§

fn from( value: ReadSignal<Option<T>, LocalStorage>, ) -> MaybeProp<T, LocalStorage>

Converts to this type from the input type.
§

impl<T> From<ReadSignal<T>> for MaybeProp<T>
where T: Send + Sync + Clone,

§

fn from(value: ReadSignal<T>) -> MaybeProp<T>

Converts to this type from the input type.
§

impl<T> From<ReadSignal<T>> for MaybeSignal<T>
where T: Send + Sync,

§

fn from(value: ReadSignal<T>) -> MaybeSignal<T>

Converts to this type from the input type.
§

impl<T> From<ReadSignal<T>> for OptionalProp<Signal<T>>
where T: Send + Sync + 'static,

§

fn from(value: ReadSignal<T>) -> OptionalProp<Signal<T>>

Converts to this type from the input type.
§

impl<T> From<ReadSignal<T>> for Signal<T>
where T: Send + Sync + 'static,

§

fn from(value: ReadSignal<T>) -> Signal<T>

Converts to this type from the input type.
§

impl<T> From<ReadSignal<T, LocalStorage>> for MaybeProp<T, LocalStorage>
where T: Send + Sync + Clone,

§

fn from(value: ReadSignal<T, LocalStorage>) -> MaybeProp<T, LocalStorage>

Converts to this type from the input type.
§

impl<T> From<ReadSignal<T, LocalStorage>> for MaybeSignal<T, LocalStorage>

§

fn from(value: ReadSignal<T, LocalStorage>) -> MaybeSignal<T, LocalStorage>

Converts to this type from the input type.
§

impl<T> From<ReadSignal<T, LocalStorage>> for Signal<T, LocalStorage>
where T: 'static,

§

fn from(value: ReadSignal<T, LocalStorage>) -> Signal<T, LocalStorage>

Converts to this type from the input type.
§

impl<T, S> From<ReadSignal<T, S>> for ArcReadSignal<T>
where T: 'static, S: Storage<ArcReadSignal<T>>,

§

fn from(value: ReadSignal<T, S>) -> ArcReadSignal<T>

Converts to this type from the input type.
§

impl<T, S> From<ReadSignal<T, S>> for ArcSignal<T, S>
where S: Storage<ArcReadSignal<T>> + Storage<T>,

§

fn from(value: ReadSignal<T, S>) -> ArcSignal<T, S>

Converts to this type from the input type.
§

impl<V, S> From<ReadSignal<V, S>> for TextProp
where V: Into<Oco<'static, str>> + Clone + Send + Sync + 'static, ReadSignal<V, S>: Get<Value = V>, S: Storage<V> + Storage<Option<V>> + Send + Sync + 'static,

§

fn from(s: ReadSignal<V, S>) -> TextProp

Converts to this type from the input type.
§

impl<T> FromLocal<ArcReadSignal<T>> for ReadSignal<T, LocalStorage>
where T: 'static,

§

fn from_local(value: ArcReadSignal<T>) -> ReadSignal<T, LocalStorage>

Converts between the types.
§

impl<T, S> Hash for ReadSignal<T, S>

§

fn hash<H>(&self, state: &mut H)
where H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
§

impl<V, S> InnerHtmlValue for ReadSignal<V, S>
where V: InnerHtmlValue + Clone + Send + Sync + 'static, <V as InnerHtmlValue>::State: 'static, ReadSignal<V, S>: Get<Value = V>, S: Storage<V> + Storage<Option<V>> + Send + Sync + 'static,

§

type AsyncOutput = ReadSignal<V, S>

The type after all async data have resolved.
§

type State = RenderEffect<<V as InnerHtmlValue>::State>

The view state retained between building and rebuilding.
§

type Cloneable = ReadSignal<V, S>

An equivalent value that can be cloned.
§

type CloneableOwned = ReadSignal<V, S>

An equivalent value that can be cloned and is 'static.
§

fn html_len(&self) -> usize

The estimated length of the HTML.
§

fn to_html(self, buf: &mut String)

Renders the class to HTML.
§

fn to_template(_buf: &mut String)

Renders the class to HTML for a <template>.
§

fn hydrate<const FROM_SERVER: bool>( self, el: &Element, ) -> <ReadSignal<V, S> as InnerHtmlValue>::State

Adds interactivity as necessary, given DOM nodes that were created from HTML that has either been rendered on the server, or cloned for a <template>.
§

fn build(self, el: &Element) -> <ReadSignal<V, S> as InnerHtmlValue>::State

Adds this class to the element during client-side rendering.
§

fn rebuild(self, state: &mut <ReadSignal<V, S> as InnerHtmlValue>::State)

Updates the value.
§

fn into_cloneable(self) -> <ReadSignal<V, S> as InnerHtmlValue>::Cloneable

Converts this to a cloneable type.
§

fn into_cloneable_owned( self, ) -> <ReadSignal<V, S> as InnerHtmlValue>::CloneableOwned

Converts this to a cloneable, owned type.
§

fn dry_resolve(&mut self)

“Runs” the attribute without other side effects. For primitive types, this is a no-op. For reactive types, this can be used to gather data about reactivity or about asynchronous data that needs to be loaded.
§

async fn resolve(self) -> <ReadSignal<V, S> as InnerHtmlValue>::AsyncOutput

“Resolves” this into a type that is not waiting for any asynchronous data.
§

impl<V, S> IntoClass for ReadSignal<V, S>
where V: IntoClass + Clone + Send + Sync + 'static, <V as IntoClass>::State: 'static, ReadSignal<V, S>: Get<Value = V>, S: Storage<V> + Storage<Option<V>> + Send + Sync + 'static,

§

type AsyncOutput = ReadSignal<V, S>

The type after all async data have resolved.
§

type State = RenderEffect<<V as IntoClass>::State>

The view state retained between building and rebuilding.
§

type Cloneable = ReadSignal<V, S>

An equivalent value that can be cloned.
§

type CloneableOwned = ReadSignal<V, S>

An equivalent value that can be cloned and is 'static.
§

fn html_len(&self) -> usize

The estimated length of the HTML.
§

fn to_html(self, class: &mut String)

Renders the class to HTML.
§

fn hydrate<const FROM_SERVER: bool>( self, el: &Element, ) -> <ReadSignal<V, S> as IntoClass>::State

Adds interactivity as necessary, given DOM nodes that were created from HTML that has either been rendered on the server, or cloned for a <template>.
§

fn build(self, el: &Element) -> <ReadSignal<V, S> as IntoClass>::State

Adds this class to the element during client-side rendering.
§

fn rebuild(self, state: &mut <ReadSignal<V, S> as IntoClass>::State)

Updates the value.
§

fn into_cloneable(self) -> <ReadSignal<V, S> as IntoClass>::Cloneable

Converts this to a cloneable type.
§

fn into_cloneable_owned(self) -> <ReadSignal<V, S> as IntoClass>::CloneableOwned

Converts this to a cloneable, owned type.
§

fn dry_resolve(&mut self)

“Runs” the attribute without other side effects. For primitive types, this is a no-op. For reactive types, this can be used to gather data about reactivity or about asynchronous data that needs to be loaded.
§

async fn resolve(self) -> <ReadSignal<V, S> as IntoClass>::AsyncOutput

“Resolves” this into a type that is not waiting for any asynchronous data.
§

fn reset(state: &mut <ReadSignal<V, S> as IntoClass>::State)

Reset the class list to the state before this class was added.
§

const TEMPLATE: &'static str = ""

The HTML that should be included in a <template>.
§

const MIN_LENGTH: usize = _

The minimum length of the HTML.
§

fn should_overwrite(&self) -> bool

Whether this class attribute should overwrite previous class values. Returns true for class="..." attributes, false for class:name=value directives.
§

fn to_template(class: &mut String)

Renders the class to HTML for a <template>.
§

impl<T, S> IntoInner for ReadSignal<T, S>
where S: Storage<ArcReadSignal<T>>,

§

type Value = T

The type of the value contained in the signal.
§

fn into_inner(self) -> Option<<ReadSignal<T, S> as IntoInner>::Value>

Returns the inner value if this is the only reference to the signal. Otherwise, returns None and drops this reference. Read more
§

impl<V, S> IntoProperty for ReadSignal<V, S>
where V: IntoProperty + Clone + Send + Sync + 'static, <V as IntoProperty>::State: 'static, ReadSignal<V, S>: Get<Value = V>, S: Storage<V> + Storage<Option<V>> + Send + Sync + 'static,

§

type State = RenderEffect<<V as IntoProperty>::State>

The view state retained between building and rebuilding.
§

type Cloneable = ReadSignal<V, S>

An equivalent value that can be cloned.
§

type CloneableOwned = ReadSignal<V, S>

An equivalent value that can be cloned and is 'static.
§

fn hydrate<const FROM_SERVER: bool>( self, el: &Element, key: &str, ) -> <ReadSignal<V, S> as IntoProperty>::State

Adds the property on an element created from HTML.
§

fn build( self, el: &Element, key: &str, ) -> <ReadSignal<V, S> as IntoProperty>::State

Adds the property during client-side rendering.
§

fn rebuild( self, state: &mut <ReadSignal<V, S> as IntoProperty>::State, key: &str, )

Updates the property with a new value.
§

fn into_cloneable(self) -> <ReadSignal<V, S> as IntoProperty>::Cloneable

Converts this to a cloneable type.
§

fn into_cloneable_owned( self, ) -> <ReadSignal<V, S> as IntoProperty>::CloneableOwned

Converts this to a cloneable, owned type.
§

impl<V, S> IntoStyle for ReadSignal<V, S>
where V: IntoStyle + Clone + Send + Sync + 'static, <V as IntoStyle>::State: 'static, ReadSignal<V, S>: Get<Value = V>, S: Storage<V> + Storage<Option<V>> + Send + Sync + 'static,

§

type AsyncOutput = ReadSignal<V, S>

The type after all async data have resolved.
§

type State = RenderEffect<<V as IntoStyle>::State>

The view state retained between building and rebuilding.
§

type Cloneable = ReadSignal<V, S>

An equivalent value that can be cloned.
§

type CloneableOwned = ReadSignal<V, S>

An equivalent value that can be cloned and is 'static.
§

fn to_html(self, style: &mut String)

Renders the style to HTML.
§

fn hydrate<const FROM_SERVER: bool>( self, el: &Element, ) -> <ReadSignal<V, S> as IntoStyle>::State

Adds interactivity as necessary, given DOM nodes that were created from HTML that has either been rendered on the server, or cloned for a <template>.
§

fn build(self, el: &Element) -> <ReadSignal<V, S> as IntoStyle>::State

Adds this style to the element during client-side rendering.
§

fn rebuild(self, state: &mut <ReadSignal<V, S> as IntoStyle>::State)

Updates the value.
§

fn into_cloneable(self) -> <ReadSignal<V, S> as IntoStyle>::Cloneable

Converts this to a cloneable type.
§

fn into_cloneable_owned(self) -> <ReadSignal<V, S> as IntoStyle>::CloneableOwned

Converts this to a cloneable, owned type.
§

fn dry_resolve(&mut self)

“Runs” the attribute without other side effects. For primitive types, this is a no-op. For reactive types, this can be used to gather data about reactivity or about asynchronous data that needs to be loaded.
§

async fn resolve(self) -> <ReadSignal<V, S> as IntoStyle>::AsyncOutput

“Resolves” this into a type that is not waiting for any asynchronous data.
§

fn reset(state: &mut <ReadSignal<V, S> as IntoStyle>::State)

Reset the styling to the state before this style was added.
§

impl<V, S> IntoStyleValue for ReadSignal<V, S>
where V: IntoStyleValue + Send + Sync + Clone + 'static, ReadSignal<V, S>: Get<Value = V>, S: Storage<V> + Storage<Option<V>> + Send + Sync + 'static,

§

type AsyncOutput = ReadSignal<V, S>

The type after all async data have resolved.
§

type State = (Arc<str>, RenderEffect<<V as IntoStyleValue>::State>)

The view state retained between building and rebuilding.
§

type Cloneable = ReadSignal<V, S>

An equivalent value that can be cloned.
§

type CloneableOwned = ReadSignal<V, S>

An equivalent value that can be cloned and is 'static.
§

fn to_html(self, name: &str, style: &mut String)

Renders the style to HTML.
§

fn build( self, style: &CssStyleDeclaration, name: &str, ) -> <ReadSignal<V, S> as IntoStyleValue>::State

Adds this style to the element during client-side rendering.
§

fn rebuild( self, style: &CssStyleDeclaration, name: &str, state: &mut <ReadSignal<V, S> as IntoStyleValue>::State, )

Updates the value.
§

fn hydrate( self, style: &CssStyleDeclaration, name: &str, ) -> <ReadSignal<V, S> as IntoStyleValue>::State

Adds interactivity as necessary, given DOM nodes that were created from HTML that has either been rendered on the server, or cloned for a <template>.
§

fn into_cloneable(self) -> <ReadSignal<V, S> as IntoStyleValue>::Cloneable

Converts this to a cloneable type.
§

fn into_cloneable_owned( self, ) -> <ReadSignal<V, S> as IntoStyleValue>::CloneableOwned

Converts this to a cloneable, owned type.
§

fn dry_resolve(&mut self)

“Runs” the attribute without other side effects. For primitive types, this is a no-op. For reactive types, this can be used to gather data about reactivity or about asynchronous data that needs to be loaded.
§

async fn resolve(self) -> <ReadSignal<V, S> as IntoStyleValue>::AsyncOutput

“Resolves” this into a type that is not waiting for any asynchronous data.
§

impl<T, S> IsDisposed for ReadSignal<T, S>

§

fn is_disposed(&self) -> bool

If true, the signal cannot be accessed without a panic.
§

impl<T, S> PartialEq for ReadSignal<T, S>

§

fn eq(&self, other: &ReadSignal<T, S>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
§

impl<T, S> ReadUntracked for ReadSignal<T, S>
where T: 'static, S: Storage<ArcReadSignal<T>>,

§

type Value = ReadGuard<T, Plain<T>>

The guard type that will be returned, which can be dereferenced to the value.
§

fn try_read_untracked( &self, ) -> Option<<ReadSignal<T, S> as ReadUntracked>::Value>

Returns the guard, or None if the signal has already been disposed.
§

fn read_untracked(&self) -> Self::Value

Returns the guard. Read more
§

fn custom_try_read(&self) -> Option<Option<Self::Value>>

This is a backdoor to allow overriding the Read::try_read implementation despite it being auto implemented. Read more
§

impl<V, S> Render for ReadSignal<V, S>
where V: Render + Clone + Send + Sync + 'static, <V as Render>::State: 'static, ReadSignal<V, S>: Get<Value = V>, S: Storage<V> + Storage<Option<V>> + Send + Sync + 'static,

§

type State = RenderEffectState<<V as Render>::State>

The “view state” for this type, which can be retained between updates. Read more
§

fn build(self) -> <ReadSignal<V, S> as Render>::State

Creates the view for the first time, without hydrating from existing HTML.
§

fn rebuild(self, state: &mut <ReadSignal<V, S> as Render>::State)

Updates the view with new data.
§

impl<V, S> RenderHtml for ReadSignal<V, S>
where V: RenderHtml + Clone + Send + Sync + 'static, <V as Render>::State: 'static, ReadSignal<V, S>: Get<Value = V>, S: Storage<V> + Storage<Option<V>> + Send + Sync + 'static,

§

const MIN_LENGTH: usize = 0usize

The minimum length of HTML created when this view is rendered.
§

type AsyncOutput = ReadSignal<V, S>

The type of the view after waiting for all asynchronous data to load.
§

type Owned = ReadSignal<V, S>

An equivalent value that is 'static.
§

fn dry_resolve(&mut self)

“Runs” the view without other side effects. For primitive types, this is a no-op. For reactive types, this can be used to gather data about reactivity or about asynchronous data that needs to be loaded.
§

async fn resolve(self) -> <ReadSignal<V, S> as RenderHtml>::AsyncOutput

Waits for any asynchronous sections of the view to load and returns the output.
§

fn html_len(&self) -> usize

An estimated length for this view, when rendered to HTML. Read more
§

fn to_html_with_buf( self, buf: &mut String, position: &mut Position, escape: bool, mark_branches: bool, extra_attrs: Vec<AnyAttribute>, )

Renders a view to HTML, writing it into the given buffer.
§

fn to_html_async_with_buf<const OUT_OF_ORDER: bool>( self, buf: &mut StreamBuilder, position: &mut Position, escape: bool, mark_branches: bool, extra_attrs: Vec<AnyAttribute>, )
where ReadSignal<V, S>: Sized,

Renders a view into a buffer of (synchronous or asynchronous) HTML chunks.
§

fn hydrate<const FROM_SERVER: bool>( self, cursor: &Cursor, position: &PositionState, ) -> <ReadSignal<V, S> as Render>::State

Makes a set of DOM nodes rendered from HTML interactive. Read more
§

fn into_owned(self) -> <ReadSignal<V, S> as RenderHtml>::Owned

Convert into the equivalent value that is 'static.
§

const EXISTS: bool = true

Whether this should actually exist in the DOM, if it is the child of an element.
§

fn to_html(self) -> String
where Self: Sized,

Renders a view to an HTML string.
§

fn to_html_branching(self) -> String
where Self: Sized,

Renders a view to HTML with branch markers. This can be used to support libraries that diff HTML pages against one another, by marking sections of the view that branch to different types with marker comments.
§

fn to_html_stream_in_order(self) -> StreamBuilder
where Self: Sized,

Renders a view to an in-order stream of HTML.
§

fn to_html_stream_in_order_branching(self) -> StreamBuilder
where Self: Sized,

Renders a view to an in-order stream of HTML with branch markers. This can be used to support libraries that diff HTML pages against one another, by marking sections of the view that branch to different types with marker comments.
§

fn to_html_stream_out_of_order(self) -> StreamBuilder
where Self: Sized,

Renders a view to an out-of-order stream of HTML.
§

fn to_html_stream_out_of_order_branching(self) -> StreamBuilder
where Self: Sized,

Renders a view to an out-of-order stream of HTML with branch markers. This can be used to support libraries that diff HTML pages against one another, by marking sections of the view that branch to different types with marker comments.
§

fn hydrate_async( self, cursor: &Cursor, position: &PositionState, ) -> impl Future<Output = Self::State>

Asynchronously makes a set of DOM nodes rendered from HTML interactive. Read more
§

fn hydrate_from<const FROM_SERVER: bool>(self, el: &Element) -> Self::State
where Self: Sized,

Hydrates using RenderHtml::hydrate, beginning at the given element.
§

fn hydrate_from_position<const FROM_SERVER: bool>( self, el: &Element, position: Position, ) -> Self::State
where Self: Sized,

Hydrates using RenderHtml::hydrate, beginning at the given element and position.
§

impl<T, St> Serialize for ReadSignal<T, St>
where T: Serialize + 'static, St: Storage<ArcReadSignal<T>>,

§

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more
§

impl<T, S> Copy for ReadSignal<T, S>

§

impl<T, S> Eq for ReadSignal<T, S>

Auto Trait Implementations§

§

impl<T, S> Freeze for ReadSignal<T, S>

§

impl<T, S> RefUnwindSafe for ReadSignal<T, S>

§

impl<T, S> Send for ReadSignal<T, S>

§

impl<T, S> Sync for ReadSignal<T, S>

§

impl<T, S> Unpin for ReadSignal<T, S>

§

impl<T, S> UnwindSafe for ReadSignal<T, S>

Blanket Implementations§

Source§

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S
where T: Real + Zero + Arithmetics + Clone, Swp: WhitePoint<T>, Dwp: WhitePoint<T>, D: AdaptFrom<S, Swp, Dwp, T>,

Source§

fn adapt_into_using<M>(self, method: M) -> D
where M: TransformMatrix<T>,

Convert the source color to the destination color using the specified method.
Source§

fn adapt_into(self) -> D

Convert the source color to the destination color using the bradford method by default.
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, C> ArraysFrom<C> for T
where C: IntoArrays<T>,

Source§

fn arrays_from(colors: C) -> T

Cast a collection of colors into a collection of arrays.
Source§

impl<T, C> ArraysInto<C> for T
where C: FromArrays<T>,

Source§

fn arrays_into(self) -> C

Cast this collection of arrays into a collection of colors.
§

impl<V, Key, Sig, T> BindAttribute<Key, Sig, T> for V
where V: AddAnyAttr, Key: AttributeKey, Sig: IntoSplitSignal<Value = T>, T: FromEventTarget + AttributeValue + PartialEq + Sync + 'static, Signal<BoolOrT<T>>: IntoProperty, <Sig as IntoSplitSignal>::Read: Get<Value = T> + Send + Sync + Clone + 'static, <Sig as IntoSplitSignal>::Write: Send + Clone + 'static, Element: GetValue<T>,

§

type Output = <V as AddAnyAttr>::Output<Bind<Key, T, <Sig as IntoSplitSignal>::Read, <Sig as IntoSplitSignal>::Write>>

The type of the element with the two-way binding added.
§

fn bind( self, key: Key, signal: Sig, ) -> <V as BindAttribute<Key, Sig, T>>::Output

Adds a two-way binding to the element, which adds an attribute and an event listener to the element when the element is created or hydrated. 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<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for U
where T: FromCam16Unclamped<WpParam, U>,

Source§

type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar

The number type that’s used in parameters when converting.
Source§

fn cam16_into_unclamped( self, parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar>, ) -> T

Converts self into C, using the provided parameters.
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T, C> ComponentsFrom<C> for T
where C: IntoComponents<T>,

Source§

fn components_from(colors: C) -> T

Cast a collection of colors into a collection of color components.
§

impl<T, K, V> CustomAttribute<K, V> for T
where T: AddAnyAttr, K: CustomAttributeKey, V: AttributeValue,

§

fn attr(self, key: K, value: V) -> Self::Output<CustomAttr<K, V>>

Adds an HTML attribute by key and value.
§

impl<V, T, P, D> DirectiveAttribute<T, P, D> for V
where V: AddAnyAttr, D: IntoDirective<T, P>, P: Clone + 'static, T: 'static,

§

type Output = <V as AddAnyAttr>::Output<Directive<T, D, P>>

The type of the element with the directive added.
§

fn directive( self, handler: D, param: P, ) -> <V as DirectiveAttribute<T, P, D>>::Output

Adds a directive to the element, which runs some custom logic in the browser when the element is created or hydrated.
§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSend for T
where T: Any + Send,

§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_sync(self: Box<T>) -> Box<dyn Any + Send + Sync>

Converts Box<Trait> (where Trait: DowncastSync) to Box<dyn Any + Send + Sync>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Converts Arc<Trait> (where Trait: DowncastSync) to Arc<Any>, which can then be downcast into Arc<ConcreteType> where ConcreteType implements Trait.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromAngle<T> for T

Source§

fn from_angle(angle: T) -> T

Performs a conversion from angle.
§

impl<T> FromRef<T> for T
where T: Clone,

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

impl<E, T, Request, Encoding> FromReq<Patch<Encoding>, Request, E> for T
where Request: Req<E> + Send + 'static, Encoding: Decodes<T>, E: FromServerFnError,

§

async fn from_req(req: Request) -> Result<T, E>

Attempts to deserialize the arguments from a request.
§

impl<E, T, Request, Encoding> FromReq<Post<Encoding>, Request, E> for T
where Request: Req<E> + Send + 'static, Encoding: Decodes<T>, E: FromServerFnError,

§

async fn from_req(req: Request) -> Result<T, E>

Attempts to deserialize the arguments from a request.
§

impl<E, T, Request, Encoding> FromReq<Put<Encoding>, Request, E> for T
where Request: Req<E> + Send + 'static, Encoding: Decodes<T>, E: FromServerFnError,

§

async fn from_req(req: Request) -> Result<T, E>

Attempts to deserialize the arguments from a request.
§

impl<E, Encoding, Response, T> FromRes<Patch<Encoding>, Response, E> for T
where Response: ClientRes<E> + Send, Encoding: Decodes<T>, E: FromServerFnError,

§

async fn from_res(res: Response) -> Result<T, E>

Attempts to deserialize the outputs from a response.
§

impl<E, Encoding, Response, T> FromRes<Post<Encoding>, Response, E> for T
where Response: ClientRes<E> + Send, Encoding: Decodes<T>, E: FromServerFnError,

§

async fn from_res(res: Response) -> Result<T, E>

Attempts to deserialize the outputs from a response.
§

impl<E, Encoding, Response, T> FromRes<Put<Encoding>, Response, E> for T
where Response: ClientRes<E> + Send, Encoding: Decodes<T>, E: FromServerFnError,

§

async fn from_res(res: Response) -> Result<T, E>

Attempts to deserialize the outputs from a response.
Source§

impl<T, U> FromStimulus<U> for T
where U: IntoStimulus<T>,

Source§

fn from_stimulus(other: U) -> T

Converts other into Self, while performing the appropriate scaling, rounding and clamping.
§

impl<S, T> FromStream<T> for S
where S: From<ArcReadSignal<Option<T>>> + Send + Sync, T: Send + Sync + 'static,

§

fn from_stream(stream: impl Stream<Item = T> + Send + 'static) -> S

Creates a signal that contains the latest value of the stream.
§

fn from_stream_unsync(stream: impl Stream<Item = T> + 'static) -> S

Creates a signal that contains the latest value of the stream.
§

impl<T> Instrument for T

§

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

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

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, U> IntoAngle<U> for T
where U: FromAngle<T>,

Source§

fn into_angle(self) -> U

Performs a conversion into T.
§

impl<T> IntoAny for T
where T: Send + RenderHtml,

§

fn into_any(self) -> AnyView

Converts the view into a type-erased AnyView.
§

impl<T> IntoAttributeValue for T
where T: AttributeValue,

§

type Output = T

The attribute value into which this type can be converted.
§

fn into_attribute_value(self) -> <T as IntoAttributeValue>::Output

Consumes this value, transforming it into an attribute value.
Source§

impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for U
where T: Cam16FromUnclamped<WpParam, U>,

Source§

type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar

The number type that’s used in parameters when converting.
Source§

fn into_cam16_unclamped( self, parameters: BakedParameters<WpParam, <U as IntoCam16Unclamped<WpParam, T>>::Scalar>, ) -> T

Converts self into C, using the provided parameters.
Source§

impl<T, U> IntoColor<U> for T
where U: FromColor<T>,

Source§

fn into_color(self) -> U

Convert into T with values clamped to the color defined bounds Read more
Source§

impl<T, U> IntoColorUnclamped<U> for T
where U: FromColorUnclamped<T>,

Source§

fn into_color_unclamped(self) -> U

Convert into T. The resulting color might be invalid in its color space Read more
Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> IntoMaybeErased for T
where T: RenderHtml,

§

type Output = T

The type of the output.
§

fn into_maybe_erased(self) -> <T as IntoMaybeErased>::Output

Converts the view into a type-erased view if in erased mode.
§

impl<T, S> IntoOptionGetter<T, SignalMarker> for S
where S: Get<Value = Option<T>> + Clone + Send + Sync + 'static,

§

fn into_option_getter(self) -> OptionGetter<T>

Converts the given value into an OptionGetter.
§

impl<T, I> IntoReactiveValue<T, __IntoReactiveValueMarkerBaseCase> for I
where I: Into<T>,

§

fn into_reactive_value(self) -> T

Converts self into a T.
§

impl<T> IntoRender for T
where T: Render,

§

type Output = T

The renderable type into which this type can be converted.
§

fn into_render(self) -> <T as IntoRender>::Output

Consumes this value, transforming it into the renderable type.
§

impl<E, T, Request> IntoReq<DeleteUrl, Request, E> for T
where Request: ClientReq<E>, T: Serialize + Send, E: FromServerFnError,

§

fn into_req(self, path: &str, accepts: &str) -> Result<Request, E>

Attempts to serialize the arguments into an HTTP request.
§

impl<E, T, Request> IntoReq<GetUrl, Request, E> for T
where Request: ClientReq<E>, T: Serialize + Send, E: FromServerFnError,

§

fn into_req(self, path: &str, accepts: &str) -> Result<Request, E>

Attempts to serialize the arguments into an HTTP request.
§

impl<E, T, Encoding, Request> IntoReq<Patch<Encoding>, Request, E> for T
where Request: ClientReq<E>, Encoding: Encodes<T>, E: FromServerFnError,

§

fn into_req(self, path: &str, accepts: &str) -> Result<Request, E>

Attempts to serialize the arguments into an HTTP request.
§

impl<E, T, Request> IntoReq<PatchUrl, Request, E> for T
where Request: ClientReq<E>, T: Serialize + Send, E: FromServerFnError,

§

fn into_req(self, path: &str, accepts: &str) -> Result<Request, E>

Attempts to serialize the arguments into an HTTP request.
§

impl<E, T, Encoding, Request> IntoReq<Post<Encoding>, Request, E> for T
where Request: ClientReq<E>, Encoding: Encodes<T>, E: FromServerFnError,

§

fn into_req(self, path: &str, accepts: &str) -> Result<Request, E>

Attempts to serialize the arguments into an HTTP request.
§

impl<E, T, Request> IntoReq<PostUrl, Request, E> for T
where Request: ClientReq<E>, T: Serialize + Send, E: FromServerFnError,

§

fn into_req(self, path: &str, accepts: &str) -> Result<Request, E>

Attempts to serialize the arguments into an HTTP request.
§

impl<E, T, Encoding, Request> IntoReq<Put<Encoding>, Request, E> for T
where Request: ClientReq<E>, Encoding: Encodes<T>, E: FromServerFnError,

§

fn into_req(self, path: &str, accepts: &str) -> Result<Request, E>

Attempts to serialize the arguments into an HTTP request.
§

impl<E, T, Request> IntoReq<PutUrl, Request, E> for T
where Request: ClientReq<E>, T: Serialize + Send, E: FromServerFnError,

§

fn into_req(self, path: &str, accepts: &str) -> Result<Request, E>

Attempts to serialize the arguments into an HTTP request.
§

impl<E, Response, Encoding, T> IntoRes<Patch<Encoding>, Response, E> for T
where Response: TryRes<E>, Encoding: Encodes<T>, E: FromServerFnError + Send, T: Send,

§

async fn into_res(self) -> Result<Response, E>

Attempts to serialize the output into an HTTP response.
§

impl<E, Response, Encoding, T> IntoRes<Post<Encoding>, Response, E> for T
where Response: TryRes<E>, Encoding: Encodes<T>, E: FromServerFnError + Send, T: Send,

§

async fn into_res(self) -> Result<Response, E>

Attempts to serialize the output into an HTTP response.
§

impl<E, Response, Encoding, T> IntoRes<Put<Encoding>, Response, E> for T
where Response: TryRes<E>, Encoding: Encodes<T>, E: FromServerFnError + Send, T: Send,

§

async fn into_res(self) -> Result<Response, E>

Attempts to serialize the output into an HTTP response.
Source§

impl<T> IntoStimulus<T> for T

Source§

fn into_stimulus(self) -> T

Converts self into T, while performing the appropriate scaling, rounding and clamping.
§

impl<T> IntoView for T
where T: Render + RenderHtml + Send,

§

fn into_view(self) -> View<T>

Wraps the inner type.
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
§

impl<T> ReactiveNode for T
where T: AsSubscriberSet + DefinedAt,

§

fn mark_dirty(&self)

Notifies the source’s dependencies that it has changed.
§

fn mark_check(&self)

Notifies the source’s dependencies that it may have changed.
§

fn mark_subscribers_check(&self)

Marks that all subscribers need to be checked.
§

fn update_if_necessary(&self) -> bool

Regenerates the value for this node, if needed, and returns whether it has actually changed or not.
§

impl<T> Read for T
where T: Track + ReadUntracked,

§

type Value = <T as ReadUntracked>::Value

The guard type that will be returned, which can be dereferenced to the value.
§

fn try_read(&self) -> Option<<T as Read>::Value>

Subscribes to the signal, and returns the guard, or None if the signal has already been disposed.
§

fn read(&self) -> Self::Value

Subscribes to the signal, and returns the guard. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> SerializableKey for T

§

fn ser_key(&self) -> String

Serializes the key to a unique string. Read more
§

impl<T> Source for T
where T: AsSubscriberSet + DefinedAt,

§

fn clear_subscribers(&self)

Remove all subscribers from this source’s list of dependencies.
§

fn add_subscriber(&self, subscriber: AnySubscriber)

Adds a subscriber to this source’s list of dependencies.
§

fn remove_subscriber(&self, subscriber: &AnySubscriber)

Removes a subscriber from this source’s list of dependencies.
§

impl<T> StorageAccess<T> for T

§

fn as_borrowed(&self) -> &T

Borrows the value.
§

fn into_taken(self) -> T

Takes the value.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T> Track for T
where T: Source + ToAnySource + DefinedAt,

§

fn track(&self)

Subscribes to this signal in the current reactive scope without doing anything with its value.
Source§

impl<T, C> TryComponentsInto<C> for T
where C: TryFromComponents<T>,

Source§

type Error = <C as TryFromComponents<T>>::Error

The error for when try_into_colors fails to cast.
Source§

fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>

Try to cast this collection of color components into a collection of colors. Read more
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, U> TryIntoColor<U> for T
where U: TryFromColor<T>,

Source§

fn try_into_color(self) -> Result<U, OutOfBounds<U>>

Convert into T, returning ok if the color is inside of its defined range, otherwise an OutOfBounds error is returned which contains the unclamped color. Read more
Source§

impl<C, U> UintsFrom<C> for U
where C: IntoUints<U>,

Source§

fn uints_from(colors: C) -> U

Cast a collection of colors into a collection of unsigned integers.
Source§

impl<C, U> UintsInto<C> for U
where C: FromUints<U>,

Source§

fn uints_into(self) -> C

Cast this collection of unsigned integers into a collection of colors.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> With for T
where T: Read,

§

type Value = <<T as Read>::Value as Deref>::Target

The type of the value contained in the signal.
§

fn try_with<U>(&self, fun: impl FnOnce(&<T as With>::Value) -> U) -> Option<U>

Subscribes to the signal, applies the closure to the value, and returns the result, or None if the signal has already been disposed.
§

fn with<U>(&self, fun: impl FnOnce(&Self::Value) -> U) -> U

Subscribes to the signal, applies the closure to the value, and returns the result. Read more
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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

impl<T> WithUntracked for T
where T: DefinedAt + ReadUntracked,

§

type Value = <<T as ReadUntracked>::Value as Deref>::Target

The type of the value contained in the signal.
§

fn try_with_untracked<U>( &self, fun: impl FnOnce(&<T as WithUntracked>::Value) -> U, ) -> Option<U>

Applies the closure to the value, and returns the result, or None if the signal has already been disposed.
§

fn with_untracked<U>(&self, fun: impl FnOnce(&Self::Value) -> U) -> U

Applies the closure to the value, and returns the result. Read more
Source§

impl<T> CondSerialize for T
where T: Serialize,

§

impl<T> Fruit for T
where T: Send + Downcast,