Struct FixedWidth 

pub struct FixedWidth<E> { /* private fields */ }

An element that pads or truncates its contents to a constant width.

Implementations

impl<E> FixedWidth<E>

pub fn new(width: usize, content: E) -> Self

Creates a new FixedWidth with the specified width and content.

pub fn truncated(self, truncate: Direction) -> Self

Changes the side on which the content is truncated.

This option only takes effect if the content is wider than the width.

Examples found in repository

examples/input.rs (line 24)

fn main() -> std::io::Result<()> {
    let stdout = std::io::stdout().into_raw_mode()?;
    let mut r = Renderer::new(stdout);

    let mut name = String::new();

    let mut events = std::io::stdin().events();
    loop {
        r.clear()?;
        r.render((
            "Enter your name: ".into_element(),
            (name.into_element(), Cursor, Gap(1))
                .fixed_width(20)
                .truncated(Direction::Left)
                .with_style(Style::bg(240)),
        ))?;
        r.finish()?;

        let Some(event) = events.next().transpose()? else {
            break;
        };
        match event {
            Event::Key(Key::Char(ch)) if !ch.is_ascii_control() => name.push(ch),
            Event::Key(Key::Char('\n' | '\r')) => break,
            Event::Key(Key::Backspace) => {
                name.pop();
            }
            _ => {}
        }
    }

    r.clear()?;
    drop(r);
    println!("Your name is {name:?}");
    Ok(())
}

pub fn padded(self, pad: Direction) -> Self

Changes the side on which padding is added.

This option only takes effect if the content is narrower than the width.

Trait Implementations

impl<E: Clone> Clone for FixedWidth<E>

fn clone(&self) -> FixedWidth<E>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<E: Debug> Debug for FixedWidth<E>

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

Formats the value using the given formatter.

impl<E: Element> Element for FixedWidth<E>

fn width(&self) -> usize

The width of the element, in columns.

fn render(&self) -> impl DoubleEndedIterator<Item = RenderChunk<'_>>

Renders the element into a sequence of chunks.