cocaine 0.9.2

Cocaine Framework Rust
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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170

use std::error;
use std::fmt::{self, Display, Formatter};
use rmpv::ValueRef;

/// Framing error.
#[derive(Clone, Copy, Debug, PartialEq)]
pub enum Error {
    /// Frame must be an array.
    InvalidFrameType,
    /// Frame size must be 3 or 4.
    SizeMismatch(usize),
    /// Channel id type must be an u64.
    SpanTypeMismatch,
    /// Type id type must be an u64.
    TypeTypeMismatch,
}

impl error::Error for Error {
    fn description(&self) -> &str {
        match *self {
            Error::InvalidFrameType => "protocol frame has invalid type",
            Error::SizeMismatch(..) => "protocol frame has invalid size, expected 3 or 4",
            Error::SpanTypeMismatch => "span field has invalid type",
            Error::TypeTypeMismatch => "type field has invalid type",
        }
    }

    fn cause(&self) -> Option<&error::Error> {
        None
    }
}

impl Display for Error {
    fn fmt(&self, fmt: &mut Formatter) -> Result<(), fmt::Error> {
        match *self {
            Error::InvalidFrameType => "protocol frame has invalid type, must be an array".fmt(fmt),
            Error::SizeMismatch(size) => {
                write!(fmt, "protocol frame has invalid size, expected 3 or 4, found {}", size)
            }
            Error::SpanTypeMismatch => "span field has invalid type".fmt(fmt),
            Error::TypeTypeMismatch => "type field has invalid type".fmt(fmt),
        }
    }
}

static NIL: ValueRef<'static> = ValueRef::Nil;

#[derive(Debug)]
pub struct Frame<'a: 'b, 'b> {
    id: u64,
    ty: u64,
    args: &'b ValueRef<'a>,
    meta: &'b ValueRef<'a>,
}

impl<'a, 'b> Display for Frame<'a, 'b> {
    fn fmt(&self, fmt: &mut Formatter) -> Result<(), fmt::Error> {
        write!(fmt, "[{}, {}, {}, {}]", self.id, self.ty, self.args, self.meta)
    }
}

impl<'a, 'b> Frame<'a, 'b> {
    pub fn new(frame: &'b ValueRef<'a>) -> Result<Self, Error> {
        if let ValueRef::Array(ref vec) = *frame {
            match vec.len() {
                3 => {
                    let id = vec[0].as_u64().ok_or(Error::SpanTypeMismatch)?;
                    let ty = vec[1].as_u64().ok_or(Error::TypeTypeMismatch)?;
                    let args = &vec[2];

                    let message = Frame {
                        id: id,
                        ty: ty,
                        args: args,
                        meta: &NIL,
                    };

                    Ok(message)
                }
                4 => {
                    let id = vec[0].as_u64().ok_or(Error::SpanTypeMismatch)?;
                    let ty = vec[1].as_u64().ok_or(Error::TypeTypeMismatch)?;
                    let args = &vec[2];
                    let meta = &vec[3];

                    let message = Frame {
                        id: id,
                        ty: ty,
                        args: args,
                        meta: meta,
                    };

                    Ok(message)
                }
                len => Err(Error::SizeMismatch(len)),
            }
        } else {
            Err(Error::InvalidFrameType)
        }
    }

    pub fn id(&self) -> u64 {
        self.id
    }

    pub fn ty(&self) -> u64 {
        self.ty
    }

    pub fn args(&self) -> &ValueRef {
        self.args
    }

    pub fn meta(&self) -> &ValueRef {
        self.meta
    }
}

#[cfg(test)]
mod test {
    use rmpv::ValueRef;

    use super::Frame;

    #[test]
    fn pass() {
        let val = ValueRef::Array(vec![
            ValueRef::from(1),
            ValueRef::from(0),
            ValueRef::Array(vec![]),
        ]);

        let frame = Frame::new(&val).unwrap();
        assert_eq!(1, frame.id());
        assert_eq!(0, frame.ty());
        assert_eq!(&ValueRef::Array(vec![]), frame.args());
    }

    #[test]
    #[should_panic(expected = "InvalidFrameType")]
    fn fail_invalid_frame_type() {
        let val = ValueRef::from(42);

        Frame::new(&val).unwrap();
    }

    #[test]
    #[should_panic(expected = "SpanTypeMismatch")]
    fn fail_invalid_chan_type() {
        let val = ValueRef::from(vec![
            ValueRef::from("1"),
            ValueRef::from(0),
            ValueRef::Array(vec![]),
        ]);

        Frame::new(&val).unwrap();
    }

    #[test]
    #[should_panic(expected = "TypeTypeMismatch")]
    fn fail_invalid_type_type() {
        let val = ValueRef::from(vec![
            ValueRef::from(1),
            ValueRef::from("0"),
            ValueRef::Array(vec![]),
        ]);

        Frame::new(&val).unwrap();
    }
}