Skip to main content

BuildContext

Struct BuildContext 

Source
pub struct BuildContext { /* private fields */ }
Expand description

A scoped build context. Cloning a context keeps the same consumer identity; BuildContext::for_consumer creates a distinct dependency owner.

Implementations§

Source§

impl BuildContext

Source

pub fn new() -> Self

Creates an empty root context with a fresh dependency consumer.

Source

pub fn for_consumer(consumer: ConsumerId) -> Self

Creates an empty root context for a caller-owned consumer identity.

Creates another dependency owner that observes the same retained inherited environment and shares this context’s dependency tracker.

Source

pub fn boundary_for_consumer(&self, consumer: ConsumerId) -> Self

Creates an explicit inherited lookup boundary for another consumer. Values above this point are not visible, while dependency invalidation remains in the same retained-tree tracker.

Source

pub const fn consumer_id(&self) -> ConsumerId

Returns the identity used for dependency invalidation.

Source

pub fn child(&self) -> Self

Creates a child environment. Values in the child shadow values in its parent while keeping the same dependency tracker and consumer.

Source

pub fn provide<T: Any>(&self, value: T) -> Self

Creates a child context with one inherited value.

Source

pub fn insert<T: Any>(&self, value: T) -> bool

Inserts or replaces a value in this environment. Existing consumers that watched this type are marked dirty when the value changes.

Source

pub fn set<T: Any + PartialEq>(&self, value: T) -> bool

Replaces a value only when its PartialEq value changed.

Source

pub fn remove<T: Any>(&self) -> bool

Removes a value from this environment.

Source

pub fn contains<T: Any>(&self) -> bool

Source

pub fn revision(&self) -> u64

Source

pub fn read<T: Any + Clone>(&self) -> Option<T>

Reads an inherited value without recording a dependency.

Source

pub fn get<T: Any + Clone>(&self) -> Option<T>

Alias for BuildContext::read.

Source

pub fn read_shared<T: Any>(&self) -> Option<Rc<T>>

Reads an inherited value as shared ownership without recording a dependency.

Source

pub fn depend<T: Any + Clone>(&self) -> Option<T>

Reads a value and records the environment lookup as a dependency.

Source

pub fn depend_shared<T: Any>(&self) -> Option<Rc<T>>

Reads a shared inherited value while recording the dependency without cloning the value itself.

Source

pub fn watch<T: Any + Clone>(&self) -> Option<T>

Alias for BuildContext::depend, matching reactive UI terminology.

Source

pub fn enter(&self) -> ContextGuard

Enters this context as the active build scope. Signal reads made while the guard is alive are associated with this context’s consumer.

Source

pub fn scope(&self) -> ContextGuard

Source

pub fn build<R>(&self, callback: impl FnOnce(&BuildContext) -> R) -> R

Clears old dependencies, enters the build scope, and invokes the callback. This is the normal runtime integration point.

Source

pub fn run<R>(&self, callback: impl FnOnce() -> R) -> R

Runs a closure in a fresh dependency collection. Use BuildContext::build when the callback needs the context as an argument.

Source

pub fn with_context<R>(&self, callback: impl FnOnce(&BuildContext) -> R) -> R

Source

pub fn clear_dependencies(&self)

Source

pub fn dependency_count(&self) -> usize

Source

pub fn is_dirty(&self) -> bool

Source

pub fn take_dirty(&self) -> bool

Takes and clears this consumer’s invalidation bit.

Source

pub fn dependencies(&self) -> DependencySnapshot

Trait Implementations§

Source§

impl Clone for BuildContext

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 Debug for BuildContext

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for BuildContext

Source§

fn default() -> Self

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

Auto Trait Implementations§

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

👎Deprecated since 0.7.7:

replaced by palette::chromatic_adaptation::AdaptIntoUnclamped

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

fn adapt_into(self) -> D

👎Deprecated since 0.7.7:

replaced by palette::chromatic_adaptation::AdaptIntoUnclamped

Convert the source color to the destination color using the bradford method by default.
Source§

impl<T, C> AdaptIntoUnclamped<T> for C
where T: AdaptFromUnclamped<C>,

Source§

type Scalar = <T as AdaptFromUnclamped<C>>::Scalar

The number type that’s used as the color’s components.
Source§

fn adapt_into_unclamped_with<M>(self) -> T

Adapt a color of type Self into a color of type T, using the custom matrix M. Read more
Source§

fn adapt_into_unclamped(self) -> T
where Bradford: LmsToXyz<Self::Scalar> + XyzToLms<Self::Scalar>,

Adapt a color of type Self into a color of type T, using the Bradford matrix. Read more
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.
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.
Source§

impl<T, C> ComponentsInto<C> for T

Source§

fn components_into(self) -> C

Cast this collection of color components into a collection of colors. 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.
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.
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.
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> IntoStimulus<T> for T

Source§

fn into_stimulus(self) -> T

Converts self into T, while performing the appropriate scaling, rounding and clamping.
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, 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 = !

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