Struct opencv::types::FileStorageRefMut

pub struct FileStorageRefMut<'o> { /* fields omitted */ }

Methods from Deref<Target = FileStorage>

pub fn as_raw_FileStorage(&self) -> *mut c_void

pub 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()

pub fn is_opened(&self) -> Result<bool>

Checks whether the file is opened.

Returns

true if the object is associated with the current file and false otherwise. It is a good practice to call this method after you tried to open a file.

pub 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.

pub 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

pub fn get_first_top_level_node(&self) -> Result<FileNode>

Returns the first element of the top-level mapping.

Returns

The first element of the top-level mapping.

pub fn root(&self, streamidx: i32) -> Result<FileNode>

Returns the top-level mapping

Parameters

• streamidx: Zero-based index of the stream. In most cases there is only one stream in the file. However, YAML supports multiple streams and so there can be several.

Returns

The top-level mapping.

C++ default parameters

• streamidx: 0

pub fn write_i32(&mut self, name: &str, val: i32) -> Result<()>

Simplified writing API to use with bindings.

Parameters

• name: Name of the written object
• val: Value of the written object

pub fn write_f64(&mut self, name: &str, val: f64) -> Result<()>

pub fn write_str(&mut self, name: &str, val: &str) -> Result<()>

pub fn write_mat(&mut self, name: &str, val: &Mat) -> Result<()>

pub fn write_str_vec(&mut self, name: &str, val: &VectorOfString) -> Result<()>

pub fn write_raw(&mut self, fmt: &str, vec: &c_void, len: size_t) -> Result<()>

Writes multiple numbers.

Writes one or more numbers of the specified format to the currently written structure. Usually it is more convenient to use operator << instead of this method.

Parameters

• fmt: Specification of each array element, see @ref format_spec "format specification"
• vec: Pointer to the written array.
• len: Number of the uchar elements to write.

pub fn write_comment(&mut self, comment: &str, append: bool) -> Result<()>

Writes a comment.

The function writes a comment into file storage. The comments are skipped when the storage is read.

Parameters

• comment: The written comment, single-line or multi-line
• append: If true, the function tries to put the comment at the end of current line. Else if the comment is multi-line, or if it does not fit at the end of the current line, the comment starts a new line.

C++ default parameters

• append: false

pub fn start_write_struct(
    &mut self,
    name: &str,
    flags: i32,
    type_name: &str
) -> Result<()>

pub fn end_write_struct(&mut self) -> Result<()>

pub fn get_format(&self) -> Result<i32>

Returns the current format.

Returns

The current format, see FileStorage::Mode

Trait Implementations

impl<'_> Deref for FileStorageRefMut<'_>

type Target = FileStorage

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'_> DerefMut for FileStorageRefMut<'_>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.