Struct Indentation 

pub struct Indentation {
    pub step: &'static str,
    /* private fields */
}

How a language indents: its step, and the lines that open and close a block.

Fields

step: &'static str

Implementations

impl Indentation

pub fn of(language: Language, source: &str) -> Indentation

The indentation language follows; Hardware by what source is, Verilog or a spec.

pub fn opens_block(&self, line: &str) -> bool

Whether line opens a block whose lines sit one step deeper.

pub fn closes_block(&self, line: &str) -> bool

Whether line closes the block it sits in, and belongs one step shallower than it.

pub fn enter(&self, line: &str, at: usize) -> Enter

What Enter does at a caret whose line holds line, at bytes of it before the caret. It breaks the line, and the new line starts at the line’s own indentation — one step deeper when the text before the caret opens a block. A line that closes a block but still sits at its block’s depth is first moved back one step.

pub fn tab_fill(&self, column: usize) -> String

The spaces Tab inserts at column (counted in characters from 0): to the next stop.

pub fn indent_lines(&self, lines: &str) -> String

lines (whole lines, joined by \n) moved one step deeper; blank lines stay empty.

pub fn outdent_lines(&self, lines: &str) -> String

lines moved one step shallower, each as far as its own leading spaces allow (a tab counts as a whole step).

Trait Implementations

impl Clone for Indentation

fn clone(&self) -> Indentation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Indentation

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

Formats the value using the given formatter.

impl PartialEq for Indentation

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

impl Eq for Indentation

impl StructuralPartialEq for Indentation