Struct hdf5::FileBuilder

pub struct FileBuilder { /* fields omitted */ }

File builder allowing to customize file access/creation property lists.

Implementations

impl FileBuilder

pub fn new() -> Self

Creates a new file builder with default property lists.

pub fn open<P: AsRef<Path>>(&self, filename: P) -> Result<File>

Opens a file as read-only, file must exist.

pub fn open_rw<P: AsRef<Path>>(&self, filename: P) -> Result<File>

Opens a file as read/write, file must exist.

pub fn create<P: AsRef<Path>>(&self, filename: P) -> Result<File>

Creates a file, truncates if exists.

pub fn create_excl<P: AsRef<Path>>(&self, filename: P) -> Result<File>

Creates a file, fails if exists.

pub fn append<P: AsRef<Path>>(&self, filename: P) -> Result<File>

Opens a file as read/write if exists, creates otherwise.

pub fn open_as<P: AsRef<Path>>(
    &self,
    filename: P,
    mode: OpenMode
) -> Result<File>

Opens a file in a given mode.

pub fn set_access_plist(&mut self, fapl: &FileAccess) -> Result<&mut Self>

Sets current file access property list to a given one.

pub fn set_fapl(&mut self, fapl: &FileAccess) -> Result<&mut Self>

A short alias for set_access_plist().

pub fn access_plist(&mut self) -> &mut FileAccessBuilder

Returns the builder object for the file access property list.

pub fn fapl(&mut self) -> &mut FileAccessBuilder

A short alias for access_plist().

pub fn with_access_plist<F>(&mut self, func: F) -> &mut Self where
    F: Fn(&mut FileAccessBuilder) -> &mut FileAccessBuilder, 

Allows accessing the builder object for the file access property list.

pub fn with_fapl<F>(&mut self, func: F) -> &mut Self where
    F: Fn(&mut FileAccessBuilder) -> &mut FileAccessBuilder, 

A short alias for with_access_plist().

pub fn set_create_plist(&mut self, fcpl: &FileCreate) -> Result<&mut Self>

Sets current file creation property list to a given one.

pub fn set_fcpl(&mut self, fcpl: &FileCreate) -> Result<&mut Self>

A short alias for set_create_plist().

pub fn create_plist(&mut self) -> &mut FileCreateBuilder

Returns the builder object for the file creation property list.

pub fn fcpl(&mut self) -> &mut FileCreateBuilder

A short alias for create_plist().

pub fn with_create_plist<F>(&mut self, func: F) -> &mut Self where
    F: Fn(&mut FileCreateBuilder) -> &mut FileCreateBuilder, 

Allows accessing the builder object for the file creation property list.

pub fn with_fcpl<F>(&mut self, func: F) -> &mut Self where
    F: Fn(&mut FileCreateBuilder) -> &mut FileCreateBuilder, 

A short alias for with_create_plist().

Trait Implementations

impl Clone for FileBuilder

fn clone(&self) -> FileBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FileBuilder

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

Formats the value using the given formatter.

impl Default for FileBuilder

fn default() -> FileBuilder

Returns the "default value" for a type.