Struct YangLibraryReference 

pub struct YangLibraryReference { /* private fields */ }

A reference to a YANG Library stored on disk.

This structure provides a lightweight handle to a YANG library without loading all the module contents into memory. It stores the essential information needed to locate and load the YANG library and its associated modules on demand.

Multi-Subscription Support

A single YangLibraryReference can be associated with multiple subscriptions from different peers, as long as they all use the same YANG library (content-id).

• subscriptions_info: Retrieve all associated subscriptions
• append_subscription_info: Add another subscription
• save_to_disk: Persist YANG library and subscriptions

Components

• Content ID: A unique identifier for the YANG library, extracted from the library itself during construction to ensure consistency.

• YANG Library Path: The filesystem path to the serialized YANG library XML file (yang-lib.xml).

• YANG Library Reference Directory: The directory containing the yang-lib.xml, subscriptions-info.json and modules directory containing YANG modules referenced by the library. Modules are loaded from {yang_lib_ref_path}/modules in this directory when load_schemas is called.

Lazy Loading

The reference is designed for lazy loading - it validates that the paths exist and extracts the content ID during construction, but does not load the full YANG library or module contents until explicitly requested via yang_library or load_schemas.

Example

use std::path::PathBuf;

// Create a reference to an existing YANG library on disk
let yang_lib_ref = YangLibraryReference::new(
    PathBuf::from("/schemas/content-id-123/yang-lib.xml"),
    PathBuf::from("/schemas/content-id-123"),
)?;

// Access the content ID (available immediately)
let content_id = yang_lib_ref.content_id();

// Load the full YANG library when needed
let yang_library = yang_lib_ref.yang_library()?;

// Load all module schemas from disk
let schemas = yang_lib_ref.load_schemas()?;

Errors

Construction will fail if:

• The YANG library path does not exist or is not a file
• The search directory does not exist or is not a directory
• The YANG library XML cannot be parsed

Implementations

impl YangLibraryReference

pub fn load_from_disk( yang_library_path: PathBuf, yang_lib_ref_path: PathBuf, ) -> Result<Self, YangLibraryCacheError>

Load a YANG Library Reference from the given YANG Library file path and root directory for the YANG Library reference.

Note: the content ID is read from the YANG Library file to ensure its correctness.

This does not load the YANG modules themselves, only the reference to them.

pub fn save_to_disk( yang_lib_ref_path: PathBuf, yang_library: &YangLibrary, schemas: HashMap<Box<str>, Box<str>>, subscriptions_info: &[SubscriptionInfo], ) -> Result<Self, YangLibraryCacheError>

Create and save a YANG Library Reference to disk.

This will create the necessary directory structure and files to store the YANG library, subscription info, and YANG modules.

If the YANG Library already exists on disk and differs from the provided YANG Library, an error is returned to prevent overwriting.

If the YANG Library already exists and is identical, the existing reference is returned and the subscription info is extended with the new subscriptions.

pub const fn content_id(&self) -> &ContentId

Get the content ID of the YANG Library.

pub fn yang_library_path(&self) -> &Path

Get the path to the YANG Library file.

pub fn yang_library(&self) -> Result<YangLibrary, YangLibraryCacheError>

Load the YANG Library from disk.

pub fn yang_lib_ref_path(&self) -> &Path

Get the path to the directory containing the YANG Library file.

pub fn search_dir(&self) -> PathBuf

Get the path to the search directory containing the YANG modules.

pub fn load_schemas( &self, ) -> Result<HashMap<Box<str>, Box<str>>, YangLibraryCacheError>

Load the YANG schemas defined in the library from disk.

pub fn subscription_info_path(&self) -> PathBuf

pub fn subscriptions_info( &self, ) -> Result<Vec<SubscriptionInfo>, YangLibraryCacheError>

pub fn append_subscription_info( &self, subscription_info: SubscriptionInfo, ) -> Result<(), YangLibraryCacheError>

Appends a subscription information entry to the persisted list.

If the subscription info already exists, this operation is idempotent (no duplicate entry is created). Uses file locking to prevent concurrent modification issues and atomic writes for crash safety.

Errors

Returns an error if:

• The subscription info file cannot be accessed
• JSON parsing/serialization fails
• File system operations fail

pub fn remove_subscription_info( &self, subscription_info: &SubscriptionInfo, ) -> Result<Option<SubscriptionInfo>, YangLibraryCacheError>

Remove a subscription info from the YANG library reference.

If the subscription info is found and removed, it is returned. If not found, None is returned.

Trait Implementations

impl Clone for YangLibraryReference

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for YangLibraryReference

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for YangLibraryReference

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for YangLibraryReference

impl Hash for YangLibraryReference

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for YangLibraryReference

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for YangLibraryReference

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for YangLibraryReference