Struct Module 

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

Borrowed handle to a resolved ModuleData.

Wraps a Mib reference and an arena id. Handles are Copy and cheap to pass around. Two handles are equal when they point to the same arena slot in the same Mib.

Implementations

impl<'a> Module<'a>

pub fn id(self) -> ModuleId

Return the arena ID for this handle.

Use IDs when you need deduplication, storage in collections, or to call RawMib methods.

impl<'a> Module<'a>

pub fn name(self) -> &'a str

Return the module name.

pub fn language(self) -> Language

Return the SMI language version (SMIv1 or SMIv2).

pub fn source_path(self) -> &'a str

Return the file path this module was loaded from.

pub fn organization(self) -> &'a str

Return the ORGANIZATION clause text from MODULE-IDENTITY.

pub fn contact_info(self) -> &'a str

Return the CONTACT-INFO clause text from MODULE-IDENTITY.

pub fn description(self) -> &'a str

Return the DESCRIPTION clause text from MODULE-IDENTITY.

pub fn last_updated(self) -> &'a str

Return the LAST-UPDATED timestamp string from MODULE-IDENTITY.

pub fn revisions(self) -> &'a [Revision]

Return the REVISION entries from MODULE-IDENTITY.

pub fn imports(self) -> &'a [Import]

Return the IMPORTS declarations.

pub fn is_base(self) -> bool

Return true if this is a synthetic base module (SNMPv2-SMI, etc.).

Base modules define the SMI language itself and are constructed programmatically rather than parsed from files. They have no real source text, so spans are Span::SYNTHETIC and source_path() returns an empty string. See the crate-level docs for the full list of base modules and their contents.

pub fn oid(self) -> Option<&'a Oid>

Return the module’s registered OID from its MODULE-IDENTITY, if any.

pub fn line_col(self, offset: ByteOffset) -> (usize, usize)

Convert a byte offset within this module’s source to a line and column number.

pub fn imports_symbol(self, name: &str) -> bool

Return true if this module imports a symbol with the given name.

pub fn import_source(self, name: &str) -> Option<Module<'a>>

Return the resolved source module for an imported name.

pub fn object(self, name: &str) -> Option<Object<'a>>

Look up an object defined by this module.

pub fn type(self, name: &str) -> Option<Type<'a>>

Look up a type defined by this module.

pub fn node(self, name: &str) -> Option<Node<'a>>

Look up any node defined by this module.

pub fn notification(self, name: &str) -> Option<Notification<'a>>

Look up a notification defined by this module.

pub fn group(self, name: &str) -> Option<Group<'a>>

Look up a group defined by this module.

pub fn compliance(self, name: &str) -> Option<Compliance<'a>>

Look up a compliance statement defined by this module.

pub fn capability(self, name: &str) -> Option<Capability<'a>>

Look up a capabilities statement defined by this module.

pub fn objects(self) -> impl Iterator<Item = Object<'a>> + 'a

Iterate objects defined by this module.

pub fn types(self) -> impl Iterator<Item = Type<'a>> + 'a

Iterate types defined by this module.

pub fn nodes(self) -> impl Iterator<Item = Node<'a>> + 'a

Iterate nodes defined by this module.

Trait Implementations

impl<'a> Clone for Module<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Module<'_>

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

Formats the value using the given formatter.

impl PartialEq for Module<'_>

fn eq(&self, other: &Self) -> 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<'a> Copy for Module<'a>

impl Eq for Module<'_>