Struct FileStorage

pub struct FileStorage { /* private fields */ }

XML/YAML/JSON file storage class that encapsulates all the information necessary for writing or reading data to/from a file.

Implementations

impl FileStorage

pub fn default() -> Result<FileStorage>

The constructors.

The full constructor opens the file. Alternatively you can use the default constructor and then call FileStorage::open.

pub fn new(filename: &str, flags: i32, encoding: &str) -> Result<FileStorage>

The constructors.

The full constructor opens the file. Alternatively you can use the default constructor and then call FileStorage::open.

Overloaded parameters

@copydoc open()

C++ default parameters

• encoding: String()

pub fn new_def(filename: &str, flags: i32) -> Result<FileStorage>

@overload @copydoc open()

Note

This alternative version of [new] function uses the following default values for its arguments:

• encoding: String()

pub fn get_default_object_name(filename: &str) -> Result<String>

Returns the normalized object name for the specified name of a file.

Parameters

• filename: Name of a file

Returns

The normalized object name.

Trait Implementations

impl Boxed for FileStorage

unsafe fn from_raw( ptr: <FileStorage as OpenCVFromExtern>::ExternReceive, ) -> Self

Wrap the specified raw pointer

fn into_raw(self) -> <FileStorage as OpenCVTypeExternContainer>::ExternSendMut

Return the underlying raw pointer while consuming this wrapper.

fn as_raw(&self) -> <FileStorage as OpenCVTypeExternContainer>::ExternSend

Return the underlying raw pointer.

fn as_raw_mut( &mut self, ) -> <FileStorage as OpenCVTypeExternContainer>::ExternSendMut

Return the underlying mutable raw pointer

impl Debug for FileStorage

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

Formats the value using the given formatter.

impl Drop for FileStorage

fn drop(&mut self)

Executes the destructor for this type.

impl FileStorageTrait for FileStorage

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

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>

Opens a file.

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

Opens a file.

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

Closes the file and releases all the memory buffers.

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

Closes the file and releases all the memory buffers.

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

Simplified writing API to use with bindings.

fn write(&mut self, name: &str, val: i64) -> Result<()>

Simplified writing API to use with bindings.

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

Simplified writing API to use with bindings.

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

Simplified writing API to use with bindings.

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

Simplified writing API to use with bindings.

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

Simplified writing API to use with bindings.

fn write_raw(&mut self, fmt: &str, vec: &mut [u8]) -> Result<()>

Writes multiple numbers.

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

Writes a comment.

fn write_comment_def(&mut self, comment: &str) -> Result<()>

Writes a comment.

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

Starts to write a nested structure (sequence or a mapping).

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

Starts to write a nested structure (sequence or a mapping).

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

Finishes writing nested structure (should pair startWriteStruct())

impl FileStorageTraitConst for FileStorage

fn as_raw_FileStorage(&self) -> *const c_void

fn state(&self) -> i32

fn elname(&self) -> String

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

Checks whether the file is opened.

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

Returns the first element of the top-level mapping.

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

Returns the top-level mapping

fn root_def(&self) -> Result<FileNode>

Returns the top-level mapping

fn get(&self, nodename: &str) -> Result<FileNode>

Returns the specified element of the top-level mapping.

fn get_node(&self, nodename: &str) -> Result<FileNode>

Returns the specified element of the top-level mapping.

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

Returns the current format.

impl Send for FileStorage