wood_parse 0.2.0

A library for lexing
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

# Lexer Package

This crate provides some methods for parsing text.

I mostly developed it for a custom language I want to build.

## Features

This crate exposes two [main structs](./src/text_parser.rs):
* **TextParser**: The base parser that loads the text from a `Read` trait.
* **Peeker**: Allows you to read ahead without consuming the previous characters until you consume all read characters.

## Usage

To use this package, add the the crate to your `Cargo.toml` file or run `cargo add wood-parse`

Then, import into your Rust code:
```rust
use wood_parse::{text_parser::TextParser, util::TextParserResult};
```

## Example

This code will remove all whitespace from a file:
```rust
let input = "a   b   c";
let expected = "abc";

// create the parser and get the peeker
let mut parser = TextParser::new(input.as_bytes());
let mut peeker = parser.peeker();

let mut parsed_string = String::new();

// Loop until the end is hit or an error occurs
loop {
    // skip whitespace
    let _ = peeker.consume_while(|ch: char| ch.is_whitespace());

    // get the next character
    let (result, _) = peeker.next();
    match result {
        TextParserResult::Ok(ch) => parsed_string.push(ch),
        TextParserResult::End => break,
        _ => {}
    }
}

//compare results
assert!(
    parsed_string == expected,
    "Expected {expected}, got {parsed_string}"
);
```