Skip to main content

CellBuilder

Struct CellBuilder 

Source
pub struct CellBuilder<S: State = Empty> { /* private fields */ }
Expand description

Use builder syntax to set the inputs and finish with build().

Implementations§

Source§

impl<S: State> CellBuilder<S>

Source

pub fn build(self) -> Cell
where S: IsComplete,

Finish building and return the requested object

Source

pub fn character(self, value: char) -> CellBuilder<SetCharacter<S>>
where S::Character: IsUnset,

Required.

The cell’s character.

Source

pub fn coordinates(self, value: (u32, u32)) -> CellBuilder<SetCoordinates<S>>
where S::Coordinates: IsUnset,

Required.

The coordinates of the cell. [0, 0] is in the top-left.

Source

pub fn bg(self, value: Colour) -> CellBuilder<SetBg<S>>
where S::Bg: IsUnset,

Optional (Some / Option setters). An optional colour for the cell’s background. If None (or null in the case of JSON) is used then the terminal’s default background colour will be used.

Source

pub fn maybe_bg(self, value: Option<Colour>) -> CellBuilder<SetBg<S>>
where S::Bg: IsUnset,

Optional (Some / Option setters). An optional colour for the cell’s background. If None (or null in the case of JSON) is used then the terminal’s default background colour will be used.

Source

pub fn fg(self, value: Colour) -> CellBuilder<SetFg<S>>
where S::Fg: IsUnset,

Optional (Some / Option setters). An optional colour for the cell’s foreground. If None (or null in the case of JSON) is used then the terminal’s default foreground colour will be used.

Source

pub fn maybe_fg(self, value: Option<Colour>) -> CellBuilder<SetFg<S>>
where S::Fg: IsUnset,

Optional (Some / Option setters). An optional colour for the cell’s foreground. If None (or null in the case of JSON) is used then the terminal’s default foreground colour will be used.

Auto Trait Implementations§

§

impl<S> Freeze for CellBuilder<S>

§

impl<S> RefUnwindSafe for CellBuilder<S>

§

impl<S> Send for CellBuilder<S>

§

impl<S> Sync for CellBuilder<S>

§

impl<S> Unpin for CellBuilder<S>

§

impl<S> UnsafeUnpin for CellBuilder<S>

§

impl<S> UnwindSafe for CellBuilder<S>

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