Struct bonsaidb_files::direct::FileBuilder

pub struct FileBuilder<'a, Config>
where
    Config: FileConfig,
{ /* private fields */ }

A builder to create a File.

Implementations

impl<'a, Config: FileConfig> FileBuilder<'a, Config>

pub fn at_path<Path: Into<String>>(self, path: Path) -> Self

Creates this file at path. This does not change the file’s name specified when creating the builder.

pub fn contents(self, contents: &'a [u8]) -> Self

Sets the file’s initial contents.

pub fn metadata(self, metadata: Config::Metadata) -> Self

Sets the file’s initial metadata.

pub fn create<Database: Connection + Clone>( self, database: &Database ) -> Result<File<Blocking<Database>, Config>, Error>

Creates the file and returns a handle to the created file.

pub async fn create_async<Database: AsyncConnection + Clone>( self, database: &Database ) -> Result<File<Async<Database>, Config>, Error>

Creates the file and returns a handle to the created file.

Trait Implementations

impl<'a, Config> Clone for FileBuilder<'a, Config>

where Config: FileConfig + Clone, Config::Metadata: Clone,

fn clone(&self) -> FileBuilder<'a, Config>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, Config> Debug for FileBuilder<'a, Config>

where Config: FileConfig + Debug, Config::Metadata: Debug,

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

Formats the value using the given formatter.