Struct StaticCompositionLocal 

pub struct StaticCompositionLocal<T: Clone + 'static> { /* private fields */ }

A composition local for values that rarely change, as Jetpack Compose’s staticCompositionLocalOf. A read of .current() subscribes nothing, so it costs less than a read of a CompositionLocal. In return, a provider whose value changes recomposes everything it provides to, not only the readers: every composable call under it runs its body, and every subcomposition under it composes again the same way.

Implementations

impl<T: Clone + 'static> StaticCompositionLocal<T>

pub fn provides(&self, value: T) -> ProvidedValue

Pairs this local with value for use in CompositionLocalProvider. When a later composition provides a different value, everything under the provider recomposes.

pub fn provides_computed( &self, compute: impl Fn(&CompositionLocalAccessorScope) -> T + 'static, ) -> ProvidedValue

Pairs this local with compute, which runs at each read of the local under the provider and reads other locals there through its scope. Each composition of the provider gives a new computation, which recomposes everything under it. Compose’s providesComputed.

pub fn current(&self) -> T

Returns the value from the innermost enclosing provider, or the default value when none is in scope. Must be called during composition. A read subscribes nothing.

pub fn default_value(&self) -> T

Returns the value that current gives where no provider is in scope.

Trait Implementations

impl<T: Clone + Clone + 'static> Clone for StaticCompositionLocal<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Clone + 'static> Eq for StaticCompositionLocal<T>

impl<T: Clone + 'static> PartialEq for StaticCompositionLocal<T>

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<T: Clone + 'static> ReadableCompositionLocal<T> for StaticCompositionLocal<T>

fn read_current(&self) -> T

The local’s value where it is read, as current gives it.