Struct scanner_rust::Scanner

pub struct Scanner<R: Read> { /* fields omitted */ }

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

Methods

impl<R: Read> Scanner<R>

Important traits for Scanner<R>

impl<R: Read> Iterator for Scanner<R> type Item = String;

pub fn with_capacity(reader: R, capacity: usize) -> Scanner<R>

Create a scanner with a specific capacity.

extern crate scanner_rust;

use std::io;

use scanner_rust::Scanner;

let mut sc = Scanner::with_capacity(io::stdin(), 1024);

Important traits for Scanner<R>

impl<R: Read> Iterator for Scanner<R> type Item = String;

pub fn new(reader: R) -> Scanner<R>

Create a scanner with a default capacity.

extern crate scanner_rust;

use std::io;

use scanner_rust::Scanner;

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

impl<R: Read> Scanner<R>

Important traits for Scanner<R>

impl<R: Read> Iterator for Scanner<R> type Item = String;

pub fn scan_stream(reader: R) -> Scanner<R>

Create a scanner to read data from a reader.

extern crate scanner_rust;

use std::io;

use scanner_rust::Scanner;

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

impl Scanner<File>

pub fn scan_file(file: File) -> Result<Scanner<File>, ScannerError>

Create a scanner to read data from a file.

extern crate scanner_rust;

use std::fs::File;

use scanner_rust::Scanner;

let mut sc = Scanner::scan_file(File::open("Cargo.toml").unwrap()).unwrap();

pub fn scan_path<P: AsRef<Path>>(path: P) -> Result<Scanner<File>, ScannerError>

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

extern crate scanner_rust;

use std::fs::File;

use scanner_rust::Scanner;

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

impl Scanner<Cursor<String>>

Important traits for Scanner<R>

impl<R: Read> Iterator for Scanner<R> type Item = String;

pub fn scan_string<S: Into<String>>(s: S) -> Scanner<Cursor<String>>

Create a scanner to read data from a string.

extern crate scanner_rust;

use scanner_rust::Scanner;

let mut sc = Scanner::scan_string(String::from("5 12 2.4 c 中文也行"));

impl<'_> Scanner<&'_ [u8]>

Important traits for Scanner<R>

impl<R: Read> Iterator for Scanner<R> type Item = String;

pub fn scan_slice<B: AsRef<[u8]> + ?Sized>(b: &B) -> Scanner<&[u8]>

Create a scanner to read data from a u8 slice.

extern crate scanner_rust;

use scanner_rust::Scanner;

let mut sc = Scanner::scan_slice("5 12 2.4 c 中文也行");

impl Scanner<Cursor<Vec<u8>>>

Important traits for Scanner<R>

impl<R: Read> Iterator for Scanner<R> type Item = String;

pub fn scan_vec(v: Vec<u8>) -> Scanner<Cursor<Vec<u8>>>

Create a scanner to read data from a Vec instance which contains UTF-8 data.

extern crate scanner_rust;

use scanner_rust::Scanner;

let v = String::from("5 12 2.4 c 中文也行").into_bytes();

let mut sc = Scanner::scan_vec(v);

impl<R: Read> Scanner<R>

pub fn get_remains(&self) -> &[u8]

Get the data remaining in the buffer.

impl<R: Read> Scanner<R>

pub fn next_char(&mut self) -> Result<Option<char>, ScannerError>

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).

extern crate scanner_rust;

use scanner_rust::Scanner;

let mut sc = Scanner::scan_slice("5 c 中文");

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());

pub fn next_line(&mut self) -> Result<Option<String>, ScannerError>

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).

extern crate scanner_rust;

use scanner_rust::Scanner;

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

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());

impl<R: Read> Scanner<R>

pub fn skip_whitespaces(&mut self) -> Result<bool, ScannerError>

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

extern crate scanner_rust;

use scanner_rust::Scanner;

let v = String::from("1 2   c").into_bytes();

let mut sc = Scanner::scan_vec(v);

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());

pub fn next(&mut self) -> Result<Option<String>, ScannerError>

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

extern crate scanner_rust;

use scanner_rust::Scanner;

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

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());

pub fn next_u8(&mut self) -> Result<Option<u8>, ScannerError>

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

extern crate scanner_rust;

use scanner_rust::Scanner;

let mut sc = Scanner::scan_slice("1 2");

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

pub fn next_u16(&mut self) -> Result<Option<u16>, ScannerError>

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

extern crate scanner_rust;

use scanner_rust::Scanner;

let mut sc = Scanner::scan_slice("1 2");

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

pub fn next_u32(&mut self) -> Result<Option<u32>, ScannerError>

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

extern crate scanner_rust;

use scanner_rust::Scanner;

let mut sc = Scanner::scan_slice("1 2");

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

pub fn next_u64(&mut self) -> Result<Option<u64>, ScannerError>

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

extern crate scanner_rust;

use scanner_rust::Scanner;

let mut sc = Scanner::scan_slice("1 2");

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

pub fn next_u128(&mut self) -> Result<Option<u128>, ScannerError>

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

extern crate scanner_rust;

use scanner_rust::Scanner;

let mut sc = Scanner::scan_slice("1 2");

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

pub fn next_usize(&mut self) -> Result<Option<usize>, ScannerError>

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

extern crate scanner_rust;

use scanner_rust::Scanner;

let mut sc = Scanner::scan_slice("1 2");

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

pub fn next_i8(&mut self) -> Result<Option<i8>, ScannerError>

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

extern crate scanner_rust;

use scanner_rust::Scanner;

let mut sc = Scanner::scan_slice("1 2");

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

pub fn next_i16(&mut self) -> Result<Option<i16>, ScannerError>

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

extern crate scanner_rust;

use scanner_rust::Scanner;

let mut sc = Scanner::scan_slice("1 2");

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

pub fn next_i32(&mut self) -> Result<Option<i32>, ScannerError>

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

extern crate scanner_rust;

use scanner_rust::Scanner;

let mut sc = Scanner::scan_slice("1 2");

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

pub fn next_i64(&mut self) -> Result<Option<i64>, ScannerError>

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

extern crate scanner_rust;

use scanner_rust::Scanner;

let mut sc = Scanner::scan_slice("1 2");

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

pub fn next_i128(&mut self) -> Result<Option<i128>, ScannerError>

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

extern crate scanner_rust;

use scanner_rust::Scanner;

let mut sc = Scanner::scan_slice("1 2");

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

pub fn next_isize(&mut self) -> Result<Option<isize>, ScannerError>

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

extern crate scanner_rust;

use scanner_rust::Scanner;

let mut sc = Scanner::scan_slice("1 2");

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

pub fn next_f32(&mut self) -> Result<Option<f32>, ScannerError>

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

extern crate scanner_rust;

use scanner_rust::Scanner;

let mut sc = Scanner::scan_slice("1 2.5");

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

pub fn next_f64(&mut self) -> Result<Option<f64>, ScannerError>

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

extern crate scanner_rust;

use scanner_rust::Scanner;

let mut sc = Scanner::scan_slice("1 2.5");

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

Trait Implementations

impl<R: Read> Iterator for Scanner<R>

type Item = String

The type of the elements being iterated over.

fn next(&mut self) -> Option<Self::Item>

Advances the iterator and returns the next value.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the iterator.

fn count(self) -> usize

Consumes the iterator, counting the number of iterations and returning it.

fn last(self) -> Option<Self::Item>

Consumes the iterator, returning the last element.

fn nth(&mut self, n: usize) -> Option<Self::Item>

Returns the nth element of the iterator.

fn step_by(self, step: usize) -> StepBy<Self>

Creates an iterator starting at the same point, but stepping by the given amount at each iteration.

fn chain<U>(self, other: U) -> Chain<Self, <U as IntoIterator>::IntoIter> where
    U: IntoIterator<Item = Self::Item>, 

Takes two iterators and creates a new iterator over both in sequence.

fn zip<U>(self, other: U) -> Zip<Self, <U as IntoIterator>::IntoIter> where
    U: IntoIterator, 

'Zips up' two iterators into a single iterator of pairs.

fn map<B, F>(self, f: F) -> Map<Self, F> where
    F: FnMut(Self::Item) -> B, 

Takes a closure and creates an iterator which calls that closure on each element.

fn for_each<F>(self, f: F) where
    F: FnMut(Self::Item), 

Calls a closure on each element of an iterator.

fn filter<P>(self, predicate: P) -> Filter<Self, P> where
    P: FnMut(&Self::Item) -> bool, 

Creates an iterator which uses a closure to determine if an element should be yielded.

fn filter_map<B, F>(self, f: F) -> FilterMap<Self, F> where
    F: FnMut(Self::Item) -> Option<B>, 

Creates an iterator that both filters and maps.

fn enumerate(self) -> Enumerate<Self>

Creates an iterator which gives the current iteration count as well as the next value.

fn peekable(self) -> Peekable<Self>

Creates an iterator which can use peek to look at the next element of the iterator without consuming it.

fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P> where
    P: FnMut(&Self::Item) -> bool, 

Creates an iterator that [skip]s elements based on a predicate.

fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P> where
    P: FnMut(&Self::Item) -> bool, 

Creates an iterator that yields elements based on a predicate.

fn skip(self, n: usize) -> Skip<Self>

Creates an iterator that skips the first n elements.

fn take(self, n: usize) -> Take<Self>

Creates an iterator that yields its first n elements.

fn scan<St, B, F>(self, initial_state: St, f: F) -> Scan<Self, St, F> where
    F: FnMut(&mut St, Self::Item) -> Option<B>, 

An iterator adaptor similar to [fold] that holds internal state and produces a new iterator.

fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F> where
    F: FnMut(Self::Item) -> U,
    U: IntoIterator, 

Creates an iterator that works like map, but flattens nested structure.

fn flatten(self) -> Flatten<Self> where
    Self::Item: IntoIterator, 

Creates an iterator that flattens nested structure.

fn fuse(self) -> Fuse<Self>

Creates an iterator which ends after the first [None].

fn inspect<F>(self, f: F) -> Inspect<Self, F> where
    F: FnMut(&Self::Item), 

Do something with each element of an iterator, passing the value on.

fn by_ref(&mut self) -> &mut Self

Borrows an iterator, rather than consuming it.

#[must_use = "if you really need to exhaust the iterator, consider `.for_each(drop)` instead"] fn collect<B>(self) -> B where
    B: FromIterator<Self::Item>, 

Transforms an iterator into a collection.

fn partition<B, F>(self, f: F) -> (B, B) where
    B: Default + Extend<Self::Item>,
    F: FnMut(&Self::Item) -> bool, 

Consumes an iterator, creating two collections from it.

fn partition_in_place<'a, T, P>(self, predicate: P) -> usize where
    P: FnMut(&T) -> bool,
    Self: DoubleEndedIterator<Item = &'a mut T>,
    T: 'a, 

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

new API

Reorder the elements of this iterator in-place according to the given predicate, such that all those that return true precede all those that return false. Returns the number of true elements found.

fn is_partitioned<P>(self, predicate: P) -> bool where
    P: FnMut(Self::Item) -> bool, 

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

new API

Checks if the elements of this iterator are partitioned according to the given predicate, such that all those that return true precede all those that return false.

fn try_fold<B, F, R>(&mut self, init: B, f: F) -> R where
    F: FnMut(B, Self::Item) -> R,
    R: Try<Ok = B>, 

An iterator method that applies a function as long as it returns successfully, producing a single, final value.

fn try_for_each<F, R>(&mut self, f: F) -> R where
    F: FnMut(Self::Item) -> R,
    R: Try<Ok = ()>, 

An iterator method that applies a fallible function to each item in the iterator, stopping at the first error and returning that error.

fn fold<B, F>(self, init: B, f: F) -> B where
    F: FnMut(B, Self::Item) -> B, 

An iterator method that applies a function, producing a single, final value.

fn all<F>(&mut self, f: F) -> bool where
    F: FnMut(Self::Item) -> bool, 

Tests if every element of the iterator matches a predicate.

fn any<F>(&mut self, f: F) -> bool where
    F: FnMut(Self::Item) -> bool, 

Tests if any element of the iterator matches a predicate.

fn find<P>(&mut self, predicate: P) -> Option<Self::Item> where
    P: FnMut(&Self::Item) -> bool, 

Searches for an element of an iterator that satisfies a predicate.

fn find_map<B, F>(&mut self, f: F) -> Option<B> where
    F: FnMut(Self::Item) -> Option<B>, 

Applies function to the elements of iterator and returns the first non-none result.

fn position<P>(&mut self, predicate: P) -> Option<usize> where
    P: FnMut(Self::Item) -> bool, 

Searches for an element in an iterator, returning its index.

fn rposition<P>(&mut self, predicate: P) -> Option<usize> where
    P: FnMut(Self::Item) -> bool,
    Self: ExactSizeIterator + DoubleEndedIterator, 

Searches for an element in an iterator from the right, returning its index.

fn max(self) -> Option<Self::Item> where
    Self::Item: Ord, 

Returns the maximum element of an iterator.

fn min(self) -> Option<Self::Item> where
    Self::Item: Ord, 

Returns the minimum element of an iterator.

fn max_by_key<B, F>(self, f: F) -> Option<Self::Item> where
    B: Ord,
    F: FnMut(&Self::Item) -> B, 

Returns the element that gives the maximum value from the specified function.

fn max_by<F>(self, compare: F) -> Option<Self::Item> where
    F: FnMut(&Self::Item, &Self::Item) -> Ordering, 

Returns the element that gives the maximum value with respect to the specified comparison function.

fn min_by_key<B, F>(self, f: F) -> Option<Self::Item> where
    B: Ord,
    F: FnMut(&Self::Item) -> B, 

Returns the element that gives the minimum value from the specified function.

fn min_by<F>(self, compare: F) -> Option<Self::Item> where
    F: FnMut(&Self::Item, &Self::Item) -> Ordering, 

Returns the element that gives the minimum value with respect to the specified comparison function.

fn rev(self) -> Rev<Self> where
    Self: DoubleEndedIterator, 

Reverses an iterator's direction.

fn unzip<A, B, FromA, FromB>(self) -> (FromA, FromB) where
    FromA: Default + Extend<A>,
    FromB: Default + Extend<B>,
    Self: Iterator<Item = (A, B)>, 

Converts an iterator of pairs into a pair of containers.

fn copied<'a, T>(self) -> Copied<Self> where
    Self: Iterator<Item = &'a T>,
    T: 'a + Copy, 

Creates an iterator which copies all of its elements.

fn cloned<'a, T>(self) -> Cloned<Self> where
    Self: Iterator<Item = &'a T>,
    T: 'a + Clone, 

Creates an iterator which [clone]s all of its elements.

fn cycle(self) -> Cycle<Self> where
    Self: Clone, 

Repeats an iterator endlessly.

fn sum<S>(self) -> S where
    S: Sum<Self::Item>, 

Sums the elements of an iterator.

fn product<P>(self) -> P where
    P: Product<Self::Item>, 

Iterates over the entire iterator, multiplying all the elements

fn cmp<I>(self, other: I) -> Ordering where
    I: IntoIterator<Item = Self::Item>,
    Self::Item: Ord, 

Lexicographically compares the elements of this Iterator with those of another.

fn cmp_by<I, F>(self, other: I, cmp: F) -> Ordering where
    F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Ordering,
    I: IntoIterator, 

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

Lexicographically compares the elements of this Iterator with those of another with respect to the specified comparison function.

fn partial_cmp<I>(self, other: I) -> Option<Ordering> where
    I: IntoIterator,
    Self::Item: PartialOrd<<I as IntoIterator>::Item>, 

Lexicographically compares the elements of this Iterator with those of another.

fn partial_cmp_by<I, F>(self, other: I, partial_cmp: F) -> Option<Ordering> where
    F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Option<Ordering>,
    I: IntoIterator, 

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

Lexicographically compares the elements of this Iterator with those of another with respect to the specified comparison function.

fn eq<I>(self, other: I) -> bool where
    I: IntoIterator,
    Self::Item: PartialEq<<I as IntoIterator>::Item>, 

Determines if the elements of this Iterator are equal to those of another.

fn eq_by<I, F>(self, other: I, eq: F) -> bool where
    F: FnMut(Self::Item, <I as IntoIterator>::Item) -> bool,
    I: IntoIterator, 

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

Determines if the elements of this Iterator are equal to those of another with respect to the specified equality function.

fn ne<I>(self, other: I) -> bool where
    I: IntoIterator,
    Self::Item: PartialEq<<I as IntoIterator>::Item>, 

Determines if the elements of this Iterator are unequal to those of another.

fn lt<I>(self, other: I) -> bool where
    I: IntoIterator,
    Self::Item: PartialOrd<<I as IntoIterator>::Item>, 

Determines if the elements of this Iterator are lexicographically less than those of another.

fn le<I>(self, other: I) -> bool where
    I: IntoIterator,
    Self::Item: PartialOrd<<I as IntoIterator>::Item>, 

Determines if the elements of this Iterator are lexicographically less or equal to those of another.

fn gt<I>(self, other: I) -> bool where
    I: IntoIterator,
    Self::Item: PartialOrd<<I as IntoIterator>::Item>, 

Determines if the elements of this Iterator are lexicographically greater than those of another.

fn ge<I>(self, other: I) -> bool where
    I: IntoIterator,
    Self::Item: PartialOrd<<I as IntoIterator>::Item>, 

Determines if the elements of this Iterator are lexicographically greater than or equal to those of another.

fn is_sorted(self) -> bool where
    Self::Item: PartialOrd<Self::Item>, 

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

new API

Checks if the elements of this iterator are sorted.

fn is_sorted_by<F>(self, compare: F) -> bool where
    F: FnMut(&Self::Item, &Self::Item) -> Option<Ordering>, 

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

new API

Checks if the elements of this iterator are sorted using the given comparator function.

fn is_sorted_by_key<F, K>(self, f: F) -> bool where
    F: FnMut(Self::Item) -> K,
    K: PartialOrd<K>, 

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

new API

Checks if the elements of this iterator are sorted using the given key extraction function.

impl<R: Read> Debug for Scanner<R>

fn fmt(&self, formatter: &mut Formatter) -> Result

Formats the value using the given formatter.