Struct pasture_io::base::IOFactory

pub struct IOFactory { /* fields omitted */ }

Factory that can create PointReader and PointWriter objects based on file extensions. Use this if you have a file path and just want to create a PointReader or PointWriter from this path, without knowing the type of file. The Default implementation supports all file formats that Pasture natively works with, custom formats can be registered using the register_... functions

Implementations

impl IOFactory

pub fn make_reader(&self, file: &Path) -> Result<Box<dyn PointReadAndSeek>>

Try to create a PointReader that can read from the given file. This function will fail if file has a format that is unsupported by Pasture, or if there are any I/O errors while trying to access file.

pub fn make_writer(&self, file: &Path) -> Result<Box<dyn PointWriter>>

Try to create a PointWriter for writing into the given file. This function will fail if file has a format that is unsupported by Pasture, or if there are any I/O errors while trying to access file.

pub fn supports_reading_from(&self, extension: &'static str) -> bool

Returns true if the associated IOFactory supports creating PointReader objects for the given file extension

pub fn supports_writing_to(&self, extension: &'static str) -> bool

Returns true if the associated IOFactory supports creating PointWriter objects for the given file extension

pub fn register_reader_for_extension<F: Fn(&Path) -> Result<Box<dyn PointReadAndSeek>> + 'static>(
    &mut self,
    extension: &'static str,
    reader_factory: F
) -> Option<Box<dyn Fn(&Path) -> Result<Box<dyn PointReadAndSeek>>>>

Register a new readable file extension with the associated IOFactory. The reader_factory will be called whenever extension is encountered as a file extension in make_reader. Returns the previous reader factory function that was registered for extension, if there was any.

pub fn register_writer_for_extension<F: Fn(&Path) -> Result<Box<dyn PointWriter>> + 'static>(
    &mut self,
    extension: &'static str,
    writer_factory: F
) -> Option<Box<dyn Fn(&Path) -> Result<Box<dyn PointWriter>>>>

Register a new writeable file extension with the associated IOFactory. The writer_factory will be called whenever extension is encountered as a file extension in make_writer. Returns the previous writer factory function that was registered for extension, if there was any.

Trait Implementations

impl Default for IOFactory

fn default() -> Self

Returns the “default value” for a type.