Struct foundationdb::fdb_api::FdbApiBuilder

pub struct FdbApiBuilder { /* private fields */ }

A Builder with which different versions of the Fdb C API can be initialized

Implementations

impl FdbApiBuilder

pub fn set_runtime_version(self, version: i32) -> Self

The version of run-time behavior the API is requested to provide.

Must be less than or equal to header_version, foundationdb_sys::FDB_API_VERSION, and should almost always be equal. Language bindings which themselves expose API versioning will usually pass the version requested by the application.

pub fn set_header_version(self, version: i32) -> Self

The version of the ABI (application binary interface) that the calling code expects to find in the shared library.

If you are using an FFI, this must correspond to the version of the API you are using as a reference (currently 510). For example, the number of arguments that a function takes may be affected by this value, and an incorrect value is unlikely to yield success.

TODO: it is likely that this should never be changed, and be pinned to the sys crates versions… may be removed.

pub fn build(self) -> Result<FdbApi>

The API version can only be initialized once in the lifetime of a process

Trait Implementations

impl Default for FdbApiBuilder

fn default() -> Self

Returns the “default value” for a type.