gwp 0.2.1

A standalone, pure Rust gRPC wire protocol for GQL (ISO/IEC 39075)
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

//! gRPC connection management.

use tonic::transport::Channel;

use crate::error::GqlError;

use super::GqlSession;
use super::admin::AdminClient;
use super::catalog::CatalogClient;
use super::search::SearchClient;

/// A connection to a GQL wire protocol server.
///
/// Manages the gRPC channel and provides session creation.
#[derive(Debug, Clone)]
pub struct GqlConnection {
    channel: Channel,
}

impl GqlConnection {
    /// Connect to a GQL server at the given endpoint.
    ///
    /// # Errors
    ///
    /// Returns an error if the connection cannot be established.
    ///
    /// # Examples
    ///
    /// ```no_run
    /// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
    /// use gwp::client::GqlConnection;
    ///
    /// let conn = GqlConnection::connect("http://localhost:50051").await?;
    /// # Ok(())
    /// # }
    /// ```
    pub async fn connect(endpoint: &str) -> Result<Self, GqlError> {
        let channel = Channel::from_shared(endpoint.to_owned())
            .map_err(|e| GqlError::Protocol(e.to_string()))?
            .connect()
            .await?;

        Ok(Self { channel })
    }

    /// Create a connection from an existing tonic channel.
    #[must_use]
    pub fn from_channel(channel: Channel) -> Self {
        Self { channel }
    }

    /// Perform a handshake and return a session.
    ///
    /// # Errors
    ///
    /// Returns an error if the handshake fails.
    pub async fn create_session(&self) -> Result<GqlSession, GqlError> {
        GqlSession::new(self.channel.clone()).await
    }

    /// Create a catalog management client (schemas, graphs, graph types).
    #[must_use]
    pub fn create_catalog_client(&self) -> CatalogClient {
        CatalogClient::new(self.channel.clone())
    }

    /// Create an admin client (stats, WAL, validation, indexes).
    #[must_use]
    pub fn create_admin_client(&self) -> AdminClient {
        AdminClient::new(self.channel.clone())
    }

    /// Create a search client (vector, text, hybrid).
    #[must_use]
    pub fn create_search_client(&self) -> SearchClient {
        SearchClient::new(self.channel.clone())
    }

    /// Connect to a GQL server with TLS.
    ///
    /// Requires the `tls` feature to be enabled.
    ///
    /// # Errors
    ///
    /// Returns an error if the connection cannot be established.
    #[cfg(feature = "tls")]
    pub async fn connect_tls(
        endpoint: &str,
        tls_config: tonic::transport::ClientTlsConfig,
    ) -> Result<Self, GqlError> {
        let channel = Channel::from_shared(endpoint.to_owned())
            .map_err(|e| GqlError::Protocol(e.to_string()))?
            .tls_config(tls_config)
            .map_err(|e| GqlError::Protocol(e.to_string()))?
            .connect()
            .await?;

        Ok(Self { channel })
    }

    /// Get the underlying tonic channel.
    #[must_use]
    pub fn channel(&self) -> &Channel {
        &self.channel
    }
}