tree-display 1.0.2

Display Rust data structures as syntax-highlighted trees in the terminal with a single derive macro. Features full color theming, context-aware value mapping, and intelligent formatting for collections. Perfect for debugging, compiler diagnostics, and AST inspection.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

//! Color and line graphics bundled into a cohesive visual style.
//!
//! A theme brings together color palettes and line characters to create
//! a consistent look for tree output. Choose from predefined themes or
//! mix and match colors and graphics to suit your preferences.

use super::color::Colors;
use super::graphics::Graphics;

// ──── API ─────────────────────────────────────────────────────────────────────────────────────

/// A complete theme for tree display.
///
/// A theme combines color configuration and line graphics to define the
/// visual appearance of tree output. Themes control everything from syntax
/// highlighting colors to the characters used for drawing tree lines.
///
/// ## Example
/// ```no_run
/// use tree_display::{Theme, Colors, Graphics};
///
/// // Use the default theme
/// let theme = Theme::default();
///
/// // Create a custom theme
/// let custom = Theme::new()
///     .colors(Colors::VSCODE_DARK_PLUS)
///     .lines(Graphics::LIGHT_ROUNDED)
///     .align_to_values(true);
/// ```
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
pub struct Theme {
  /// Color configuration for syntax highlighting
  pub colors: Colors,
  /// Line characters for tree drawing
  pub lines: Graphics,
  /// Whether to align labels with values vertically
  ///
  /// When `true`: subtrees are aligned with the values they describe.
  ///
  /// When `false`: all subtrees have the same consistent indentation.
  pub align_to_values: bool,
}

// ──── Utility ───────────────────────────────────────────────────────────────────────────────────

impl Theme {
  /// Creates a new [`Theme`] with default settings.
  ///
  /// The default theme uses no colors, light Unicode lines, and no value alignment.
  pub const fn new() -> Self {
    Self {
      colors: Colors::new(),
      lines: Graphics::new(),
      align_to_values: false,
    }
  }

  /// Sets the color configuration for this theme.
  pub const fn colors(mut self, colors: Colors) -> Self {
    self.colors = colors;
    self
  }

  /// Sets the line graphics for this theme.
  pub const fn lines(mut self, lines: Graphics) -> Self {
    self.lines = lines;
    self
  }

  /// Sets whether subtrees should be aligned with values.
  ///
  /// When `true`: subtrees are aligned with the values they describe.
  ///
  /// When `false`: all subtrees have the same consistent indentation.
  pub const fn align_to_values(mut self, align_to_values: bool) -> Self {
    self.align_to_values = align_to_values;
    self
  }
}

impl Default for Theme {
  /// Creates a new [`Theme`] with default settings.
  ///
  /// The default theme uses no colors, light Unicode lines, and no value alignment.
  fn default() -> Self {
    Self::new()
  }
}