Bookmarks serializer and data types

src/bookmarks/mod.rs

@@ -0,0 +1,103 @@
+//! ## Bookmarks
+//!
+//! `bookmarks` is the module which provides data types and de/serializer for bookmarks
+
+/*
+*
+*   Copyright (C) 2020 Christian Visintin - christian.visintin1997@gmail.com
+*
+* 	This file is part of "TermSCP"
+*
+*   TermSCP is free software: you can redistribute it and/or modify
+*   it under the terms of the GNU General Public License as published by
+*   the Free Software Foundation, either version 3 of the License, or
+*   (at your option) any later version.
+*
+*   TermSCP is distributed in the hope that it will be useful,
+*   but WITHOUT ANY WARRANTY; without even the implied warranty of
+*   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+*   GNU General Public License for more details.
+*
+*   You should have received a copy of the GNU General Public License
+*   along with TermSCP.  If not, see <http://www.gnu.org/licenses/>.
+*
+*/
+
+pub mod serializer;
+
+use serde::{Deserialize, Serialize};
+use std::collections::HashMap;
+
+#[derive(Deserialize, Serialize, std::fmt::Debug)]
+/// ## UserHosts
+///
+/// UserHosts contains all the hosts saved by the user in the data storage
+/// It contains both `Bookmark`
+pub struct UserHosts {
+    pub bookmarks: HashMap<String, Bookmark>,
+    pub recents: HashMap<String, Bookmark>,
+}
+
+#[derive(Deserialize, Serialize, std::fmt::Debug)]
+/// ## Bookmark
+///
+/// Bookmark describes a single bookmark entry in the user hosts storage
+pub struct Bookmark {
+    pub address: String,
+    pub port: u16,
+    pub protocol: String,
+    pub username: String,
+}
+
+// Errors
+
+/// ## SerializerError
+///
+/// Contains the error for serializer/deserializer
+#[derive(std::fmt::Debug)]
+pub struct SerializerError {
+    kind: SerializerErrorKind,
+    msg: Option<String>,
+}
+
+/// ## SerializerErrorKind
+///
+/// Describes the kind of error for the serializer/deserializer
+#[derive(std::fmt::Debug)]
+pub enum SerializerErrorKind {
+    IoError,
+    SerializationError,
+    SyntaxError,
+}
+
+impl SerializerError {
+    /// ### new
+    ///
+    /// Instantiate a new `SerializerError`
+    pub fn new(kind: SerializerErrorKind) -> SerializerError {
+        SerializerError { kind, msg: None }
+    }
+
+    /// ### new_ex
+    ///
+    /// Instantiates a new `SerializerError` with description message
+    pub fn new_ex(kind: SerializerErrorKind, msg: String) -> SerializerError {
+        let mut err: SerializerError = SerializerError::new(kind);
+        err.msg = Some(msg);
+        err
+    }
+}
+
+impl std::fmt::Display for SerializerError {
+    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
+        let err: String = match &self.kind {
+            SerializerErrorKind::IoError => String::from("IO Error"),
+            SerializerErrorKind::SerializationError => String::from("Serialization error"),
+            SerializerErrorKind::SyntaxError => String::from("Syntax error"),
+        };
+        match &self.msg {
+            Some(msg) => write!(f, "{} ({})", err, msg),
+            None => write!(f, "{}", err),
+        }
+    }
+}