Struct Colors 

#[non_exhaustive]
pub struct Colors {
    pub branches: Option<Color>,
    pub vertical: Option<Color>,
    pub keywords: Option<Color>,
    pub members: Option<Color>,
    pub strings: Option<Color>,
    pub values: Option<Color>,
    pub types: Option<Color>,
}

Color configuration for tree display elements.

Each element of the tree can be individually colored, allowing you to highlight different syntactic categories like types, keywords, strings, and tree lines. Colors are optional, so you can enable only the highlighting you want.

Example

use tree_display::Colors;

let dark = Colors::VSCODE_DARK_PLUS;
let light = Colors::VSCODE_LIGHT_PLUS;

// Customize individual colors
let custom = Colors::new()
    .types(dark.types)
    .strings(light.strings);

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.

branches: Option<Color>

Color for branch lines (horizontal connectors between nodes)

vertical: Option<Color>

Color for vertical tree lines

keywords: Option<Color>

Color for keyword like values (e.g. None)

members: Option<Color>

Color for struct/enum member names

strings: Option<Color>

Color for string literals

values: Option<Color>

Color for literal values (e.g. integers, floats, bools)

types: Option<Color>

Color for type names (e.g., String, Vec, Option)

Implementations

impl Colors

pub const NONE: Self

No colors (all elements use default terminal color).

pub const VSCODE_DARK_PLUS: Self

Visual Studio Code Dark+ theme.

pub const VSCODE_LIGHT_PLUS: Self

Visual Studio Code Light+ theme.

pub const SOLARIZED_DARK: Self

Solarized Dark theme.

pub const SOLARIZED_LIGHT: Self

Solarized Light theme.

pub const DRACULA: Self

Dracula theme.

pub const MONOKAI: Self

Monokai theme.

pub const NORD: Self

Nord theme.

pub const GITHUB_DARK: Self

GitHub Dark theme.

pub const GITHUB_LIGHT: Self

GitHub Light theme.

impl Colors

pub const fn new() -> Self

Creates a new Colors instance with Visual Studio Code Dark+ colors.

pub const fn branches(self, color: Option<Color>) -> Self

Sets the color for branch lines.

Branch lines are the horizontal connectors that extend from vertical lines to node labels. They form the “arms” of the tree structure.

Pass None to disable coloring for this element.

pub const fn vertical(self, color: Option<Color>) -> Self

Sets the color for vertical tree lines.

Vertical lines connect parent nodes to their children, forming the main backbone of the tree hierarchy.

Pass None to disable coloring for this element.

pub const fn keywords(self, color: Option<Color>) -> Self

Sets the color for language keywords.

Keywords refer to keyword-like values such as enum variant names.

Pass None to disable coloring for this element.

pub const fn members(self, color: Option<Color>) -> Self

Sets the color for struct/enum member names.

Member names are the fields of structs and variants of enums. They are typically displayed alongside their containing type.

Pass None to disable coloring for this element.

pub const fn strings(self, color: Option<Color>) -> Self

Sets the color for string literals.

String literals are quoted text values, such as "hello" or multi-line string blocks.

Pass None to disable coloring for this element.

pub const fn values(self, color: Option<Color>) -> Self

Sets the color for literal values.

Literal values include numbers (42, 3.14), booleans (true, false), characters ('a'), and other primitive constant values.

Pass None to disable coloring for this element.

pub const fn types(self, color: Option<Color>) -> Self

Sets the color for type names.

Type names are identifiers that refer to types, such as String, Vec, Option, i32, and user-defined structs and enums.

Pass None to disable coloring for this element.

pub const fn all(self, color: Option<Color>) -> Self

Sets all color elements to the same value.

This is a convenience method for quickly creating a uniform theme where all elements share the same color.

Pass None to disable all coloring.

Trait Implementations

impl Clone for Colors

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Colors

impl Debug for Colors

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

Formats the value using the given formatter.

impl Default for Colors

fn default() -> Self

Creates a new Colors instance with Visual Studio Code Dark+ colors.

impl Eq for Colors

impl Ord for Colors

fn cmp(&self, other: &Self) -> 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Colors

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Colors

fn partial_cmp(&self, other: &Self) -> 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 Colors