aboutsummaryrefslogtreecommitdiff
path: root/lockchain-http/src/model.rs
diff options
context:
space:
mode:
Diffstat (limited to 'lockchain-http/src/model.rs')
-rw-r--r--lockchain-http/src/model.rs5
1 files changed, 5 insertions, 0 deletions
diff --git a/lockchain-http/src/model.rs b/lockchain-http/src/model.rs
index bb3eefa..bd8b6c1 100644
--- a/lockchain-http/src/model.rs
+++ b/lockchain-http/src/model.rs
@@ -3,6 +3,11 @@
use lockchain::errors::Error as LockError;
use serde::{Serialize, de::DeserializeOwned};
+/// A generic container that json wraps lockchain-types
+///
+/// This is heavily used in the lockchain-REST API and can be utilised
+/// to send both encrypted and cleartext data via the API endpoint, using
+/// the same code.
#[derive(Serialize, Deserialize)]
pub struct CarrierMessage<T: Serialize + DeserializeOwned> {
pub error: Result<(), LockError>,