From f6d89fdfb7eba61d435b743168707dfc0507d49e Mon Sep 17 00:00:00 2001
From: Avril <flanchan@cumallover.me>
Date: Wed, 23 Sep 2020 19:11:04 +0100
Subject: [PATCH] start base64 serialiser

---
 src/main.rs | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/main.rs b/src/main.rs
index b56417b..12f0d9e 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -70,6 +70,10 @@ pub mod serialise
 {
     use super::*;
 
+    /// Serialise this object into base64 text
+    ///
+    /// # TODO
+    /// Line wrapping
     #[instrument(err, skip(value), fields(value_type=?std::any::type_name::<T>()))]
     pub fn into_text<T: Serialize>(value: &T) -> Result<String, Error>
     {
@@ -108,6 +112,7 @@ pub mod serialise
 	}
     }
 
+    /// Try to deserialise this object from text.
     #[instrument(err, skip(string), fields(string = ?string.as_ref()))]
     pub fn from_text<T: serde::de::DeserializeOwned>(string: impl AsRef<[u8]>) -> Result<T, Error>
     {