Struct palette::convert::FromColorMutGuard

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

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

Implementations

impl<'a, T, U> FromColorMutGuard<'a, T, U>

where T: FromColorMut<U> + ?Sized, U: FromColorMut<T> + ?Sized,

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.

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.

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.

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

impl<'a, T, U> Deref for FromColorMutGuard<'a, T, U>

where T: FromColorMut<U> + ?Sized, U: FromColorMut<T> + ?Sized,

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a, T, U> DerefMut for FromColorMutGuard<'a, T, U>

where T: FromColorMut<U> + ?Sized, U: FromColorMut<T> + ?Sized,

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

Mutably dereferences the value.

impl<'a, T, U> Drop for FromColorMutGuard<'a, T, U>

where T: FromColorMut<U> + ?Sized, U: FromColorMut<T> + ?Sized,

fn drop(&mut self)

Executes the destructor for this type.