Struct yang3::schema::SchemaModule

pub struct SchemaModule<'a> { /* private fields */ }

Available YANG schema tree structures representing YANG module.

Implementations

impl<'a> SchemaModule<'a>

pub fn name(&self) -> &str

Name of the module.

pub fn revision(&self) -> Option<&str>

Revision of the module.

pub fn namespace(&self) -> &str

Namespace of the module.

pub fn prefix(&self) -> &str

Prefix of the module.

pub fn filepath(&self) -> Option<&str>

File path, if the schema was read from a file.

pub fn organization(&self) -> Option<&str>

Party/company responsible for the module.

pub fn contact(&self) -> Option<&str>

Contact information for the module.

pub fn description(&self) -> Option<&str>

Description of the module.

pub fn reference(&self) -> Option<&str>

Cross-reference for the module.

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

Make the specific module implemented.

pub fn is_implemented(&self) -> bool

Return true if the module is implemented, not just imported.

pub fn feature_value(&self, feature: &str) -> Result<bool, Error>

Get the current real status of the specified feature in the module.

pub fn print_file<F: AsRawFd>( &self, fd: F, format: SchemaOutputFormat, options: SchemaPrinterFlags, ) -> Result<(), Error>

Print schema tree in the specified format into a file descriptor.

pub fn print_string( &self, format: SchemaOutputFormat, options: SchemaPrinterFlags, ) -> Result<String, Error>

Print schema tree in the specified format into a string.

pub fn data(&self) -> Siblings<'a, SchemaNode<'a>>

Returns an iterator over the top-level data nodes.

pub fn rpcs(&self) -> Siblings<'a, SchemaNode<'a>>

Returns an iterator over the list of RPCs.

pub fn notifications(&self) -> Siblings<'a, SchemaNode<'a>>

Returns an iterator over the list of notifications.

pub fn extensions(&self) -> impl Iterator<Item = SchemaExtInstance<'a>>

Returns an iterator over the list of extension instances.

pub fn top_level_nodes( &self, flags: IterSchemaFlags, ) -> impl Iterator<Item = SchemaNode<'a>>

Returns an iterator over the top-level data nodes. The iteration behavior is customizable using the provided flags option.

pub fn traverse(&self) -> impl Iterator<Item = SchemaNode<'a>>

Returns an iterator over all data nodes in the schema module (depth-first search algorithm).

NOTE: augmentations (from other modules or from the module itself) are also iterated over.

Trait Implementations

impl<'a> Binding<'a> for SchemaModule<'a>

type CType = lys_module

type Container = Context

unsafe fn from_raw( context: &'a Context, raw: *mut lys_module, ) -> SchemaModule<'_>

unsafe fn from_raw_opt( container: &'a Self::Container, raw: *mut Self::CType, ) -> Option<Self>

impl<'a> Clone for SchemaModule<'a>

fn clone(&self) -> SchemaModule<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for SchemaModule<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for SchemaModule<'a>

fn eq(&self, other: &SchemaModule<'_>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Send for SchemaModule<'_>

impl Sync for SchemaModule<'_>