foundationdb::api

Struct NetworkBuilder

Source
pub struct NetworkBuilder { /* private fields */ }
Expand description

A Builder to configure network options and start the network event loop.

use foundationdb::api::FdbApiBuilder;

let network_builder = FdbApiBuilder::default().build().expect("fdb api initialized");
network_builder.boot().expect("fdb network running");

Implementations§

Source§

impl NetworkBuilder

Source

pub fn set_option(self, option: NetworkOption) -> FdbResult<Self>

Set network options.

§Errors
  • error 2009 (network_already_setup) once the network is running
  • error 2025 (network_cannot_be_restarted) once the network is stopped
Source

pub fn boot(self) -> FdbResult<NetworkAutoStop>

Starts the FoundationDB network event loop in a dedicated thread.

Safe and idempotent: booting an already running network is a no-op. The network runs until process exit, where an atexit hook stops it and joins the network thread, or until an explicit stop_network call.

§Errors
  • error 2025 (network_cannot_be_restarted) if the network was stopped
§Examples
use foundationdb::api::FdbApiBuilder;

let network_builder = FdbApiBuilder::default().build().expect("fdb api initialized");
network_builder.boot().expect("fdb network running");
// do some interesting things with the API...
use foundationdb::api::FdbApiBuilder;

#[tokio::main]
async fn main() {
    let network_builder = FdbApiBuilder::default().build().expect("fdb api initialized");
    network_builder.boot().expect("fdb network running");
    // do some interesting things with the API...
}

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.