Skip to main content

Aisling

Struct Aisling 

Source
pub struct Aisling<W> { /* private fields */ }
Expand description

Wraps any Scrin widget with an Aisling post-render effect.

Implementations§

Source§

impl<W> Aisling<W>

Source

pub fn new(inner: W) -> Self

Creates an effect wrapper around any Scrin widget.

Source

pub fn effect(self, effect: AislingEffect) -> Self

Replaces the effect used by the wrapper.

Source

pub fn tick(self, tick: u64) -> Self

Sets the animation tick.

Source

pub fn palette(self, palette: AislingPalette) -> Self

Sets the palette.

Source

pub fn intensity(self, intensity: u16) -> Self

Sets effect strength on a 0..=10 scale.

Trait Implementations§

Source§

impl<W: Clone> Clone for Aisling<W>

Source§

fn clone(&self) -> Aisling<W>

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<W: Debug> Debug for Aisling<W>

Source§

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

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

impl<W: Eq> Eq for Aisling<W>

Source§

impl<W: PartialEq> PartialEq for Aisling<W>

Source§

fn eq(&self, other: &Aisling<W>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<W: PartialEq> StructuralPartialEq for Aisling<W>

Source§

impl<W: Widget> Widget for Aisling<W>

Source§

fn render(&self, buf: &mut Buffer, area: Rect)

Auto Trait Implementations§

§

impl<W> Freeze for Aisling<W>
where W: Freeze,

§

impl<W> RefUnwindSafe for Aisling<W>
where W: RefUnwindSafe,

§

impl<W> Send for Aisling<W>
where W: Send,

§

impl<W> Sync for Aisling<W>
where W: Sync,

§

impl<W> Unpin for Aisling<W>
where W: Unpin,

§

impl<W> UnsafeUnpin for Aisling<W>
where W: UnsafeUnpin,

§

impl<W> UnwindSafe for Aisling<W>
where W: UnwindSafe,

Blanket Implementations§

Source§

impl<W> AislingExt for W
where W: Widget,

Source§

fn aisling(self) -> Aisling<Self>

Decorates this widget with the default Aisling effect.
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<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 = 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.