Struct WhitespaceResult 

pub struct WhitespaceResult { /* private fields */ }

Information about whitespace consumed by an input scanning hook.

Tabs and spaces are tracked independently. When SkipTabs::No leaves a tab in the input, that tab is not included in this result. Characters inside a skipped comment do not affect either flag.

Examples

use granit_parser::{input::{SkipTabs, WhitespaceResult}, BufferedInput, Input};

let mut input = BufferedInput::new(" \t#comment".chars());
let (consumed, result) = input.skip_ws_to_eol_blanks(SkipTabs::Yes);
assert_eq!(consumed, 2);
assert_eq!(result, WhitespaceResult::new(true, true));
assert!(result.found_tabs());
assert!(result.has_valid_yaml_ws());

Implementations

impl WhitespaceResult

pub const fn new(found_tabs: bool, has_valid_yaml_ws: bool) -> Self

Create whitespace information from independently tracked tabs and spaces.

has_valid_yaml_ws indicates whether at least one space was consumed outside a comment.

pub const fn found_tabs(self) -> bool

Return whether at least one tab was consumed outside a comment.

pub const fn has_valid_yaml_ws(self) -> bool

Return whether at least one space was consumed outside a comment.

Trait Implementations

impl Clone for WhitespaceResult

fn clone(&self) -> WhitespaceResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for WhitespaceResult

impl Debug for WhitespaceResult

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

Formats the value using the given formatter.

impl Eq for WhitespaceResult

impl PartialEq for WhitespaceResult

fn eq(&self, other: &WhitespaceResult) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for WhitespaceResult