Merge pull request #76 from Janonard/missing-state-features

Missing State features

Author: JOOpdenhoevel

state/Cargo.toml

@@ -20,4 +20,5 @@ lv2-atom = "1.0.0"
 urid = "0.1.0"
 
 [dev-dependencies]
-lv2-urid = "2.0.0"
+lv2-urid = "2.0.0"
+mktemp = "0.4.0"

state/src/lib.rs

@@ -2,6 +2,10 @@
 //!
 //! This is a rather classic extension to LV2 plugins: There is a trait called [`State`](trait.State.html) which requires the methods [`save`](trait.State.html#tymethod.save) and [`restore`](trait.State.html#tymethiod.restore) to be implemented. These methods will be called by the host to save and restore the state of the plugin.
 //!
+//! ## Refering to files
+//!
+//! This crate also includes features to create files in a unique namespace for the plugin instance. However, these files will not persist across `save`/`restore` calls and therefore need to be safed together with the state as well. For more information, see the documentation of the [`path` module](path/index.html).
+//!
 //! ## Example usage
 //!
 //! ```
@@ -88,6 +92,8 @@ pub use raw::*;
 mod storage;
 pub use storage::Storage;
 
+pub mod path;
+
 /// Kinds of errors that may occur in the crate.
 #[derive(Clone, Copy, Debug, PartialEq, Eq)]
 pub enum StateErr {
@@ -107,6 +113,10 @@ pub enum StateErr {
     NoProperty,
     /// There isn't enough memory available to execute the task.
     NoSpace,
+    /// A path that's been used as a parameter is not encoded in UTF-8.
+    PathNotUTF8,
+    /// The host does not comply to the specification.
+    HostError,
 }
 
 impl StateErr {