Trait FileStorageTrait

Source

pub trait FileStorageTrait: FileStorageTraitConst {
Show 19 methods    // Required method
    fn as_raw_mut_FileStorage(&mut self) -> *mut c_void;

    // Provided methods
    fn set_state(&mut self, val: i32) { ... }
    fn set_elname(&mut self, val: &str) { ... }
    fn open(
        &mut self,
        filename: &str,
        flags: i32,
        encoding: &str,
    ) -> Result<bool> { ... }
    fn open_def(&mut self, filename: &str, flags: i32) -> Result<bool> { ... }
    fn release(&mut self) -> Result<()> { ... }
    fn release_and_get_string(&mut self) -> Result<String> { ... }
    fn write_i32(&mut self, name: &str, val: i32) -> Result<()> { ... }
    fn write(&mut self, name: &str, val: i64) -> Result<()> { ... }
    fn write_f64(&mut self, name: &str, val: f64) -> Result<()> { ... }
    fn write_str(&mut self, name: &str, val: &str) -> Result<()> { ... }
    fn write_mat(&mut self, name: &str, val: &impl MatTraitConst) -> Result<()> { ... }
    fn write_str_vec(&mut self, name: &str, val: &Vector<String>) -> Result<()> { ... }
    fn write_raw(&mut self, fmt: &str, vec: &mut [u8]) -> Result<()> { ... }
    fn write_comment(&mut self, comment: &str, append: bool) -> Result<()> { ... }
    fn write_comment_def(&mut self, comment: &str) -> Result<()> { ... }
    fn start_write_struct(
        &mut self,
        name: &str,
        flags: i32,
        type_name: &str,
    ) -> Result<()> { ... }
    fn start_write_struct_def(&mut self, name: &str, flags: i32) -> Result<()> { ... }
    fn end_write_struct(&mut self) -> Result<()> { ... }
}

Expand description

Mutable methods for core::FileStorage

Required Methods§

Source

fn as_raw_mut_FileStorage(&mut self) -> *mut c_void

Provided Methods§

Source

fn set_state(&mut self, val: i32)

Source

fn set_elname(&mut self, val: &str)

Source

fn open(&mut self, filename: &str, flags: i32, encoding: &str) -> Result<bool>

Opens a file.

See description of parameters in FileStorage::FileStorage. The method calls FileStorage::release before opening the file.

§Parameters

filename: Name of the file to open or the text string to read the data from. Extension of the file (.xml, .yml/.yaml or .json) determines its format (XML, YAML or JSON respectively). Also you can append .gz to work with compressed files, for example myHugeMatrix.xml.gz. If both FileStorage::WRITE and FileStorage::MEMORY flags are specified, source is used just to specify the output file format (e.g. mydata.xml, .yml etc.). A file name can also contain parameters. You can use this format, “*?base64” (e.g. “file.json?base64” (case sensitive)), as an alternative to FileStorage::BASE64 flag.
flags: Mode of operation. One of FileStorage::Mode
encoding: Encoding of the file. Note that UTF-16 XML encoding is not supported currently and you should use 8-bit encoding instead of it.

§C++ default parameters

encoding: String()

Source

fn open_def(&mut self, filename: &str, flags: i32) -> Result<bool>

Opens a file.

See description of parameters in FileStorage::FileStorage. The method calls FileStorage::release before opening the file.

§Parameters

filename: Name of the file to open or the text string to read the data from. Extension of the file (.xml, .yml/.yaml or .json) determines its format (XML, YAML or JSON respectively). Also you can append .gz to work with compressed files, for example myHugeMatrix.xml.gz. If both FileStorage::WRITE and FileStorage::MEMORY flags are specified, source is used just to specify the output file format (e.g. mydata.xml, .yml etc.). A file name can also contain parameters. You can use this format, “*?base64” (e.g. “file.json?base64” (case sensitive)), as an alternative to FileStorage::BASE64 flag.
flags: Mode of operation. One of FileStorage::Mode
encoding: Encoding of the file. Note that UTF-16 XML encoding is not supported currently and you should use 8-bit encoding instead of it.

§Note

This alternative version of FileStorageTrait::open function uses the following default values for its arguments:

encoding: String()

Source

fn release(&mut self) -> Result<()>

Closes the file and releases all the memory buffers.

Call this method after all I/O operations with the storage are finished.

Source

fn release_and_get_string(&mut self) -> Result<String>

Closes the file and releases all the memory buffers.

Call this method after all I/O operations with the storage are finished. If the storage was opened for writing data and FileStorage::WRITE was specified

Source