Struct flatdata::FileResourceStorage

pub struct FileResourceStorage { /* fields omitted */ }

Resource storage on disk using memory mapped files.

Can be used to create and read archives from the file system.

Examples

let storage = FileResourceStorage::new(PathBuf::from("/root/to/my/archive"));
let _builder = XBuilder::new(storage.clone()).expect("failed to create builder");
// Write some data, store archive, etc...

let _archive = X::open(storage).expect("failed to open");
// read some data

Methods

impl FileResourceStorage

pub fn new<P: Into<PathBuf>>(path: P) -> Rc<Self>

Create an empty memory mapped file storage at a given path.

Trait Implementations

impl ResourceStorage for FileResourceStorage

fn subdir(&self, dir: &str) -> Rc<dyn ResourceStorage>

Creates a resource storage at a given subdirectory.

fn exists(&self, resource_name: &str) -> bool

Returns true if resource exists in the storage.

fn read_resource(&self, resource_name: &str) -> Result<&[u8], Error>

Reads a resource in storage and returns a pointer to its raw data.

fn create_output_stream(
    &self,
    resource_name: &str
) -> Result<Rc<RefCell<dyn Stream>>, Error>

Creates a resource with given name and returns an output stream for writing to it.

fn read(
    &self,
    resource_name: &str,
    schema: &str
) -> Result<&[u8], ResourceStorageError>

Open a flatdata resource with given name and schema for reading.

fn write(&self, resource_name: &str, schema: &str, data: &[u8]) -> Result<()>

Writes data of a flatdata resource with given name and schema to storage.

fn read_and_check_schema(
    &self,
    resource_name: &str,
    expected_schema: &str
) -> Result<&[u8], ResourceStorageError>

Implementation helper for [read].

impl Debug for FileResourceStorage

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

Formats the value using the given formatter.