aboutsummaryrefslogtreecommitdiff
path: root/src/lib.rs
diff options
context:
space:
mode:
authorDaniel Schadt <kingdread@gmx.de>2018-04-23 16:36:26 +0200
committerDaniel Schadt <kingdread@gmx.de>2018-04-23 16:36:26 +0200
commit6165bf6e4cfde199c3bc8bd0b862eb7de309aec3 (patch)
tree5f8f369ba841e424a69d89e9cddcd5e9a12214e0 /src/lib.rs
parent647137cdb0a02f242d5fa0e5e8df208be9411bf0 (diff)
downloadevtclib-6165bf6e4cfde199c3bc8bd0b862eb7de309aec3.tar.gz
evtclib-6165bf6e4cfde199c3bc8bd0b862eb7de309aec3.tar.bz2
evtclib-6165bf6e4cfde199c3bc8bd0b862eb7de309aec3.zip
add a bit more documentation
Diffstat (limited to 'src/lib.rs')
-rw-r--r--src/lib.rs16
1 files changed, 16 insertions, 0 deletions
diff --git a/src/lib.rs b/src/lib.rs
index 0876ea3..3e1aeee 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,5 +1,21 @@
//! `evtclib` is a crate aiming to provide utility functions to parse and work
//! with `.evtc` reports generated by arcdps.
+//!
+//! # Workflow
+//!
+//! ```no_run
+//! # use std::fs::File;
+//! // Open some file for processing
+//! let mut file = File::open("my_log.evtc").unwrap();
+//! // Parse the raw content of the file
+//! let raw_log = evtclib::raw::parse_file(&mut file).unwrap();
+//! // Process the file to do the nitty-gritty low-level stuff done
+//! let log = evtclib::process(&raw_log).unwrap();
+//! // Do work on the log
+//! ```
+//!
+//! (Look at the note on "Buffering" in the [parser
+//! module](raw/parser/index.html#buffering))
#![feature(try_trait)]
#[macro_use]
extern crate quick_error;