Struct Renderer

pub struct Renderer { /* private fields */ }

The main tree rendering engine.

Renderer is responsible for converting tree node structures into styled text output. It handles complex features like:

• Multi-line content with proper indentation
• Custom enumerators and indenters
• Style inheritance and override resolution
• Alignment of custom enumerators
• Branch continuation across container nodes

Examples

use lipgloss_tree::{Renderer, Children};
use lipgloss_tree::renderer::TreeStyle;
use lipgloss::Style;

let renderer = Renderer::new()
    .style(TreeStyle::default())
    .enumerator(|children, i| {
        if i == children.length() - 1 { "└──".to_string() }
        else { "├──".to_string() }
    });

Implementations

impl Renderer

pub fn new() -> Self

Creates a new renderer with default configuration.

The default renderer uses:

• Standard box-drawing characters for branches (├──, └──)
• Standard indentation (│ for continuing, spaces for last)
• Default styling with padding after enumerators

Examples

use lipgloss_tree::Renderer;

let renderer = Renderer::new();

pub fn style(self, style: TreeStyle) -> Self

Sets the styling configuration for this renderer.

This replaces the entire TreeStyle, affecting how enumerators, items, and the root are styled.

Arguments

• style - The new TreeStyle configuration to use

Examples

use lipgloss_tree::Renderer;
use lipgloss_tree::renderer::TreeStyle;
use lipgloss::Style;

let custom_style = TreeStyle {
    root: Style::new().bold(true),
    ..TreeStyle::default()
};

let renderer = Renderer::new().style(custom_style);

pub fn enumerator(self, enumerator: Enumerator) -> Self

Sets the enumerator function for this renderer.

The enumerator function generates the branch characters (like ├──, └──) based on the child’s position in its parent’s children collection.

Arguments

• enumerator - Function that takes (children, index) and returns a string

Examples

use lipgloss_tree::{Renderer, Children};

let renderer = Renderer::new()
    .enumerator(|children, i| {
        if i == children.length() - 1 {
            "╰──".to_string()  // Rounded last branch
        } else {
            "├──".to_string()  // Standard continuing branch
        }
    });

pub fn indenter(self, indenter: Indenter) -> Self

Sets the indenter function for this renderer.

The indenter function generates indentation strings for child content that appears below parent nodes, providing the visual connection between parent and nested children.

Arguments

• indenter - Function that takes (children, index) and returns indentation string

Examples

use lipgloss_tree::{Renderer, Children};

let renderer = Renderer::new()
    .indenter(|children, i| {
        if i == children.length() - 1 {
            "    ".to_string()  // Spaces for last child
        } else {
            "│   ".to_string()  // Vertical line for continuing
        }
    });

pub fn render(&self, node: &dyn Node, root: bool, prefix: &str) -> String

Renders a tree node and its children to a formatted string.

This is the main rendering method that converts a tree structure into styled text output. It handles complex scenarios like multi-line content, style inheritance, custom enumerators, and proper indentation.

Arguments

• node - The tree node to render
• root - Whether this is the root node (affects root style application)
• prefix - String prefix to prepend to each line (for nested rendering)

Returns

A formatted string representation of the tree with proper styling and indentation

Examples

use lipgloss_tree::{Renderer, Tree};

let tree = Tree::new()
    .root("My Tree")
    .child(vec!["Item 1".into(), "Item 2".into()]);

let renderer = Renderer::new();
let output = renderer.render(&tree, true, "");
println!("{}", output);

Trait Implementations

impl Clone for Renderer

fn clone(&self) -> Renderer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Renderer

fn default() -> Self

Returns the “default value” for a type.