Skip to main content

CompositionLocal

Struct CompositionLocal 

Source
pub struct CompositionLocal<T: Clone + 'static> { /* private fields */ }
Expand description

A value that composables read from their surroundings without passing it as a parameter, as Jetpack Compose’s compositionLocalOf. A scope that reads current recomposes when the provided value changes.

Implementations§

Source§

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

Source

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

Pairs this local with value for use in CompositionLocalProvider. When a later composition provides a different value, the scopes that read the local recompose.

Source

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. The reading scope recomposes when the provided value changes.

Source

pub fn default_value(&self) -> T

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

Trait Implementations§

Source§

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

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

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

Source§

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

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

Auto Trait Implementations§

§

impl<T> !RefUnwindSafe for CompositionLocal<T>

§

impl<T> !Send for CompositionLocal<T>

§

impl<T> !Sync for CompositionLocal<T>

§

impl<T> !UnwindSafe for CompositionLocal<T>

§

impl<T> Freeze for CompositionLocal<T>
where Rc<dyn Fn() -> T>: Freeze, Arc<dyn Fn(&T, &T) -> bool + Sync + Send>: Freeze,

§

impl<T> Unpin for CompositionLocal<T>
where Rc<dyn Fn() -> T>: Unpin, Arc<dyn Fn(&T, &T) -> bool + Sync + Send>: Unpin,

§

impl<T> UnsafeUnpin for CompositionLocal<T>
where Rc<dyn Fn() -> T>: UnsafeUnpin, Arc<dyn Fn(&T, &T) -> bool + Sync + Send>: UnsafeUnpin,

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> 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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

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

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.