Crate scan

This crate is designed to assist in parsing values out of input streams (or any other constructs which implement Read). It does so by providing a trait, Scan which can be used to tokenize and parse input.

This crate also provides an implementation of Scan, Scanner.

Quick Start

Simply include extern crate scan at the top of your project, add scan = "0.1.0" to your project's dependencies, and you are ready to roll!

use scan::Scan;
let mut scanner = scan::from_stdin();
let my_int = scanner.next::<i32>();
match my_int {
    Ok(int) => println!("Integer: {}", int),
    Err(e) => println!("Error: {}", e),
}

Features

This crate provides a built-in implementation of Scan: Scanner. A scanner can be constructed from any implementation of read, and helper functions are provided for concisely creating a scanner of a file or of standard input.

By default a Scanner treats whitespace (space, tab, line feed, and carriage return) as the delimiter for what to parse; however, you can also provide a different set of delimiters.

Scan allows for any structure implementing std::str::FromStr to be parsed. This includes most types built-in to the Rust language, but you may also implement FromStr for any type you define.

Structs

Scanner

Scanner is the built-in implementation of the Scan trait. It can be constructed in a few ways.

Enums

ScanError

Enum representing an error which can arise when extracting an F from a readable stream.

Traits

Scan	A Trait for enabling values to be tokenized and then parsed into types implementing FromStr

Functions

from_path	Creates a scanner of the file located at path. Returns a result that is either a scanner or an IOError.
from_stdin	Creates a scanner of standard input. Returns the Scanner itself - not a result.