Struct FileNode

pub struct FileNode { /* private fields */ }

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.

Implementations

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 new( fs: &impl FileStorageTraitConst, block_idx: size_t, ofs: size_t, ) -> 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.

Overloaded parameters

Parameters

• fs: Pointer to the file storage structure.
• blockIdx: Index of the memory block where the file node is stored
• ofs: Offset in bytes from the beginning of the serialized storage

@deprecated

pub fn copy(node: &impl FileNodeTraitConst) -> 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.

Overloaded parameters

Parameters

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

pub fn is_map(flags: i32) -> Result<bool>

pub fn is_seq(flags: i32) -> Result<bool>

pub fn is_collection(flags: i32) -> Result<bool>

pub fn is_empty_collection(flags: i32) -> Result<bool>

pub fn is_flow(flags: i32) -> Result<bool>

Trait Implementations

impl Boxed for FileNode

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

Wrap the specified raw pointer

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

Return the underlying raw pointer while consuming this wrapper.

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

Return the underlying raw pointer.

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

Return the underlying mutable raw pointer

impl Clone for FileNode

fn clone(&self) -> Self

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FileNode

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

Formats the value using the given formatter.

impl Drop for FileNode

fn drop(&mut self)

Executes the destructor for this type.

impl FileNodeTrait for FileNode

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

fn set_block_idx(&mut self, val: size_t)

fn set_ofs(&mut self, val: size_t)

fn set(&mut self, node: &impl FileNodeTraitConst) -> Result<()>

fn ptr_1(&mut self) -> Result<*mut u8>

fn set_value(&mut self, typ: i32, value: &mut [u8]) -> Result<()>

Internal method used when reading FileStorage. Sets the type (int, real or string) and value of the previously created node.

impl FileNodeTraitConst for FileNode

fn as_raw_FileNode(&self) -> *const c_void

fn block_idx(&self) -> size_t

fn ofs(&self) -> size_t

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

Returns element of a mapping node or a sequence node.

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

Returns element of a mapping node or a sequence node.

fn at(&self, i: i32) -> Result<FileNode>

Returns element of a mapping node or a sequence node.

fn keys(&self) -> Result<Vector<String>>

Returns keys of a mapping node.

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

Returns type of the node.

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

returns true if the node is empty

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

returns true if the node is a “none” object

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

returns true if the node is a sequence

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

returns true if the node is a mapping

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

returns true if the node is an integer

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

returns true if the node is a floating-point number

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

returns true if the node is a text string

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

returns true if the node has a name

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

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

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

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

fn raw_size(&self) -> Result<size_t>

returns raw size of the FileNode in bytes

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

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

fn to_i64(&self) -> Result<i64>

returns the node content as a signed 64bit integer. If the node stores floating-point number, it is rounded.

fn to_f32(&self) -> Result<f32>

returns the node content as float

fn to_f64(&self) -> Result<f64>

returns the node content as double

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

returns the node content as text string

fn ptr(&self) -> Result<*const u8>

fn begin(&self) -> Result<FileNodeIterator>

returns iterator pointing to the first node element

fn end(&self) -> Result<FileNodeIterator>

returns iterator pointing to the element following the last node element

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

Reads node elements to the buffer with the specified format.

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

Simplified reading API to use with bindings.

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

Simplified reading API to use with bindings.

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

Simplified reading API to use with bindings.

impl Send for FileNode