Struct opencv::core::FileNode

pub struct FileNode { /* fields omitted */ }

File Storage Node class.

The node is used to store each and every element of the file storage opened for reading. When XML/YAML file is read, it is first parsed and stored in the memory as a hierarchical collection of nodes. Each node can be a "leaf" that is contain a single number or a string, or be a collection of other nodes. There can be named collections (mappings) where each element has a name and it is accessed by a name, and ordered collections (sequences) where elements do not have names but rather accessed by index. Type of the file node can be determined using FileNode::type method.

Note that file nodes are only used for navigating file storages opened for reading. When a file storage is opened for writing, no data is stored in memory after it is written.

Methods

impl FileNode

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

pub unsafe fn from_raw_ptr(ptr: *mut c_void) -> Self

impl FileNode

pub fn default() -> Result<FileNode>

The constructors.

These constructors are used to create a default file node, construct it from obsolete structures or from the another file node.

pub fn copy(node: &FileNode) -> Result<FileNode>

Parameters

• node: File node to be used as initialization for the created file node.

pub fn keys(&self) -> Result<VectorOfString>

Returns keys of a mapping node.

Returns

Keys of a mapping node.

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

Returns type of the node.

Returns

Type of the node. See FileNode::Type

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

returns true if the node is empty

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

returns true if the node is a "none" object

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

returns true if the node is a sequence

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

returns true if the node is a mapping

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

returns true if the node is an integer

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

returns true if the node is a floating-point number

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

returns true if the node is a text string

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

returns true if the node has a name

pub fn name(&self) -> Result<String>

returns the node name or an empty string if the node is nameless

pub fn size(&self) -> Result<size_t>

returns the number of elements in the node, if it is a sequence or mapping, or 1 otherwise.

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

returns the node content as an integer. If the node stores floating-point number, it is rounded.

pub fn to_float(&self) -> Result<f32>

returns the node content as float

pub fn to_double(&self) -> Result<f64>

returns the node content as double

pub fn to_string(&self) -> Result<String>

returns the node content as text string

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

Reads node elements to the buffer with the specified format.

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 destination array.
• len: Number of bytes to read (buffer size limit). If it is greater than number of remaining elements then all of them will be read.

pub fn read_obj(&self) -> Result<&mut c_void>

reads the registered object and returns pointer to it

pub fn real(&self) -> Result<f64>

Simplified reading API to use with bindings.

pub fn string(&self) -> Result<String>

Simplified reading API to use with bindings.

pub fn mat(&self) -> Result<Mat>

Simplified reading API to use with bindings.

Trait Implementations

impl Drop for FileNode

fn drop(&mut self)

Executes the destructor for this type.

impl Send for FileNode