Struct Config 

pub struct Config { /* private fields */ }

Configuration used by a Generator to control the layout algorithm.

For style configuration with a built-in diagram writer, see the Style struct.

Implementations

impl Config

pub const fn new() -> Self

Initialize using default values.

This is a const function which is identical to the Default implementation.

pub fn generator<V, R>(self, root: V, ramifier: R) -> Generator<V, R>

Construct a generator using this configuration, starting at the provided root and with the given ramifier.

This is a convenience wrapper around Generator::with_config.

pub const fn row_padding(self, pad: usize) -> Self

The number of extra rows to use as padding between vertices.

The padding applies after the annotation, or after the vertex if there is no annotation.

The default is 0.

Example

Here is an example going from a row padding of 0 to 1.

 0         0
 ├┬╮       ├┬╮
 │1├╮      │1├╮
 ││2│      ││││
 │3│├╮  →  ││2│
 │╭╯││     ││││
 ││╭┤│     │3│├╮
 │││4│     │╭╯││
 ││5╭╯  →  ││╭┤│
 │6╭╯      │││4│
 7╭╯       │││╭╯
  8        ││5│
           ││╭╯
           │6│
           │╭╯
           7│
           ╭╯
           8

pub const fn minimize_width(self, minimize: bool) -> Self

Whether to minimize the width.

If set, the preparation rows between vertex markers will also remove all internal whitespace. This almost always makes the branch diagram taller.

The default value is false.

Example

Here is an example minimizing the width.

 0         0
 ├┬╮       ├┬╮
 │1├╮      │1├╮
 ││2│      ││2│
 │3│├╮  →  │3│├╮
 │╭╯││     │╭╯││
 ││╭┤│     ││╭┤│
 │││4│     │││4│
 ││5╭╯  →  │││╭╯
 │6╭╯      ││5│
 7╭╯       ││╭╯
  8        │6│
           │╭╯
           7│
           ╭╯
           8

pub const fn annotation_before_vertex(self, before: bool) -> Self

Write the vertex on the last row of the annotation instead of the first.

This is mostly useful for writing the tree with the root at the bottom.

This can result in slightly taller branch diagrams. In particular, even if you are writing in inverted mode, if your annotations occupy at most one line, it can be useful to keep this as false anyway.

The default value is false.

Example

Here is an example writing the annotation before the vertex.

0             0
├┬╮           ├┬╮
│1├╮ L0   →   ││├╮ L0
││││ L1       │1││ L1
││2│          ││2│
│3│├╮ L0  →   │3│├╮ L0
│╭╯││         │╭╯││
││╭┤│         ││╭┤│
│││4│ L0  →   │││││ L0
│││╭╯ L1      │││││ L1
││││  L2      │││4│ L2
││5│          ││5╭╯
│6╭╯          │6╭╯
7╭╯           7╭╯
 8             8

pub const fn reverse_annotation_lines(self, rev: bool) -> Self

Write the annotation lines in reverse order.

This is mostly useful for writing the tree with the root at the bottom.

The default value is false.

Example

Here is an example writing the annotation lines in reverse order.

0            0       
├┬╮          ├┬╮     
│1├╮ L0   →  │1├╮ L1
││││ L1      ││││ L0
││2│         ││2│    
│3│├╮ L0  →  │3│├╮ L0
│╭╯││        │╭╯││   
││╭┤│        ││╭┤│   
│││4│ L0  →  │││4│ L2
│││╭╯ L1     │││╭╯ L1
││││  L2     ││││  L0
││5│         ││5│    
│6╭╯         │6╭╯    
7╭╯          7╭╯     
 8            8      

pub const fn inverted_annotations(self, invert: bool) -> Self

Set standard defaults for inverted drawing.

This writes the annotation before the vertex and reverses the annotation lines. This configuration option is commonly combined with an inverted character set and rendered with the lines in reverse order.

Note that setting this value will overwrite the values of the annotation_before_vertex and reverse_annotation_lines settings.

Example

When inverted, the tree is transformed as follows. The third diagram uses an inverted character set and the lines are displayed last to first.

0             0              8
├┬╮           ├┬╮           7╰╮
│1├╮ L0   →   ││├╮ L1   ↺   │6╰╮
││││ L1       │1││ L0       ││5╰╮
││2│          ││2│          │││4│ L0
│3│├╮ L0      │3│├╮ L0      │││││ L1
│╭╯││     →   │╭╯││     ↺   │││││ L2
││╭┤│         ││╭┤│         ││╰┤│
│││4│ L0      │││││ L2      │╰╮││
│││╭╯ L1      │││││ L1      │3│├╯ L0
││││  L2  →   │││4│ L0  ↺   ││2│
││5│          ││5╭╯         │1││ L0
│6╭╯          │6╭╯          ││├╯ L1
7╭╯           7╭╯           ├┴╯
 8             8            0

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Config

fn eq(&self, other: &Config) -> 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 Copy for Config

impl Eq for Config

impl StructuralPartialEq for Config