skytable 0.8.7

Official Rust client driver for Skytable
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

/*
 * Copyright 2024, Sayan Nandan <nandansayan@outlook.com>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
*/

use {
    super::{
        state::{DecodeState, RState, ResponseState},
        Decoder, ProtocolError,
    },
    crate::response::Response,
};

const ILLEGAL_PACKET_ESCAPE: u8 = 0xFF;

#[derive(Debug, PartialEq, Default)]
pub(crate) struct MRespState {
    processed: Vec<Response>,
    pending: Option<ResponseState>,
}

#[derive(Debug, PartialEq)]
pub(crate) enum PipelineResult {
    Completed(Vec<Response>),
    Pending(MRespState),
    Error(ProtocolError),
}

impl MRespState {
    #[cold]
    fn except() -> PipelineResult {
        PipelineResult::Error(ProtocolError::InvalidPacket)
    }
    fn step(mut self, decoder: &mut Decoder, expected: usize) -> PipelineResult {
        loop {
            if decoder._cursor_eof() {
                return PipelineResult::Pending(self);
            }
            if decoder._cursor_value() == ILLEGAL_PACKET_ESCAPE {
                return Self::except();
            }
            match decoder.validate_response(RState(
                self.pending.take().unwrap_or(ResponseState::Initial),
            )) {
                DecodeState::ChangeState(RState(s)) => {
                    self.pending = Some(s);
                    return PipelineResult::Pending(self);
                }
                DecodeState::Completed(c) => {
                    self.processed.push(c);
                    if self.processed.len() == expected {
                        return PipelineResult::Completed(self.processed);
                    }
                }
                DecodeState::Error(e) => return PipelineResult::Error(e),
            }
        }
    }
}

impl<'a> Decoder<'a> {
    pub fn validate_pipe(&mut self, expected: usize, state: MRespState) -> PipelineResult {
        state.step(self, expected)
    }
}

#[cfg(test)]
const QUERY: &[u8] = b"\x12\x10\xFF\xFF\x115\n\x00\x01\x01\x0D5\nsayan\x0220\n\x0E0\n\x115\n\x00\x01\x01\x0D5\nelana\x0221\n\x0E0\n\x115\n\x00\x01\x01\x0D5\nemily\x0222\n\x0E0\n";

#[test]
fn t_pipe() {
    use crate::response::{Response, Row, Value};
    let mut decoder = Decoder::new(QUERY, 0);
    assert_eq!(
        decoder.validate_pipe(5, MRespState::default()),
        PipelineResult::Completed(vec![
            Response::Empty,
            Response::Error(u16::MAX),
            Response::Row(Row::new(vec![
                Value::Null,
                Value::Bool(true),
                Value::String("sayan".into()),
                Value::UInt8(20),
                Value::List(vec![])
            ])),
            Response::Row(Row::new(vec![
                Value::Null,
                Value::Bool(true),
                Value::String("elana".into()),
                Value::UInt8(21),
                Value::List(vec![])
            ])),
            Response::Row(Row::new(vec![
                Value::Null,
                Value::Bool(true),
                Value::String("emily".into()),
                Value::UInt8(22),
                Value::List(vec![])
            ]))
        ])
    );
}

#[test]
fn t_pipe_staged() {
    for i in Decoder::MIN_READBACK..QUERY.len() {
        let mut dec = Decoder::new(&QUERY[..i], 0);
        if i < 3 {
            assert!(matches!(
                dec.validate_pipe(5, MRespState::default()),
                PipelineResult::Pending(_)
            ));
        } else {
            assert!(matches!(
                dec.validate_pipe(5, MRespState::default()),
                PipelineResult::Pending(_)
            ));
        }
    }
}