From 73f788ecc9b02d7cf909f4326f6c8813cc6a39ca Mon Sep 17 00:00:00 2001 From: Katharina Fey Date: Tue, 10 Jul 2018 22:32:42 +0200 Subject: Adding docs for `UserStore` --- lockchain-core/src/users/mod.rs | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/lockchain-core/src/users/mod.rs b/lockchain-core/src/users/mod.rs index 630e2a8..0077427 100644 --- a/lockchain-core/src/users/mod.rs +++ b/lockchain-core/src/users/mod.rs @@ -102,8 +102,14 @@ impl User { impl AutoEncoder for User {} -/// A utility structure that loads user data -/// from a metadata store backend +/// A utility structure that manages users and can be derived +/// from/into a metadata object. By default this process uses +/// base64 encoding. +/// +/// The workflow for this is to create a new `UserStore`, add +/// users and then use `meta_push_domain` and give it the +/// `UserStore::into()` which is then encoded automatically. +/// The reverse action works the same way #[derive(Serialize, Deserialize)] pub struct UserStore { /// A map between username – user item -- cgit v1.2.3