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 detected SMI language version.

Returns Language::Unknown when the available syntax and imports provide insufficient or conflicting version evidence.

pub fn source_id(self) -> Option<SourceId>

Return the compilation-local source identity, if this module came from source text.

pub fn source(self) -> Option<&'a SourceDocument>

Return the retained source document, if this module came from source text.

pub fn source_label(self) -> Option<&'a str>

Return the source document’s display label, if retained.

pub fn source_origin(self) -> Option<&'a SourceOrigin>

Return the source document’s stable origin, if retained.

pub fn semantic_at(self, offset: ByteOffset) -> Option<SemanticSpan<'a>>

Return resolved semantic context at a byte offset in this module’s source.

Ranges are half-open: the start byte is included and the end byte is not. References take precedence over containing definitions. Among overlapping references, the narrowest range wins. Equal widths use import, OID, then type/symbol-reference priority; equal-kind overlaps prefer the later start, then retained-item order. Returns None for an out-of-bounds offset or a module without retained source text.

pub fn semantic_at_source( self, source_id: SourceId, offset: ByteOffset, ) -> Option<SemanticSpan<'a>>

Return resolved semantic context after checking the source identity.

This is useful when a caller has a source-qualified cursor. A source ID from another document never falls back to interpreting the same numeric offset in this module and instead returns None.

pub fn semantic_at_position( self, position: Position, encoding: PositionEncoding, ) -> Result<Option<SemanticSpan<'a>>, PositionError>

Return resolved semantic context at a zero-based editor position.

Position conversion uses the requested UTF encoding and propagates invalid-line, invalid-column, mid-code-point, and invalid-UTF-8 errors. A module without retained source text returns Ok(None).

pub fn semantic_at_source_position( self, source_id: SourceId, position: Position, encoding: PositionEncoding, ) -> Result<Option<SemanticSpan<'a>>, PositionError>

Return resolved semantic context at a source-qualified editor position.

A source-ID mismatch returns Ok(None) without converting the position; otherwise this has the same conversion errors and result as Module::semantic_at_position.

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 identities(self) -> &'a [ModuleIdentityData]

Return exact module-scoped OID identity declarations.

This preserves same-OID aliases and declarations hidden by the global OID tree’s winning name, kind, metadata, or module.

pub fn is_base(self) -> bool

Return true if this is an SMI foundation module (SNMPv2-SMI, etc.).

Foundation modules define the SMI language itself. Their source may be supplied by a configured source or by the parsed embedded fallback. See the crate-level docs for the full list and source precedence.

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

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

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 import_resolution(self, name: &str) -> Option<&'a ImportResolution>

Return retained pre-collapse resolution provenance for an imported symbol.

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<'a> Copy for Module<'a>

impl Debug for Module<'_>

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

Formats the value using the given formatter.

impl Eq for Module<'_>

impl PartialEq for Module<'_>

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.