aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorDaniel Schadt <kingdread@gmx.de>2020-05-02 14:23:07 +0200
committerDaniel Schadt <kingdread@gmx.de>2020-05-02 14:23:07 +0200
commitcea9d932c57c065492f900b9c465423f5a529a2a (patch)
tree776164ef4e58c898fbc4f5454c24d119d6ed6172 /src
parent8b14355557ca7bf19318d0f8d4b54ce439cdc8c8 (diff)
downloadevtclib-cea9d932c57c065492f900b9c465423f5a529a2a.tar.gz
evtclib-cea9d932c57c065492f900b9c465423f5a529a2a.tar.bz2
evtclib-cea9d932c57c065492f900b9c465423f5a529a2a.zip
add a note about writing evtc files
Diffstat (limited to 'src')
-rw-r--r--src/lib.rs12
1 files changed, 12 insertions, 0 deletions
diff --git a/src/lib.rs b/src/lib.rs
index cc407e8..e28e740 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -53,6 +53,18 @@
//!
//! Make sure to take a look at the note on "Buffering" in the [parser
//! module](raw/parser/index.html#buffering) in order to increase the speed of your application.
+//!
+//! # Writing evtc Files
+//!
+//! Currently, `evtclib` does not provide a way to output or modify evtc files. This is for two
+//! reasons:
+//!
+//! * The only sensible source for logs is the arcdps addon itself, most applications only consume
+//! them.
+//! * The library was needed for reading support, and writing support has never been a priority.
+//!
+//! While there are legitimate use cases for writing/modification support, they are currently not
+//! implemented (but might be in a future version).
use std::convert::TryFrom;
use std::marker::PhantomData;