boltr 0.1.1

Pure-Rust Bolt v5.x wire protocol library
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

//! Encode Bolt messages to PackStream bytes.

use bytes::BytesMut;

use super::{ClientMessage, ServerMessage, sig};
use crate::packstream::encode as ps;
use crate::types::BoltValue;

/// Encodes a client message into PackStream bytes.
pub fn encode_client_message(buf: &mut BytesMut, msg: &ClientMessage) {
    match msg {
        ClientMessage::Hello { extra } => {
            ps::encode_struct_header(buf, sig::HELLO, 1);
            ps::encode_dict(buf, extra);
        }
        ClientMessage::Logon { auth } => {
            ps::encode_struct_header(buf, sig::LOGON, 1);
            ps::encode_dict(buf, auth);
        }
        ClientMessage::Logoff => {
            ps::encode_struct_header(buf, sig::LOGOFF, 0);
        }
        ClientMessage::Goodbye => {
            ps::encode_struct_header(buf, sig::GOODBYE, 0);
        }
        ClientMessage::Reset => {
            ps::encode_struct_header(buf, sig::RESET, 0);
        }
        ClientMessage::Run {
            query,
            parameters,
            extra,
        } => {
            ps::encode_struct_header(buf, sig::RUN, 3);
            ps::encode_string(buf, query);
            ps::encode_dict(buf, parameters);
            ps::encode_dict(buf, extra);
        }
        ClientMessage::Pull { extra } => {
            ps::encode_struct_header(buf, sig::PULL, 1);
            ps::encode_dict(buf, extra);
        }
        ClientMessage::Discard { extra } => {
            ps::encode_struct_header(buf, sig::DISCARD, 1);
            ps::encode_dict(buf, extra);
        }
        ClientMessage::Begin { extra } => {
            ps::encode_struct_header(buf, sig::BEGIN, 1);
            ps::encode_dict(buf, extra);
        }
        ClientMessage::Commit => {
            ps::encode_struct_header(buf, sig::COMMIT, 0);
        }
        ClientMessage::Rollback => {
            ps::encode_struct_header(buf, sig::ROLLBACK, 0);
        }
        ClientMessage::Route {
            routing,
            bookmarks,
            extra,
        } => {
            ps::encode_struct_header(buf, sig::ROUTE, 3);
            ps::encode_dict(buf, routing);
            let bm_values: Vec<BoltValue> = bookmarks
                .iter()
                .map(|s| BoltValue::String(s.clone()))
                .collect();
            ps::encode_list(buf, &bm_values);
            ps::encode_dict(buf, extra);
        }
        ClientMessage::Telemetry { api } => {
            ps::encode_struct_header(buf, sig::TELEMETRY, 1);
            ps::encode_value(buf, &BoltValue::Integer(*api));
        }
    }
}

/// Encodes a server message into PackStream bytes.
pub fn encode_server_message(buf: &mut BytesMut, msg: &ServerMessage) {
    match msg {
        ServerMessage::Success { metadata } => {
            ps::encode_struct_header(buf, sig::SUCCESS, 1);
            ps::encode_dict(buf, metadata);
        }
        ServerMessage::Record { data } => {
            ps::encode_struct_header(buf, sig::RECORD, 1);
            ps::encode_list(buf, data);
        }
        ServerMessage::Failure { metadata } => {
            ps::encode_struct_header(buf, sig::FAILURE, 1);
            ps::encode_dict(buf, metadata);
        }
        ServerMessage::Ignored => {
            ps::encode_struct_header(buf, sig::IGNORED, 0);
        }
    }
}

/// Convenience: encode a server SUCCESS with the given key-value metadata.
pub fn encode_success(buf: &mut BytesMut, metadata: &std::collections::HashMap<String, BoltValue>) {
    encode_server_message(
        buf,
        &ServerMessage::Success {
            metadata: metadata.clone(),
        },
    );
}