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
51
52
53
54
55
56
57
58
59

// This file is a part of the mori - Material Orientation Library in Rust
// Copyright 2018 Robert Carson
//
//    Licensed under the Apache License, Version 2.0 (the "License");
//    you may not use this file except in compliance with the License.
//    You may obtain a copy of the License at
//
//        http://www.apache.org/licenses/LICENSE-2.0
//
//    Unless required by applicable law or agreed to in writing, software
//    distributed under the License is distributed on an "AS IS" BASIS,
//    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//    See the License for the specific language governing permissions and
//    limitations under the License.

//! # rust_data_reader
//!
//! An attempt at bringing into Rust data file readers that are similar in scope to those offered by the numpy package in python for genfromtxt and loadtxt. It currently is pretty rough and probably should not used by anyone in production. It is bound to be slow. The erro handling is okay as of right now but it could be better. A vast number of edge cases still need to be tested. The data types currently supported are all of the primitave ints, uints, and floats types supported by Rust. 
//!
//! The code is very much in a pre-alpha state currently. Once all of the primitative types have been added. The find comment lines has improved then one might start to be able to use on data files without missing data. Data that is missing the option type will be used to wrap the data.
//!
//! An example of how to use the code can be seen down below:
//!
//! # Example
//! ``` Rust
//! //This example shows us how we might skip a footer file
//! fn load_txt_i32_test_sk_f(){
//!     //The file here is the one included in the main folder.
//!     let file = String::from("int_testv2.txt");
//!
//!     let params = ReaderParams{
//!         comments: b'%',
//!         delimiter: Delimiter::WhiteSpace,
//!         skip_header: None,
//!         skip_footer: Some(5),
//!         usecols: None,
//!         max_rows: None,
//!     };
//!
//!     let results = load_txt_i32(&file, &params);
//!
//!     // Pattern matching for our results could look something like this.
//!     // match results{
//!     //     Ok(results) => println!("Number of lines {}\nNumber of fields {}\nResults {:?}",results.num_lines, results.num_fields, results.results),
//!     //     Err(err) => println!("Error {:?}", err),
//!     // }
//!
//!     assert_eq!(results.unwrap().results, vec![1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15]);
//!
//! }
//! ```

extern crate bytecount;
#[macro_use]
extern crate failure;
extern crate lexical;

///Contains all of the functions related to the different readers that will be generated.
pub mod reader;