Skip to main content

Recipe

libshimmer

Struct Recipe 

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

A stock animation: its picker entry, what it needs of a host, and how to start its shader.

Implementations§

Source§

impl Recipe

Source

pub fn name(&self) -> &'static str

The name a picker shows, unique among recipes.

Source

pub fn blurb(&self) -> &'static str

One line on what the recipe paints.

Source

pub fn credit(&self) -> &'static str

The recipe’s author.

Source

pub fn needs(&self) -> Glyphs

The repertoires the recipe paints beyond the base set.

Source

pub fn wide(&self) -> bool

Whether the recipe paints graphemes two cells wide well.

Source

pub fn fits<G: Gauge>(&self, glyphs: Glyphs) -> Result<(), Unfit>

Whether a shimmer of gauge G can run the recipe on a terminal that draws glyphs.

§Errors

Unfit when the terminal lacks glyphs the recipe needs, or when G is wide and the recipe paints only narrow graphemes.

Trait Implementations§

Source§

impl Debug for Recipe

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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> 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. 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.