time-lib 0.2.1

Rust library to manage personal time
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128

//! # Client
//!
//! The client connects to the server, sends requests in order to
//! control the timer and receive responses.
//!
//! The client must implement the [`Client`] trait.

#[cfg(feature = "tcp-client")]
pub mod tcp;

use async_trait::async_trait;
use log::{info, trace};
use std::io::{Error, ErrorKind, Result};

use crate::{
    request::{Request, RequestWriter},
    response::{Response, ResponseReader},
    timer::Timer,
};

/// The client trait.
///
/// Clients must implement this trait. Only the [`Client::send`]
/// function needs to be implemented: it should describe how to
/// connect and send requests to the server.
#[async_trait]
pub trait Client: Send + Sync {
    /// Send the given request and returns the associated response.
    async fn send(&self, req: Request) -> Result<Response>;

    /// Send the start timer request.
    async fn start(&self) -> Result<()> {
        info!("sending request to start timer");

        match self.send(Request::Start).await {
            Ok(Response::Ok) => Ok(()),
            Ok(res) => Err(Error::new(
                ErrorKind::InvalidData,
                format!("invalid response: {res:?}"),
            )),
            Err(err) => Err(Error::new(ErrorKind::Other, err)),
        }
    }

    /// Send the get timer request.
    async fn get(&self) -> Result<Timer> {
        info!("sending request to get timer");

        match self.send(Request::Get).await {
            Ok(Response::Timer(timer)) => {
                trace!("timer: {timer:#?}");
                Ok(timer)
            }
            Ok(res) => Err(Error::new(
                ErrorKind::InvalidData,
                format!("invalid response: {res:?}"),
            )),
            Err(err) => Err(Error::new(ErrorKind::Other, err)),
        }
    }

    /// Send the set timer request.
    async fn set(&self, duration: usize) -> Result<()> {
        info!("sending request to set timer duration");

        match self.send(Request::Set(duration)).await {
            Ok(Response::Ok) => Ok(()),
            Ok(res) => Err(Error::new(
                ErrorKind::InvalidData,
                format!("invalid response: {res:?}"),
            )),
            Err(err) => Err(Error::new(ErrorKind::Other, err)),
        }
    }

    /// Send the pause timer request.
    async fn pause(&self) -> Result<()> {
        info!("sending request to pause timer");

        match self.send(Request::Pause).await {
            Ok(Response::Ok) => Ok(()),
            Ok(res) => Err(Error::new(
                ErrorKind::InvalidData,
                format!("invalid response: {res:?}"),
            )),
            Err(err) => Err(Error::new(ErrorKind::Other, err)),
        }
    }

    /// Send the resume timer request.
    async fn resume(&self) -> Result<()> {
        info!("sending request to resume timer");

        match self.send(Request::Resume).await {
            Ok(Response::Ok) => Ok(()),
            Ok(res) => Err(Error::new(
                ErrorKind::InvalidData,
                format!("invalid response: {res:?}"),
            )),
            Err(err) => Err(Error::new(ErrorKind::Other, err)),
        }
    }

    /// Send the stop timer request.
    async fn stop(&self) -> Result<()> {
        info!("sending request to stop timer");

        match self.send(Request::Stop).await {
            Ok(Response::Ok) => Ok(()),
            Ok(res) => Err(Error::new(
                ErrorKind::InvalidData,
                format!("invalid response: {res:?}"),
            )),
            Err(err) => Err(Error::new(ErrorKind::Other, err)),
        }
    }
}

/// The client stream trait.
#[async_trait]
pub trait ClientStream: RequestWriter + ResponseReader {
    async fn handle(&mut self, req: Request) -> Result<Response> {
        self.write(req).await?;
        self.read().await
    }
}

impl<T: RequestWriter + ResponseReader> ClientStream for T {}