Trait IntoElement

Source

pub trait IntoElement: Sized {
    type ElementType: Element;

    // Required method
    fn into_element(self) -> Self::ElementType;

    // Provided methods
    fn fixed_width(self, width: usize) -> FixedWidth<Self::ElementType> { ... }
    fn with_style(self, style: Style) -> Styled<Self::ElementType> { ... }
}

Expand description

A type that can be converted into an element.

Required Associated Types§

Source

type ElementType: Element

The element type to be converted into.

Required Methods§

Source

fn into_element(self) -> Self::ElementType

Converts this type into an Element.

Provided Methods§

Source

fn fixed_width(self, width: usize) -> FixedWidth<Self::ElementType>

Convenience function to wrap this element in a FixedWidth.

Examples found in repository ?

examples/input.rs (line 23)

11fn main() -> std::io::Result<()> {
12    let stdout = std::io::stdout().into_raw_mode()?;
13    let mut r = Renderer::new(stdout);
14
15    let mut name = String::new();
16
17    let mut events = std::io::stdin().events();
18    loop {
19        r.clear()?;
20        r.render((
21            "Enter your name: ".into_element(),
22            (name.into_element(), Cursor, Gap(1))
23                .fixed_width(20)
24                .truncated(Direction::Left)
25                .with_style(Style::bg(240)),
26        ))?;
27        r.finish()?;
28
29        let Some(event) = events.next().transpose()? else {
30            break;
31        };
32        match event {
33            Event::Key(Key::Char(ch)) if !ch.is_ascii_control() => name.push(ch),
34            Event::Key(Key::Char('\n' | '\r')) => break,
35            Event::Key(Key::Backspace) => {
36                name.pop();
37            }
38            _ => {}
39        }
40    }
41
42    r.clear()?;
43    drop(r);
44    println!("Your name is {name:?}");
45    Ok(())
46}

Source

fn with_style(self, style: Style) -> Styled<Self::ElementType>

Convenience function to wrap this element in a Styled.

Examples found in repository ?

examples/input.rs (line 25)

11fn main() -> std::io::Result<()> {
12    let stdout = std::io::stdout().into_raw_mode()?;
13    let mut r = Renderer::new(stdout);
14
15    let mut name = String::new();
16
17    let mut events = std::io::stdin().events();
18    loop {
19        r.clear()?;
20        r.render((
21            "Enter your name: ".into_element(),
22            (name.into_element(), Cursor, Gap(1))
23                .fixed_width(20)
24                .truncated(Direction::Left)
25                .with_style(Style::bg(240)),
26        ))?;
27        r.finish()?;
28
29        let Some(event) = events.next().transpose()? else {
30            break;
31        };
32        match event {
33            Event::Key(Key::Char(ch)) if !ch.is_ascii_control() => name.push(ch),
34            Event::Key(Key::Char('\n' | '\r')) => break,
35            Event::Key(Key::Backspace) => {
36                name.pop();
37            }
38            _ => {}
39        }
40    }
41
42    r.clear()?;
43    drop(r);
44    println!("Your name is {name:?}");
45    Ok(())
46}