Struct Graphics 

#[non_exhaustive]
pub struct Graphics {
    pub horizontal: char,
    pub vertical: char,
    pub junction: char,
    pub tip: char,
    pub end: char,
}

Character set used for drawing tree graphics in the terminal.

Each tree display uses a set of five characters to render the hierarchical structure. Different styles are available for ASCII-only terminals, Unicode-capable terminals, and various aesthetic preferences.

Example

use tree_display::Graphics;

// Use ASCII characters for maximum compatibility
let ascii = Graphics::ASCII;

// Use modern Unicode box-drawing characters
let light = Graphics::LIGHT;

// Customize individual characters
let custom = Graphics::new()
  .vertical('│')
  .horizontal('─')
  .tip('└');

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

horizontal: char

Character for horizontal lines connecting to labels

vertical: char

Character for vertical lines connecting tree levels

junction: char

Character for branch junctions (middle child)

tip: char

Character for the tip/end of a branch (last child)

end: char

Character for the end of the tree (root connector)

Implementations

impl Graphics

pub const BLANK: Self

Minimal graphics with no visible characters (spaces only).

Uses for all characters, effectively disabling tree lines.

pub const ASCII: Self

Pure ASCII characters (compatible with all terminals).

Uses -, |, +, -, and ` for tree drawing.

pub const LIGHT: Self

Light-weight Unicode box-drawing characters.

Uses ─, │, ├, ─, and └ for tree drawing.

pub const LIGHT_DOTTED: Self

Light-weight Unicode box-drawing characters with dotted lines.

Uses ╌, │, ├, ─, and └ for tree drawing.

pub const LIGHT_ROUNDED: Self

Light-weight Unicode box-drawing characters with rounded corners.

Uses ─, │, ├, ─, and ╰ for tree drawing.

pub const LIGHT_DOTTED_ROUNDED: Self

Light-weight Unicode box-drawing characters with dotted lines and rounded corners.

Uses ╌, │, ├, ─, and ╰ for tree drawing.

pub const DOUBLE: Self

Double-line Unicode box-drawing characters.

Uses ═, ║, ╠, ━, and ╚ for tree drawing.

pub const HEAVY: Self

Heavy-weight Unicode box-drawing characters.

Uses ━, ┃, ┣, ━, and ┗ for tree drawing.

pub const HEAVY_DOTTED: Self

Heavy-weight Unicode box-drawing characters with dotted lines.

Uses ╍, ╏, ┣, ━, and ┗ for tree drawing.

impl Graphics

pub const fn new() -> Self

Creates a new Graphics instance with LIGHT characters.

pub const fn horizontal(self, c: char) -> Self

Sets the horizontal line character.

This character is used for horizontal connections extending from vertical lines to labels.

pub const fn vertical(self, c: char) -> Self

Sets the vertical line character.

This character is used for vertical lines that connect tree levels.

pub const fn junction(self, c: char) -> Self

Sets the junction character.

This character is used at branch junctions where horizontal and vertical lines meet. It represents the “T-junction” where a branch splits.

pub const fn tip(self, c: char) -> Self

Sets the tip character.

This character is used for the tip/end of a branch (the last child).

pub const fn end(self, c: char) -> Self

Sets the end character.

This character is used at the root of the tree or as the final connector in the hierarchy. In some styles, it may be the same as the tip character.

pub const fn all(self, c: char) -> Self

Sets all graphics characters to the same value.

This is a convenience method for quickly creating a uniform style where all characters are identical.

Trait Implementations

impl Clone for Graphics

fn clone(&self) -> Graphics

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Graphics

impl Debug for Graphics

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

Formats the value using the given formatter.

impl Default for Graphics

fn default() -> Self

Creates a new Graphics instance with LIGHT characters.

impl Eq for Graphics

impl Ord for Graphics

fn cmp(&self, other: &Graphics) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Graphics

fn eq(&self, other: &Graphics) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Graphics

fn partial_cmp(&self, other: &Graphics) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Graphics