knafeh 1.1.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

use async_trait::async_trait;

use crate::error::KnafehError;
use crate::rpc::message::{RpcRequest, RpcResponse};
use crate::rpc::stream::{RpcStreamRequest, RpcStreamResponse};

/// Describes the type of an RPC method.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum MethodKind {
    /// Unary request/response.
    Unary,
    /// Server streams response chunks to the client.
    ServerStreaming,
    /// Client streams request chunks to the server.
    ClientStreaming,
    /// Both sides stream concurrently.
    BidiStreaming,
}

/// Metadata about a single RPC method.
#[derive(Debug, Clone)]
pub struct MethodDescriptor {
    pub name: String,
    pub kind: MethodKind,
}

/// A service that handles RPC calls.
///
/// Implement this trait to define your RPC service. Each service has a name
/// and a set of methods. The framework routes incoming requests by matching
/// `"{service_name}/{method_name}"` paths.
#[async_trait]
pub trait Service: Send + Sync + 'static {
    /// The service name used for routing (e.g., `"greeter"`).
    fn name(&self) -> &str;

    /// List all methods this service exposes.
    fn methods(&self) -> Vec<MethodDescriptor>;

    /// Handle a unary RPC call.
    async fn call_unary(
        &self,
        method: &str,
        request: RpcRequest,
    ) -> Result<RpcResponse, KnafehError>;

    /// Handle a server-streaming RPC call.
    async fn call_server_stream(
        &self,
        method: &str,
        request: RpcRequest,
    ) -> Result<RpcStreamResponse, KnafehError>;

    /// Handle a client-streaming RPC call.
    async fn call_client_stream(
        &self,
        method: &str,
        stream: RpcStreamRequest,
    ) -> Result<RpcResponse, KnafehError>;

    /// Handle a bidirectional-streaming RPC call.
    async fn call_bidi_stream(
        &self,
        method: &str,
        stream: RpcStreamRequest,
    ) -> Result<RpcStreamResponse, KnafehError>;
}