From 716ad2b29e912f8a90bc1cd54c91483b38665be2 Mon Sep 17 00:00:00 2001
From: Alexander Andreev <andreevlex.as@gmail.com>
Date: Fri, 13 Apr 2018 21:41:01 +0300
Subject: [PATCH] added doc strings

---
 src/error.rs |  3 ++-
 src/lib.rs   | 16 ++++++++++++++++
 2 files changed, 18 insertions(+), 1 deletion(-)

diff --git a/src/error.rs b/src/error.rs
index 6d0297b..4f1a814 100644
--- a/src/error.rs
+++ b/src/error.rs
@@ -1,11 +1,12 @@
 //! Error and Result module
 
-use failure::{self, Fail};
+use failure;
 use serde_json;
 use std::{io, result};
 
 pub type Result<T> = result::Result<T, Error>;
 
+// General error the crate
 #[derive(Fail, Debug)]
 pub enum Error {
     #[fail(display = "Invalid header protocol")]
diff --git a/src/lib.rs b/src/lib.rs
index 6d97f13..17600b9 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,3 +1,9 @@
+//! The library implementation Zabbix sender protocol
+//! more details:
+//! [Zabbix Documentation - 4 Trapper items](https://www.zabbix.com/documentation/3.0/manual/appendix/items/trapper).
+//! [Docs/protocols/zabbix sender/2.0](https://www.zabbix.org/wiki/Docs/protocols/zabbix_sender/2.0).
+//!
+
 #[macro_use]
 extern crate serde_derive;
 extern crate byteorder;
@@ -18,16 +24,19 @@ use byteorder::{LittleEndian, ReadBytesExt, WriteBytesExt};
 const ZBX_HDR: &'static [u8; 5] = b"ZBXD\x01";
 const ZBX_HDR_SIZE: usize = 13;
 
+/// implementation Zabbix sender protocol.
 pub struct Sender {
     server: String,
     port: u16,
 }
 
 impl Sender {
+    /// Creates a new instance of the client zabbix.
     pub fn new(server: String, port: u16) -> Sender {
         Sender { server, port }
     }
 
+    /// Sends data to the server according to Protocol rules
     pub fn send<T>(&self, msg: T) -> Result<Response>
     where
         T: ToMessage,
@@ -66,6 +75,7 @@ impl Sender {
     }
 }
 
+/// Data item sent to the server.
 #[derive(Serialize, Deserialize, Debug, Clone)]
 pub struct SendValue {
     host: String,
@@ -84,6 +94,7 @@ impl<'a> From<(&'a str, &'a str, &'a str)> for SendValue {
     }
 }
 
+/// The message that is sent to the Zabbix server.
 #[derive(Serialize, Deserialize, Debug, Clone)]
 pub struct Message {
     request: &'static str,
@@ -91,8 +102,10 @@ pub struct Message {
 }
 
 impl Message {
+    /// Constant request header to the server.
     const REQUEST: &'static str = "sender data";
 
+    /// Creating a new instance of the Message structure from SendValue.
     pub fn new(value: SendValue) -> Message {
         Message {
             request: Message::REQUEST,
@@ -100,6 +113,7 @@ impl Message {
         }
     }
 
+    /// Adds an entry to send a composed message.
     pub fn add(&mut self, value: SendValue) {
         self.data.push(value)
     }
@@ -114,6 +128,7 @@ impl Default for Message {
     }
 }
 
+/// Contract for types that provide the ability to cast to a `Message` type.
 pub trait ToMessage {
     fn to_message(self) -> Message;
 }
@@ -145,6 +160,7 @@ impl ToMessage for Vec<SendValue> {
     }
 }
 
+/// Structure of Zabbix server's response
 #[derive(Serialize, Deserialize, Debug, Clone)]
 pub struct Response {
     response: String,