zlink-core 0.4.1

The core crate of the zlink project
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

//! Method reply API.

use serde::{Deserialize, Serialize};

/// A successful method call reply.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Reply<Params> {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub(super) parameters: Option<Params>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub(super) continues: Option<bool>,
}

impl<Params> Reply<Params> {
    /// Create a new reply.
    pub fn new(parameters: Option<Params>) -> Self {
        Self {
            parameters,
            continues: None,
        }
    }

    /// Set the continues flag.
    pub fn set_continues(mut self, continues: Option<bool>) -> Self {
        self.continues = continues;
        self
    }

    /// The parameters of the reply.
    pub fn parameters(&self) -> Option<&Params> {
        self.parameters.as_ref()
    }

    /// Convert the reply into its parameters.
    pub fn into_parameters(self) -> Option<Params> {
        self.parameters
    }

    /// If there are more replies to come.
    pub fn continues(&self) -> Option<bool> {
        self.continues
    }

    /// Map the parameters of this reply using the provided function.
    pub fn map<U, F>(self, f: F) -> Reply<U>
    where
        F: FnOnce(Params) -> U,
    {
        Reply {
            parameters: self.parameters.map(f),
            continues: self.continues,
        }
    }
}

impl<Params> From<Params> for Reply<Params> {
    fn from(parameters: Params) -> Self {
        Self::new(Some(parameters))
    }
}

/// A reply result.
pub type Result<Params, Error> = core::result::Result<Reply<Params>, Error>;