Struct scanner_rust::Scanner

source · [−]
pub struct Scanner<R: Read, N: ArrayLength<u8> + IsGreaterOrEqual<U4, Output = True> = U256> { /* private fields */ }
Expand description

A simple text scanner which can parse primitive types and strings using UTF-8.

Implementations

Create a scanner from a reader.

use std::io;

use scanner_rust::Scanner;

let mut sc = Scanner::new(io::stdin());

Create a scanner from a reader and set the buffer size via generics.

use std::io;

use scanner_rust::generic_array::typenum::U1024;
use scanner_rust::Scanner;

let mut sc: Scanner<_, U1024> = Scanner::new2(io::stdin());

Create a scanner to read data from a file by its path.

use scanner_rust::Scanner;

let mut sc = Scanner::scan_path("Cargo.toml").unwrap();

Create a scanner to read data from a file by its path and set the buffer size via generics.

use scanner_rust::generic_array::typenum::U1024;
use scanner_rust::Scanner;

let mut sc: Scanner<_, U1024> = Scanner::scan_path2("Cargo.toml").unwrap();

Left shift (if necessary) the buffer to remove bytes from the start of the buffer. Typically, you should use this after peeking the buffer.

Read the next char. If the data is not a correct char, it will return a Ok(Some(REPLACEMENT_CHARACTER)) which is �. If there is nothing to read, it will return Ok(None).

use scanner_rust::Scanner;

let mut sc = Scanner::new("5 c 中文".as_bytes());

assert_eq!(Some('5'), sc.next_char().unwrap());
assert_eq!(Some(' '), sc.next_char().unwrap());
assert_eq!(Some('c'), sc.next_char().unwrap());
assert_eq!(Some(' '), sc.next_char().unwrap());
assert_eq!(Some('中'), sc.next_char().unwrap());
assert_eq!(Some('文'), sc.next_char().unwrap());
assert_eq!(None, sc.next_char().unwrap());

Read the next line but not include the tailing line character (or line chracters like CrLf(\r\n)). If there is nothing to read, it will return Ok(None).

use scanner_rust::Scanner;

let mut sc = Scanner::new("123 456\r\n789 \n\n 中文 ".as_bytes());

assert_eq!(Some("123 456".into()), sc.next_line().unwrap());
assert_eq!(Some("789 ".into()), sc.next_line().unwrap());
assert_eq!(Some("".into()), sc.next_line().unwrap());
assert_eq!(Some(" 中文 ".into()), sc.next_line().unwrap());

Read the next line include the tailing line character (or line chracters like CrLf(\r\n)) without fully validating UTF-8. If there is nothing to read, it will return Ok(None).

use scanner_rust::Scanner;

let mut sc = Scanner::new("123 456\r\n789 \n\n 中文 ".as_bytes());

assert_eq!(Some("123 456".into()), sc.next_line_raw().unwrap());
assert_eq!(Some("789 ".into()), sc.next_line_raw().unwrap());
assert_eq!(Some("".into()), sc.next_line_raw().unwrap());
assert_eq!(Some(" 中文 ".into()), sc.next_line_raw().unwrap());

Drop the next line but not include the tailing line character (or line chracters like CrLf(\r\n)). If there is nothing to read, it will return Ok(None). If there are something to read, it will return Ok(Some(i)). The i is the length of the dropped line.

use scanner_rust::Scanner;

let mut sc = Scanner::new("123 456\r\n789 \n\n 中文 ".as_bytes());

assert_eq!(Some(7), sc.drop_next_line().unwrap());
assert_eq!(Some("789 ".into()), sc.next_line().unwrap());
assert_eq!(Some(0), sc.drop_next_line().unwrap());
assert_eq!(Some(" 中文 ".into()), sc.next_line().unwrap());
assert_eq!(None, sc.drop_next_line().unwrap());

Skip the next whitespaces (javaWhitespace). If there is nothing to read, it will return Ok(false).

use scanner_rust::Scanner;

let mut sc = Scanner::new("1 2   c".as_bytes());

assert_eq!(Some('1'), sc.next_char().unwrap());
assert_eq!(Some(' '), sc.next_char().unwrap());
assert_eq!(Some('2'), sc.next_char().unwrap());
assert_eq!(true, sc.skip_whitespaces().unwrap());
assert_eq!(Some('c'), sc.next_char().unwrap());
assert_eq!(false, sc.skip_whitespaces().unwrap());

Read the next token separated by whitespaces. If there is nothing to read, it will return Ok(None).

use scanner_rust::Scanner;

let mut sc = Scanner::new("123 456\r\n789 \n\n 中文 ".as_bytes());

assert_eq!(Some("123".into()), sc.next().unwrap());
assert_eq!(Some("456".into()), sc.next().unwrap());
assert_eq!(Some("789".into()), sc.next().unwrap());
assert_eq!(Some("中文".into()), sc.next().unwrap());
assert_eq!(None, sc.next().unwrap());

Read the next token separated by whitespaces without fully validating UTF-8. If there is nothing to read, it will return Ok(None).

use scanner_rust::Scanner;

let mut sc = Scanner::new("123 456\r\n789 \n\n 中文 ".as_bytes());

assert_eq!(Some("123".into()), sc.next_raw().unwrap());
assert_eq!(Some("456".into()), sc.next_raw().unwrap());
assert_eq!(Some("789".into()), sc.next_raw().unwrap());
assert_eq!(Some("中文".into()), sc.next_raw().unwrap());
assert_eq!(None, sc.next_raw().unwrap());

Drop the next token separated by whitespaces. If there is nothing to read, it will return Ok(None). If there are something to read, it will return Ok(Some(i)). The i is the length of the dropped line.

use scanner_rust::Scanner;

let mut sc = Scanner::new("123 456\r\n789 \n\n 中文 ".as_bytes());

assert_eq!(Some(3), sc.drop_next().unwrap());
assert_eq!(Some("456".into()), sc.next().unwrap());
assert_eq!(Some(3), sc.drop_next().unwrap());
assert_eq!(Some("中文".into()), sc.next().unwrap());
assert_eq!(None, sc.drop_next().unwrap());

Read the next bytes. If there is nothing to read, it will return Ok(None).

use scanner_rust::Scanner;

let mut sc = Scanner::new("123 456\r\n789 \n\n 中文 ".as_bytes());

assert_eq!(Some("123".into()), sc.next_bytes(3).unwrap());
assert_eq!(Some(" 456".into()), sc.next_bytes(4).unwrap());
assert_eq!(Some("\r\n789 ".into()), sc.next_bytes(6).unwrap());
assert_eq!(Some("中文".into()), sc.next_raw().unwrap());
assert_eq!(Some(" ".into()), sc.next_bytes(2).unwrap());
assert_eq!(None, sc.next_bytes(2).unwrap());

Drop the next N bytes. If there is nothing to read, it will return Ok(None). If there are something to read, it will return Ok(Some(i)). The i is the length of the actually dropped bytes.

use scanner_rust::Scanner;

let mut sc = Scanner::new("123 456\r\n789 \n\n 中文 ".as_bytes());

assert_eq!(Some(7), sc.drop_next_bytes(7).unwrap());
assert_eq!(Some("".into()), sc.next_line().unwrap());
assert_eq!(Some("789 ".into()), sc.next_line().unwrap());
assert_eq!(Some(1), sc.drop_next_bytes(1).unwrap());
assert_eq!(Some(" 中文 ".into()), sc.next_line().unwrap());
assert_eq!(None, sc.drop_next_bytes(1).unwrap());

Read the next text until it reaches a specific boundary. If there is nothing to read, it will return Ok(None).

use scanner_rust::Scanner;

let mut sc = Scanner::new("123 456\r\n789 \n\n 中文 ".as_bytes());

assert_eq!(Some("123".into()), sc.next_until(" ").unwrap());
assert_eq!(Some("456\r".into()), sc.next_until("\n").unwrap());
assert_eq!(Some("78".into()), sc.next_until("9 ").unwrap());
assert_eq!(Some("\n\n 中文 ".into()), sc.next_until("kk").unwrap());
assert_eq!(None, sc.next().unwrap());

Read the next data until it reaches a specific boundary without fully validating UTF-8. If there is nothing to read, it will return Ok(None).

use scanner_rust::Scanner;

let mut sc = Scanner::new("123 456\r\n789 \n\n 中文 ".as_bytes());

assert_eq!(Some("123".into()), sc.next_until_raw(" ").unwrap());
assert_eq!(Some("456\r".into()), sc.next_until_raw("\n").unwrap());
assert_eq!(Some("78".into()), sc.next_until_raw("9 ").unwrap());
assert_eq!(Some("\n\n 中文 ".into()), sc.next_until_raw("kk").unwrap());
assert_eq!(None, sc.next().unwrap());

Drop the next data until it reaches a specific boundary. If there is nothing to read, it will return Ok(None).

use scanner_rust::Scanner;

let mut sc = Scanner::new("123 456\r\n789 \n\n 中文 ".as_bytes());

assert_eq!(Some(7), sc.drop_next_until("\r\n").unwrap());
assert_eq!(Some("789 ".into()), sc.next_line().unwrap());
assert_eq!(Some(0), sc.drop_next_until("\n").unwrap());
assert_eq!(Some(" 中文 ".into()), sc.next_line().unwrap());
assert_eq!(None, sc.drop_next_until("").unwrap());

Try to fill up the buffer and return the immutable byte slice of the valid buffered data. If the shift parameter is set to false, the guaranteed minimum data length of the result is 32 (if the unread data is long enough), otherwise it is BUFFER_SIZE.

use scanner_rust::Scanner;

let mut sc = Scanner::new("123 456\r\n789 \n\n 中文 ".as_bytes());

assert_eq!("123 456\r\n789 \n\n 中文 ".as_bytes(), sc.peek(false).unwrap());

Read the next token separated by whitespaces and parse it to a u8 value. If there is nothing to read, it will return Ok(None).

use scanner_rust::Scanner;

let mut sc = Scanner::new("1 2".as_bytes());

assert_eq!(Some(1), sc.next_u8().unwrap());
assert_eq!(Some(2), sc.next_u8().unwrap());

Read the next token separated by whitespaces and parse it to a u16 value. If there is nothing to read, it will return Ok(None).

use scanner_rust::Scanner;

let mut sc = Scanner::new("1 2".as_bytes());

assert_eq!(Some(1), sc.next_u16().unwrap());
assert_eq!(Some(2), sc.next_u16().unwrap());

Read the next token separated by whitespaces and parse it to a u32 value. If there is nothing to read, it will return Ok(None).

use scanner_rust::Scanner;

let mut sc = Scanner::new("1 2".as_bytes());

assert_eq!(Some(1), sc.next_u32().unwrap());
assert_eq!(Some(2), sc.next_u32().unwrap());

Read the next token separated by whitespaces and parse it to a u64 value. If there is nothing to read, it will return Ok(None).

use scanner_rust::Scanner;

let mut sc = Scanner::new("1 2".as_bytes());

assert_eq!(Some(1), sc.next_u64().unwrap());
assert_eq!(Some(2), sc.next_u64().unwrap());

Read the next token separated by whitespaces and parse it to a u128 value. If there is nothing to read, it will return Ok(None).

use scanner_rust::Scanner;

let mut sc = Scanner::new("1 2".as_bytes());

assert_eq!(Some(1), sc.next_u128().unwrap());
assert_eq!(Some(2), sc.next_u128().unwrap());

Read the next token separated by whitespaces and parse it to a usize value. If there is nothing to read, it will return Ok(None).

use scanner_rust::Scanner;

let mut sc = Scanner::new("1 2".as_bytes());

assert_eq!(Some(1), sc.next_usize().unwrap());
assert_eq!(Some(2), sc.next_usize().unwrap());

Read the next token separated by whitespaces and parse it to a i8 value. If there is nothing to read, it will return Ok(None).

use scanner_rust::Scanner;

let mut sc = Scanner::new("1 2".as_bytes());

assert_eq!(Some(1), sc.next_i8().unwrap());
assert_eq!(Some(2), sc.next_i8().unwrap());

Read the next token separated by whitespaces and parse it to a i16 value. If there is nothing to read, it will return Ok(None).

use scanner_rust::Scanner;

let mut sc = Scanner::new("1 2".as_bytes());

assert_eq!(Some(1), sc.next_i16().unwrap());
assert_eq!(Some(2), sc.next_i16().unwrap());

Read the next token separated by whitespaces and parse it to a i32 value. If there is nothing to read, it will return Ok(None).

use scanner_rust::Scanner;

let mut sc = Scanner::new("1 2".as_bytes());

assert_eq!(Some(1), sc.next_i32().unwrap());
assert_eq!(Some(2), sc.next_i32().unwrap());

Read the next token separated by whitespaces and parse it to a i64 value. If there is nothing to read, it will return Ok(None).

use scanner_rust::Scanner;

let mut sc = Scanner::new("1 2".as_bytes());

assert_eq!(Some(1), sc.next_i64().unwrap());
assert_eq!(Some(2), sc.next_i64().unwrap());

Read the next token separated by whitespaces and parse it to a i128 value. If there is nothing to read, it will return Ok(None).

use scanner_rust::Scanner;

let mut sc = Scanner::new("1 2".as_bytes());

assert_eq!(Some(1), sc.next_i128().unwrap());
assert_eq!(Some(2), sc.next_i128().unwrap());

Read the next token separated by whitespaces and parse it to a isize value. If there is nothing to read, it will return Ok(None).

use scanner_rust::Scanner;

let mut sc = Scanner::new("1 2".as_bytes());

assert_eq!(Some(1), sc.next_isize().unwrap());
assert_eq!(Some(2), sc.next_isize().unwrap());

Read the next token separated by whitespaces and parse it to a f32 value. If there is nothing to read, it will return Ok(None).

use scanner_rust::Scanner;

let mut sc = Scanner::new("1 2.5".as_bytes());

assert_eq!(Some(1.0), sc.next_f32().unwrap());
assert_eq!(Some(2.5), sc.next_f32().unwrap());

Read the next token separated by whitespaces and parse it to a f64 value. If there is nothing to read, it will return Ok(None).

use scanner_rust::Scanner;

let mut sc = Scanner::new("1 2.5".as_bytes());

assert_eq!(Some(1.0), sc.next_f64().unwrap());
assert_eq!(Some(2.5), sc.next_f64().unwrap());

Read the next text until it reaches a specific boundary and parse it to a u8 value. If there is nothing to read, it will return Ok(None).

use scanner_rust::Scanner;

let mut sc = Scanner::new("1 2".as_bytes());

assert_eq!(Some(1), sc.next_u8_until(" ").unwrap());
assert_eq!(Some(2), sc.next_u8_until(" ").unwrap());

Read the next text until it reaches a specific boundary and parse it to a u16 value. If there is nothing to read, it will return Ok(None).

use scanner_rust::Scanner;

let mut sc = Scanner::new("1 2".as_bytes());

assert_eq!(Some(1), sc.next_u16_until(" ").unwrap());
assert_eq!(Some(2), sc.next_u16_until(" ").unwrap());

Read the next text until it reaches a specific boundary and parse it to a u32 value. If there is nothing to read, it will return Ok(None).

use scanner_rust::Scanner;

let mut sc = Scanner::new("1 2".as_bytes());

assert_eq!(Some(1), sc.next_u32_until(" ").unwrap());
assert_eq!(Some(2), sc.next_u32_until(" ").unwrap());

Read the next text until it reaches a specific boundary and parse it to a u64 value. If there is nothing to read, it will return Ok(None).

use scanner_rust::Scanner;

let mut sc = Scanner::new("1 2".as_bytes());

assert_eq!(Some(1), sc.next_u64_until(" ").unwrap());
assert_eq!(Some(2), sc.next_u64_until(" ").unwrap());

Read the next text until it reaches a specific boundary and parse it to a u128 value. If there is nothing to read, it will return Ok(None).

use scanner_rust::Scanner;

let mut sc = Scanner::new("1 2".as_bytes());

assert_eq!(Some(1), sc.next_u128_until(" ").unwrap());
assert_eq!(Some(2), sc.next_u128_until(" ").unwrap());

Read the next text until it reaches a specific boundary and parse it to a usize value. If there is nothing to read, it will return Ok(None).

use scanner_rust::Scanner;

let mut sc = Scanner::new("1 2".as_bytes());

assert_eq!(Some(1), sc.next_usize_until(" ").unwrap());
assert_eq!(Some(2), sc.next_usize_until(" ").unwrap());

Read the next text until it reaches a specific boundary and parse it to a i8 value. If there is nothing to read, it will return Ok(None).

use scanner_rust::Scanner;

let mut sc = Scanner::new("1 2".as_bytes());

assert_eq!(Some(1), sc.next_usize_until(" ").unwrap());
assert_eq!(Some(2), sc.next_usize_until(" ").unwrap());

Read the next text until it reaches a specific boundary and parse it to a i16 value. If there is nothing to read, it will return Ok(None).

use scanner_rust::Scanner;

let mut sc = Scanner::new("1 2".as_bytes());

assert_eq!(Some(1), sc.next_i16_until(" ").unwrap());
assert_eq!(Some(2), sc.next_i16_until(" ").unwrap());

Read the next text until it reaches a specific boundary and parse it to a i32 value. If there is nothing to read, it will return Ok(None).

use scanner_rust::Scanner;

let mut sc = Scanner::new("1 2".as_bytes());

assert_eq!(Some(1), sc.next_i32_until(" ").unwrap());
assert_eq!(Some(2), sc.next_i32_until(" ").unwrap());

Read the next text until it reaches a specific boundary and parse it to a i64 value. If there is nothing to read, it will return Ok(None).

use scanner_rust::Scanner;

let mut sc = Scanner::new("1 2".as_bytes());

assert_eq!(Some(1), sc.next_i64_until(" ").unwrap());
assert_eq!(Some(2), sc.next_i64_until(" ").unwrap());

Read the next text until it reaches a specific boundary and parse it to a i128 value. If there is nothing to read, it will return Ok(None).

use scanner_rust::Scanner;

let mut sc = Scanner::new("1 2".as_bytes());

assert_eq!(Some(1), sc.next_i128_until(" ").unwrap());
assert_eq!(Some(2), sc.next_i128_until(" ").unwrap());

Read the next text until it reaches a specific boundary and parse it to a isize value. If there is nothing to read, it will return Ok(None).

use scanner_rust::Scanner;

let mut sc = Scanner::new("1 2".as_bytes());

assert_eq!(Some(1), sc.next_isize_until(" ").unwrap());
assert_eq!(Some(2), sc.next_isize_until(" ").unwrap());

Read the next text until it reaches a specific boundary and parse it to a f32 value. If there is nothing to read, it will return Ok(None).

use scanner_rust::Scanner;

let mut sc = Scanner::new("1 2.5".as_bytes());

assert_eq!(Some(1.0), sc.next_f32_until(" ").unwrap());
assert_eq!(Some(2.5), sc.next_f32_until(" ").unwrap());

Read the next text until it reaches a specific boundary and parse it to a f64 value. If there is nothing to read, it will return Ok(None).

use scanner_rust::Scanner;

let mut sc = Scanner::new("1 2.5".as_bytes());

assert_eq!(Some(1.0), sc.next_f64_until(" ").unwrap());
assert_eq!(Some(2.5), sc.next_f64_until(" ").unwrap());

Trait Implementations

Formats the value using the given formatter. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Should always be Self

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.