summaryrefslogtreecommitdiff
path: root/dhall/src/traits/deserialize.rs
diff options
context:
space:
mode:
authorNadrieril2019-04-13 00:44:58 +0200
committerNadrieril2019-04-13 00:44:58 +0200
commite7e79bf32c385fa8c30a45be262ca3d6d8f1f653 (patch)
tree769651e0c22c9d15069f8fee24c82a3eecfb1f1d /dhall/src/traits/deserialize.rs
parentca0939f4cdf373ca735f25926d0a02c698d7f1cf (diff)
Document all of the API
Closes #64
Diffstat (limited to 'dhall/src/traits/deserialize.rs')
-rw-r--r--dhall/src/traits/deserialize.rs7
1 files changed, 7 insertions, 0 deletions
diff --git a/dhall/src/traits/deserialize.rs b/dhall/src/traits/deserialize.rs
index f1be054..e2e0b05 100644
--- a/dhall/src/traits/deserialize.rs
+++ b/dhall/src/traits/deserialize.rs
@@ -1,7 +1,14 @@
use crate::error::*;
use crate::expr::*;
+/// A data structure that can be deserialized from a Dhall expression
+///
+/// This is automatically implemented for any type that [serde][serde]
+/// can deserialize.
+///
+/// This trait cannot be implemented manually.
pub trait Deserialize<'a>: Sized {
+ /// See [dhall::from_str][crate::from_str]
fn from_str(s: &'a str, ty: Option<&Type>) -> Result<Self>;
}