Struct List 

pub struct List { /* private fields */ }

A bulleted or ordered list.

Implementations

impl List

pub fn new() -> Self

Creates an empty bulleted list.

Examples found in repository

examples/output_gallery.rs (line 139)

fn lists_and_trees() -> Result<()> {
    section("Lists & trees")?;
    List::ordered(Marker::Number)
        .item("First step")
        .item_with("Second step", List::new().item("detail a").item("detail b"))
        .item("Third step")
        .print()?;
    println!();
    List::ordered(Marker::AlphaLower)
        .item("alpha")
        .item("beta")
        .print()?;
    List::ordered(Marker::RomanUpper)
        .item("one")
        .item("two")
        .print()?;
    println!();
    Tree::new()
        .node(
            TreeNode::new("project")
                .child(TreeNode::new("src").child(TreeNode::new("main.rs")))
                .child(TreeNode::new("Cargo.toml")),
        )
        .print()?;
    Ok(())
}

pub fn ordered(marker: Marker) -> Self

Creates an empty list with the given marker style.

Ordered markers default to a . suffix.

Examples found in repository

examples/output_gallery.rs (line 137)

fn lists_and_trees() -> Result<()> {
    section("Lists & trees")?;
    List::ordered(Marker::Number)
        .item("First step")
        .item_with("Second step", List::new().item("detail a").item("detail b"))
        .item("Third step")
        .print()?;
    println!();
    List::ordered(Marker::AlphaLower)
        .item("alpha")
        .item("beta")
        .print()?;
    List::ordered(Marker::RomanUpper)
        .item("one")
        .item("two")
        .print()?;
    println!();
    Tree::new()
        .node(
            TreeNode::new("project")
                .child(TreeNode::new("src").child(TreeNode::new("main.rs")))
                .child(TreeNode::new("Cargo.toml")),
        )
        .print()?;
    Ok(())
}

examples/output-readme.rs (line 117)

fn middle_column() -> Rendered {
    let list = List::ordered(Marker::Number)
        .marker_style(Style::new().fg(Color::Yellow).bold())
        .item("Compose widgets side by side")
        .item("Capture, pad, and align them")
        .item("Style with Rich-style markup")
        .item("Render to any UTF-8 terminal")
        .render(36);

    let tree = Tree::new()
        .dashes(2)
        .connector_style(Style::new().fg(Color::Cyan))
        .node(
            TreeNode::new("project/")
                .child(
                    TreeNode::new("api/")
                        .child(TreeNode::new("routes.c"))
                        .child(TreeNode::new("auth.c")),
                )
                .child(TreeNode::new("worker.c"))
                .child(TreeNode::new("store.c")),
        )
        .render(18);

    let rules = vstack(
        &[
            rule("Pipeline", BorderType::Single, Color::Magenta),
            blank(),
            rule("Workers", BorderType::Double, Color::Green),
            blank(),
            rule("Storage", BorderType::Thick, Color::Yellow),
            blank(),
        ],
        0,
    );

    let tree_and_rules = Columns::new()
        .add_rendered(tree)
        .add_rendered(rules)
        .gap(2)
        .render(40);

    vstack(&[list, blank(), tree_and_rules], 0)
}

pub fn item(self, content: impl Into<Text>) -> Self

Adds a leaf item.

Examples found in repository

examples/output_gallery.rs (line 138)

fn lists_and_trees() -> Result<()> {
    section("Lists & trees")?;
    List::ordered(Marker::Number)
        .item("First step")
        .item_with("Second step", List::new().item("detail a").item("detail b"))
        .item("Third step")
        .print()?;
    println!();
    List::ordered(Marker::AlphaLower)
        .item("alpha")
        .item("beta")
        .print()?;
    List::ordered(Marker::RomanUpper)
        .item("one")
        .item("two")
        .print()?;
    println!();
    Tree::new()
        .node(
            TreeNode::new("project")
                .child(TreeNode::new("src").child(TreeNode::new("main.rs")))
                .child(TreeNode::new("Cargo.toml")),
        )
        .print()?;
    Ok(())
}

examples/output-readme.rs (line 119)

fn middle_column() -> Rendered {
    let list = List::ordered(Marker::Number)
        .marker_style(Style::new().fg(Color::Yellow).bold())
        .item("Compose widgets side by side")
        .item("Capture, pad, and align them")
        .item("Style with Rich-style markup")
        .item("Render to any UTF-8 terminal")
        .render(36);

    let tree = Tree::new()
        .dashes(2)
        .connector_style(Style::new().fg(Color::Cyan))
        .node(
            TreeNode::new("project/")
                .child(
                    TreeNode::new("api/")
                        .child(TreeNode::new("routes.c"))
                        .child(TreeNode::new("auth.c")),
                )
                .child(TreeNode::new("worker.c"))
                .child(TreeNode::new("store.c")),
        )
        .render(18);

    let rules = vstack(
        &[
            rule("Pipeline", BorderType::Single, Color::Magenta),
            blank(),
            rule("Workers", BorderType::Double, Color::Green),
            blank(),
            rule("Storage", BorderType::Thick, Color::Yellow),
            blank(),
        ],
        0,
    );

    let tree_and_rules = Columns::new()
        .add_rendered(tree)
        .add_rendered(rules)
        .gap(2)
        .render(40);

    vstack(&[list, blank(), tree_and_rules], 0)
}

pub fn item_with(self, content: impl Into<Text>, children: List) -> Self

Adds an item with a nested sub-list.

Examples found in repository

examples/output_gallery.rs (line 139)

fn lists_and_trees() -> Result<()> {
    section("Lists & trees")?;
    List::ordered(Marker::Number)
        .item("First step")
        .item_with("Second step", List::new().item("detail a").item("detail b"))
        .item("Third step")
        .print()?;
    println!();
    List::ordered(Marker::AlphaLower)
        .item("alpha")
        .item("beta")
        .print()?;
    List::ordered(Marker::RomanUpper)
        .item("one")
        .item("two")
        .print()?;
    println!();
    Tree::new()
        .node(
            TreeNode::new("project")
                .child(TreeNode::new("src").child(TreeNode::new("main.rs")))
                .child(TreeNode::new("Cargo.toml")),
        )
        .print()?;
    Ok(())
}

pub fn bullet(self, glyph: impl Into<String>) -> Self

Sets a custom bullet glyph (bullet marker only).

pub fn marker_style(self, style: Style) -> Self

Sets the marker style.

Examples found in repository

examples/output-readme.rs (line 118)

fn middle_column() -> Rendered {
    let list = List::ordered(Marker::Number)
        .marker_style(Style::new().fg(Color::Yellow).bold())
        .item("Compose widgets side by side")
        .item("Capture, pad, and align them")
        .item("Style with Rich-style markup")
        .item("Render to any UTF-8 terminal")
        .render(36);

    let tree = Tree::new()
        .dashes(2)
        .connector_style(Style::new().fg(Color::Cyan))
        .node(
            TreeNode::new("project/")
                .child(
                    TreeNode::new("api/")
                        .child(TreeNode::new("routes.c"))
                        .child(TreeNode::new("auth.c")),
                )
                .child(TreeNode::new("worker.c"))
                .child(TreeNode::new("store.c")),
        )
        .render(18);

    let rules = vstack(
        &[
            rule("Pipeline", BorderType::Single, Color::Magenta),
            blank(),
            rule("Workers", BorderType::Double, Color::Green),
            blank(),
            rule("Storage", BorderType::Thick, Color::Yellow),
            blank(),
        ],
        0,
    );

    let tree_and_rules = Columns::new()
        .add_rendered(tree)
        .add_rendered(rules)
        .gap(2)
        .render(40);

    vstack(&[list, blank(), tree_and_rules], 0)
}

pub fn indent(self, indent: u16) -> Self

Sets the left indent in columns.

pub fn item_gap(self, gap: u16) -> Self

Sets the number of blank lines between items.

pub fn margin(self, margin: Edges) -> Self

Sets the outer margin.

Trait Implementations

impl Default for List

fn default() -> Self

Returns the “default value” for a type.

impl Renderable for List

fn render(&self, _max_width: u16) -> Rendered

Lays the value out for a terminal at most max_width columns wide.

fn print(&self) -> Result<()>

Renders at the current terminal width and prints to standard output.

fn print_to<W: Write>(&self, writer: &mut W) -> Result<()>

Renders at the current terminal width and writes to writer.