Struct bonsaidb::server::BonsaiListenConfig

pub struct BonsaiListenConfig {
    pub address: SocketAddr,
    pub reuse_address: bool,
}

Configuration for the BonsaiDb network protocol.

The BonsaiDb network protocol is built using QUIC, which uses UDP instead of TCP.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

address: SocketAddr

The socket port to listen for connections on.

By default, this is [::]:5645.

reuse_address: bool

If this is set to true, the SO_REUSEADDR flag will be set on the listening socket.

This informs the operating system that it should allow reusing the exact same address/port combination in the future, which enables restarting a BonsaiDb network protocol listener without restarting the process itself. In general, this is not needed for users in regular deployments, and is more useful for specific kinds of testing.

Implementations

impl BonsaiListenConfig

pub fn port(self, port: u16) -> BonsaiListenConfig

Sets the port for the socket address, and returns the updated config.

pub const fn reuse_address(self, reuse_address: bool) -> BonsaiListenConfig

Sets the reuse_address flag.

Trait Implementations

impl Clone for BonsaiListenConfig

fn clone(&self) -> BonsaiListenConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BonsaiListenConfig

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

Formats the value using the given formatter.

impl Default for BonsaiListenConfig

fn default() -> BonsaiListenConfig

Returns the “default value” for a type.

impl From<u16> for BonsaiListenConfig

fn from(value: u16) -> BonsaiListenConfig

Converts to this type from the input type.

impl Copy for BonsaiListenConfig