Struct Dsn

Source

pub struct Dsn { /* private fields */ }

Expand description

Parsed DSN (Data Source Name) for Geode connections.

Contains all connection parameters extracted from a DSN string.

Implementations§

Source §

impl Dsn

Source

pub fn parse(dsn: &str) -> Result<Self>

Parse a DSN string into a Dsn struct.

§Supported formats

quic://host:port?options - QUIC transport (recommended)
grpc://host:port?options - gRPC transport
grpcs://host:port?options - gRPC transport with TLS forced on
host:port?options - Defaults to QUIC

§Supported options (query parameters)

tls - Enable/disable TLS (0/1/true/false, default: true)
insecure, skip_verify, insecure_skip_verify - Skip TLS verification
page_size - Results page size (default: 1000)
client_name or hello_name - Client name
client_version or hello_ver - Client version
conformance - GQL conformance level
username or user - Authentication username
password or pass - Authentication password
ca or ca_cert - Path to CA certificate
cert or client_cert - Path to client certificate (mTLS)
key or client_key - Path to client key (mTLS)
server_name - SNI server name
connect_timeout or timeout - Connection timeout in seconds

§Errors

Returns Error::InvalidDsn if:

DSN is empty
Scheme is unsupported
Host is missing
Port is invalid

§Examples

use geode_client::dsn::Dsn;

let dsn = Dsn::parse("quic://localhost:3141").unwrap();
let dsn = Dsn::parse("grpc://127.0.0.1:50051?tls=0").unwrap();
let dsn = Dsn::parse("grpc://[::1]:50051").unwrap();

Source

pub fn transport(&self) -> Transport

Get the transport protocol.

Source

pub fn host(&self) -> &str

Get the host.

Source

pub fn port(&self) -> u16

Get the port.

Source

pub fn username(&self) -> Option<&str>

Get the username if specified.

Source

pub fn password(&self) -> Option<&str>

Get the password if specified.

Source

pub fn tls_enabled(&self) -> bool

Check if TLS is enabled.

Source

pub fn skip_verify(&self) -> bool

Check if TLS verification should be skipped.

Source

pub fn page_size(&self) -> usize

Get the page size.

Source

pub fn client_name(&self) -> &str

Get the client name.

Source

pub fn client_version(&self) -> &str

Get the client version.

Source

pub fn conformance(&self) -> &str

Get the conformance level.

Source

pub fn options(&self) -> &HashMap<String, String>

Get additional options.

Source

pub fn ca_cert(&self) -> Option<&str>

Get the CA certificate path if specified.

Source

pub fn client_cert(&self) -> Option<&str>

Get the client certificate path if specified.

Source

pub fn client_key(&self) -> Option<&str>

Get the client key path if specified.

Source

pub fn server_name(&self) -> Option<&str>

Get the SNI server name if specified.

Source

pub fn connect_timeout_secs(&self) -> Option<u64>

Get the connection timeout in seconds if specified.

Source

pub fn graph(&self) -> Option<&str>

Get the graph name if specified.

Source

pub fn address(&self) -> String

Get the host:port address string.

Source

pub fn to_dsn(&self) -> String

Format this DSN back into a connection-string form.

Mirrors the Go reference client’s Config.FormatDSN: emits scheme://userinfo@host:port?onlyNonDefaultParams. Only parameters that differ from the defaults are emitted, query keys are sorted for determinism, and userinfo/values are percent-encoded.

Credentials follow Go’s rules: a username with a password becomes user:pass@, a username alone becomes user@, and a password without a username falls back to a pass= query parameter (since userinfo cannot carry a password-only credential).

The result round-trips through Dsn::parse.

§Example

use geode_client::dsn::Dsn;

let dsn = Dsn::parse("quic://localhost:3141?page_size=500").unwrap();
let s = dsn.to_dsn();
assert_eq!(Dsn::parse(&s).unwrap(), dsn);