Struct source_span::Layout

pub struct Layout<M: Metrics> { /* fields omitted */ }

Text layout.

Keep track of the byte index of each line in a UTF8-encoded so it can be indexed by cursor position.

Implementations

impl<M: Metrics> Layout<M>

pub fn new(metrics: M) -> Layout<M>

Create a new empty layout from a given metrics.

pub fn span(&self) -> Span

Get the layout’s span.

pub fn from<Chars: Iterator<Item = char>>(chars: Chars, metrics: M) -> Layout<M>

Create a new layout from a char iterator.

pub fn try_from<E, Chars: Iterator<Item = Result<char, E>>>(
    chars: Chars,
    metrics: M
) -> Result<Layout<M>, E>

Try to create a new layout from an unreliable char iterator.

pub fn push(&mut self, c: char)

Extend the layout with a new character.

pub fn byte_index(&self, str: &str, position: Position) -> Option<usize>

Get the byte index mapping to the given position in the input string slice.

It is assumed that the input string slice matches the layout. Otherwise, the returned index may not point to an UTF8 character boundary nor even be in the slice bounds.

pub fn span_slice<'a>(&self, str: &'a str, span: Span) -> &'a str

Get the sub slice of the input string matching the given span.

Trait Implementations

impl<M: Metrics> Extend<char> for Layout<M>

fn extend<Chars: IntoIterator<Item = char>>(&mut self, chars: Chars)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.