Struct Parameters 

pub struct Parameters { /* private fields */ }

Parameters for configuring the Hyper server.

When starting a HyperProcess, a set of default parameters are automatically applied (matching the C++ HyperProcess behavior). You can override these defaults or disable them entirely by adding the no_default_parameters key (for example params.set("no_default_parameters", "") via Parameters::set.

Transport Modes

Use set_transport_mode to control whether Hyper uses TCP or IPC (Unix Domain Sockets on Unix systems).

Example

use hyperdb_api::{Parameters, TransportMode};

let mut params = Parameters::new();
params.set("log_file_size_limit", "100k");
params.set_transport_mode(TransportMode::Tcp); // Force TCP instead of IPC

Implementations

impl Parameters

pub fn new() -> Self

Creates a new empty Parameters instance.

pub fn set_transport_mode(&mut self, mode: TransportMode) -> &mut Self

Sets the transport mode (TCP or IPC/UDS).

By default, HyperProcess uses IPC (Unix Domain Sockets on Unix) for better performance. Use TransportMode::Tcp if you need TCP connections.

Example

use hyperdb_api::{Parameters, TransportMode};

let mut params = Parameters::new();
params.set_transport_mode(TransportMode::Tcp); // Use TCP instead of IPC

pub fn transport_mode(&self) -> Option<TransportMode>

Returns the configured transport mode.

pub fn set_domain_socket_directory( &mut self, dir: impl Into<PathBuf>, ) -> &mut Self

Sets a custom domain socket directory (Unix only).

By default, HyperProcess creates sockets in a temporary directory. Use this to specify a custom location.

pub fn domain_socket_directory(&self) -> Option<&Path>

Returns the configured domain socket directory (Unix only).

pub fn set( &mut self, key: impl Into<String>, value: impl Into<String>, ) -> &mut Self

Sets a parameter value.

Arguments

• key - The parameter name.
• value - The parameter value (empty string for flags).

pub fn set_listen_mode(&mut self, mode: ListenMode) -> &mut Self

Sets the listen mode for the Hyper server.

This controls which protocols the server listens on:

• ListenMode::LibPq: PostgreSQL wire protocol only (default)
• ListenMode::Grpc: gRPC protocol only (query-only, Arrow results)
• ListenMode::Both: Both protocols enabled

Example

use hyperdb_api::{ListenMode, Parameters};

let mut params = Parameters::new();
params.set_listen_mode(ListenMode::Grpc { port: 0 }); // Auto-assign port

pub fn listen_mode(&self) -> Option<ListenMode>

Returns the configured listen mode, if any.

pub fn get(&self, key: &str) -> Option<&str>

Gets a parameter value.

pub fn contains_key(&self, key: &str) -> bool

Returns whether the parameters contain the given key.

pub fn iter(&self) -> impl Iterator<Item = (&str, &str)>

Returns an iterator over the parameters.

pub fn is_empty(&self) -> bool

Returns whether the parameters are empty.

pub fn len(&self) -> usize

Returns the number of parameters.

Trait Implementations

impl Clone for Parameters

fn clone(&self) -> Parameters

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Parameters

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Parameters

fn default() -> Parameters

Returns the “default value” for a type.