Struct branchless::core::formatting::Glyphs

pub struct Glyphs {

    pub should_write_ansi_escape_codes: bool,
    pub line: &'static str,
    pub line_with_offshoot: &'static str,
    pub vertical_ellipsis: &'static str,
    pub split: &'static str,
    pub merge: &'static str,
    pub commit_visible: &'static str,
    pub commit_visible_head: &'static str,
    pub commit_obsolete: &'static str,
    pub commit_obsolete_head: &'static str,
    pub commit_main: &'static str,
    pub commit_main_head: &'static str,
    pub commit_main_obsolete: &'static str,
    pub commit_main_obsolete_head: &'static str,
    pub commit_omitted: &'static str,
    pub commit_merge: &'static str,
    pub branch_arrow: &'static str,
    pub bullet_point: &'static str,
    pub cycle_arrow: &'static str,
    pub cycle_horizontal_line: &'static str,
    pub cycle_vertical_line: &'static str,
    pub cycle_upper_left_corner: &'static str,
    pub cycle_lower_left_corner: &'static str,
}

Glyphs to use for rendering the smartlog.

Fields

should_write_ansi_escape_codes: bool

Whether or not ANSI escape codes should be emitted (e.g. to render color).

line: &'static str

Line connecting a parent commit to its single child commit.

line_with_offshoot: &'static str

Line connecting a parent commit with two or more child commits.

vertical_ellipsis: &'static str

Denotes an omitted sequence of commits.

split: &'static str

Line used to connect a parent commit to its non-first child commit.

merge: &'static str

Line used to connect a child commit to its non-first parent commit.

commit_visible: &'static str

Cursor for a normal visible commit which is not currently checked out.

commit_visible_head: &'static str

Cursor for the visible commit which is currently checked out.

commit_obsolete: &'static str

Cursor for an obsolete commit.

commit_obsolete_head: &'static str

Cursor for the obsolete commit which is currently checked out.

commit_main: &'static str

Cursor for a commit belonging to the main branch, which is not currently checked out.

commit_main_head: &'static str

Cursor for a commit belonging to the main branch, which is currently checked out.

commit_main_obsolete: &'static str

Cursor for an obsolete commit belonging to the main branch. (This is an unusual situation.)

commit_main_obsolete_head: &'static str

Cursor for an obsolete commit belonging to the main branch, which is currently checked out. (This is an unusual situation.)

commit_omitted: &'static str

Cursor indicating that some number of commits have been omitted from the smartlog at this position.

commit_merge: &'static str

Cursor indicating that a commit was either merging into this child commit or merged from this parent commit.

branch_arrow: &'static str

Character used to point to the currently-checked-out branch.

bullet_point: &'static str

Bullet-point character for a list of newline-separated items.

cycle_arrow: &'static str

Arrow character used when printing a commit cycle.

cycle_horizontal_line: &'static str

Horizontal line character used when printing a commit cycle.

cycle_vertical_line: &'static str

Vertical line character used when printing a commit cycle.

cycle_upper_left_corner: &'static str

Corner at the upper left of the arrow used when printing a commit cycle.

cycle_lower_left_corner: &'static str

Corner at the lower left of the arrow used when printing a commit cycle.

Implementations

impl Glyphs

pub fn detect() -> Self

Make the Glyphs object appropriate for stdout.

pub fn text() -> Self

Glyphs used for output to a text file or non-TTY.

pub fn pretty() -> Self

Glyphs used for output to a TTY.

pub fn render(&self, string: StyledString) -> Result<String>

Write the provided string to out, using ANSI escape codes as necessary to style it.

TODO: return something that implements Display instead of a String.

Trait Implementations

impl Clone for Glyphs

fn clone(&self) -> Glyphs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Glyphs

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

Formats the value using the given formatter.