palette::convert

Struct FromColorMutGuard

source 
pub struct FromColorMutGuard<'a, T, U>
where
    T: FromColorMut<U> + ?Sized,
    U: FromColorMut<T> + ?Sized,
{ /* private fields */ }
Expand description

A scope guard that restores the guarded colors to their original type when dropped.

Implementations§

source§

impl<'a, T, U> FromColorMutGuard<'a, T, U>
where T: FromColorMut<U> + ?Sized, U: FromColorMut<T> + ?Sized,

source

pub fn then_into_color_mut<C>(self) -> FromColorMutGuard<'a, C, U>
where T: FromColorMut<C>, C: FromColorMut<U> + FromColorMut<T> + ?Sized, U: FromColorMut<C>,

Convert the colors to another type and replace this guard.

The colors will not be converted back to the current color type before being restored, as opposed to when into_color_mut is called. Instead, they are restored directly to their original type.

source

pub fn then_into_color_unclamped_mut<C>( self, ) -> FromColorUnclampedMutGuard<'a, C, U>
where T: FromColorUnclampedMut<C>, C: FromColorUnclampedMut<U> + FromColorUnclampedMut<T> + ?Sized, U: FromColorUnclampedMut<C>,

Convert the colors to another type, without clamping, and replace this guard.

The colors will not be converted back to the current color type before being restored, as opposed to when into_color_unclamped_mut is called. Instead, they are restored directly to their original type.

source

pub fn into_unclamped_guard(self) -> FromColorUnclampedMutGuard<'a, T, U>
where T: FromColorUnclampedMut<U>, U: FromColorUnclampedMut<T>,

Replace this guard with a guard that does not clamp the colors after restoring.

source

pub fn restore(self) -> &'a mut U

Immediately restore the colors to their original type.

This happens automatically when the guard is dropped, but there may be situations where it’s better or more convenient to call restore directly.

Trait Implementations§

source§

impl<'a, T, U> Deref for FromColorMutGuard<'a, T, U>
where T: FromColorMut<U> + ?Sized, U: FromColorMut<T> + ?Sized,

source§

type Target = T

The resulting type after dereferencing.
source§

fn deref(&self) -> &Self::Target

Dereferences the value.
source§

impl<'a, T, U> DerefMut for FromColorMutGuard<'a, T, U>
where T: FromColorMut<U> + ?Sized, U: FromColorMut<T> + ?Sized,

source§

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.
source§

impl<'a, T, U> Drop for FromColorMutGuard<'a, T, U>
where T: FromColorMut<U> + ?Sized, U: FromColorMut<T> + ?Sized,

source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl<'a, T, U> Freeze for FromColorMutGuard<'a, T, U>
where T: ?Sized, U: ?Sized,

§

impl<'a, T, U> RefUnwindSafe for FromColorMutGuard<'a, T, U>
where T: RefUnwindSafe + ?Sized, U: RefUnwindSafe + ?Sized,

§

impl<'a, T, U> Send for FromColorMutGuard<'a, T, U>
where T: Send + ?Sized, U: Send + ?Sized,

§

impl<'a, T, U> Sync for FromColorMutGuard<'a, T, U>
where T: Sync + ?Sized, U: Sync + ?Sized,

§

impl<'a, T, U> Unpin for FromColorMutGuard<'a, T, U>
where T: ?Sized, U: ?Sized,

§

impl<'a, T, U> !UnwindSafe for FromColorMutGuard<'a, T, U>

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