Struct yang2::data::DataTree

source ·

pub struct DataTree { /* private fields */ }

Expand description

YANG data tree.

Implementations§

source §

impl DataTree

source

pub fn new(context: &Arc<Context>) -> DataTree

Create new empty data tree.

source

pub fn parse_file<F: AsRawFd>( context: &Arc<Context>, fd: F, format: DataFormat, parser_options: DataParserFlags, validation_options: DataValidationFlags ) -> Result<DataTree, Error>

Parse (and validate) input data as a YANG data tree.

source

pub fn parse_string( context: &Arc<Context>, data: &str, format: DataFormat, parser_options: DataParserFlags, validation_options: DataValidationFlags ) -> Result<DataTree, Error>

Parse (and validate) input data as a YANG data tree.

source

pub fn parse_op_string( context: &Arc<Context>, data: &str, format: DataFormat, op: DataOperation ) -> Result<DataTree, Error>

Parse YANG data into an operation data tree.

source

pub fn reference(&self) -> Option<DataNodeRef<'_>>

Returns a reference to the fist top-level data node, unless the data tree is empty.

source

pub fn new_path( &mut self, path: &str, value: Option<&str>, output: bool ) -> Result<Option<DataNodeRef<'_>>, Error>

Create a new node or modify existing one in the data tree based on a path.

If path points to a list key and the list instance does not exist, the key value from the predicate is used and value is ignored. Also, if a leaf-list is being created and both a predicate is defined in path and value is set, the predicate is preferred.

For key-less lists and state leaf-lists, positional predicates can be used. If no preciate is used for these nodes, they are always created.

The output parameter can be used to change the behavior to ignore RPC/action input schema nodes and use only output ones.

Returns the last created or modified node (if any).

source

pub fn remove(&mut self, path: &str) -> Result<(), Error>

Remove a data node.

source

pub fn validate(&mut self, options: DataValidationFlags) -> Result<(), Error>

Fully validate the data tree.

source

pub fn duplicate(&self) -> Result<DataTree, Error>

Create a copy of the data tree.

source

pub fn merge(&mut self, source: &DataTree) -> Result<(), Error>

Merge the source data tree into the target data tree. Merge may not be complete until validation is called on the resulting data tree (data from more cases may be present, default and non-default values).

source

pub fn add_implicit(&mut self, options: DataImplicitFlags) -> Result<(), Error>

Add any missing implicit nodes. Default nodes with a false “when” are not added.

source

pub fn diff( &self, dtree: &DataTree, options: DataDiffFlags ) -> Result<DataDiff, Error>

Learn the differences between 2 data trees.

The resulting diff is represented as a data tree with specific metadata from the internal ‘yang’ module. Most importantly, every node has an effective ‘operation’ metadata. If there is none defined on the node, it inherits the operation from the nearest parent. Top-level nodes must always have the ‘operation’ metadata defined. Additional metadata (‘orig-default’, ‘value’, ‘orig-value’, ‘key’, ‘orig-key’) are used for storing more information about the value in the first or the second tree.

source