Skip to main content

Banner

Struct Banner 

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

A rendered ASCII-art banner.

Banner is a lazy line iterator (per FR-053) from the caller’s perspective: row buffers are computed once during Figlet::render, and each call to next() on the iterator returned by Banner::lines yields one row.

Banner also implements core::fmt::Display; write!(stdout, "{banner}") drives the same lazy iterator and emits a trailing \n after the final line.

use rusty_figlet::{FigletBuilder, Font};

let banner = FigletBuilder::new()
    .font(Font::Standard)
    .build()
    .expect("build")
    .render("X")
    .expect("render");
// Iterate lazily; each .next() yields exactly one rendered row.
let mut it = banner.lines();
let _first = it.next();

Implementations§

Source§

impl Banner

Source

pub fn lines(&self) -> impl Iterator<Item = String> + '_

Return a lazy iterator yielding one rendered line per .next().

Source

pub fn height(&self) -> u32

The font’s row count (height). Library callers occasionally want to know how many rows a banner contains without iterating.

Source

pub fn is_empty(&self) -> bool

true when the banner produced no rendered rows (empty input).

Trait Implementations§

Source§

impl Clone for Banner

Source§

fn clone(&self) -> Banner

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 Debug for Banner

Source§

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

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

impl Display for Banner

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> 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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.