Struct sourceannot::SourceSnippet

pub struct SourceSnippet { /* private fields */ }

A snippet of source code.

Implementations

impl SourceSnippet

pub fn build_from_utf8( start_line: usize, source: &[u8], tab_width: usize ) -> Self

Creates a snippet from a UTF-8 (possibly broken) source.

Each byte of ASCII control characters and invalid UTF-8 sequences is represented as <XX> as alternative text.

pub fn build_from_utf8_ex<FnCtrl, FnInv>( start_line: usize, source: &[u8], on_control: FnCtrl, on_invalid: FnInv, invalid_multi: bool ) -> Self

where FnCtrl: FnMut(char) -> (bool, String), FnInv: FnMut(&[u8]) -> (bool, String),

Creates a snippet from a UTF-8 (possibly broken) source.

on_control is used to handle ASCII control characters. on_invalid and invalid_multi are used to handle invalid UTF-8 sequences.

When invalid_multi is true, on_invalid is called for each byte of an invalid UTF-8 sequence. Otherwise, on_invalid is called once with the entire sequence.

on_control and on_invalid also returns a boolean to indicate if the text should be rendered alternative.

impl SourceSnippet

pub fn get_line_col(&self, pos: usize) -> (usize, usize)

Trait Implementations

impl Clone for SourceSnippet

fn clone(&self) -> SourceSnippet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SourceSnippet

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

Formats the value using the given formatter.