knafeh 1.0.0

QUIC-based RPC library with Python bindings
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

use std::collections::HashMap;

use crate::error::RpcStatusCode;

/// Metadata attached to RPC requests and responses (maps to HTTP headers).
pub type Metadata = HashMap<String, String>;

/// An RPC request from client to server.
#[derive(Debug, Clone)]
pub struct RpcRequest {
    /// Fully qualified method path: `"service_name/method_name"`.
    pub method: String,
    /// Key-value metadata (transmitted as HTTP headers with `x-rpc-` prefix).
    pub metadata: Metadata,
    /// Serialized request payload.
    pub body: Vec<u8>,
}

/// An RPC response from server to client.
#[derive(Debug, Clone)]
pub struct RpcResponse {
    /// Status of the RPC call.
    pub status: RpcStatus,
    /// Key-value metadata (transmitted as HTTP headers).
    pub metadata: Metadata,
    /// Serialized response payload.
    pub body: Vec<u8>,
}

/// The status of a completed RPC call.
#[derive(Debug, Clone)]
pub struct RpcStatus {
    pub code: RpcStatusCode,
    pub message: String,
}

impl RpcRequest {
    pub fn new(method: impl Into<String>, body: Vec<u8>) -> Self {
        Self {
            method: method.into(),
            metadata: Metadata::new(),
            body,
        }
    }

    pub fn with_metadata(mut self, key: impl Into<String>, value: impl Into<String>) -> Self {
        self.metadata.insert(key.into(), value.into());
        self
    }

    /// Extract the service name from the method path.
    pub fn service_name(&self) -> Option<&str> {
        self.method.split('/').next()
    }

    /// Extract the method name from the method path.
    pub fn method_name(&self) -> Option<&str> {
        self.method.split('/').nth(1)
    }
}

impl RpcResponse {
    pub fn ok(body: Vec<u8>) -> Self {
        Self {
            status: RpcStatus {
                code: RpcStatusCode::Ok,
                message: String::new(),
            },
            metadata: Metadata::new(),
            body,
        }
    }

    pub fn error(code: RpcStatusCode, message: impl Into<String>) -> Self {
        Self {
            status: RpcStatus {
                code,
                message: message.into(),
            },
            metadata: Metadata::new(),
            body: Vec::new(),
        }
    }

    pub fn with_metadata(mut self, key: impl Into<String>, value: impl Into<String>) -> Self {
        self.metadata.insert(key.into(), value.into());
        self
    }
}

impl RpcStatus {
    pub fn ok() -> Self {
        Self {
            code: RpcStatusCode::Ok,
            message: String::new(),
        }
    }

    pub fn is_ok(&self) -> bool {
        self.code == RpcStatusCode::Ok
    }
}