Trait sdml_core::store::ModuleStore

pub trait ModuleStore {
    // Required methods
    fn len(&self) -> usize;
    fn contains(&self, name: &Identifier) -> bool;
    fn get(&self, name: &Identifier) -> Option<&Module>;
    fn get_mut(&mut self, name: &Identifier) -> Option<&mut Module>;
    fn insert(&mut self, module: Module);
    fn remove(&mut self, name: &Identifier) -> bool;
    fn uri_to_module_name(&self, url: &Url) -> Option<&Identifier>;
    fn module_name_to_uri(&self, name: &Identifier) -> Option<&Url>;

    // Provided methods
    fn is_empty(&self) -> bool { ... }
    fn contains_by_uri(&self, uri: &Url) -> bool { ... }
    fn get_by_uri(&self, uri: &Url) -> Option<&Module> { ... }
    fn get_by_uri_mut(&mut self, uri: &Url) -> Option<&mut Module> { ... }
    fn remove_by_uri(&mut self, uri: &Url) -> bool { ... }
    fn resolve(&self, definition: &QualifiedIdentifier) -> Option<&Definition> { ... }
    fn resolve_or_in(
        &self,
        definition: &IdentifierReference,
        in_module: &Identifier,
    ) -> Option<&Definition> { ... }
}

A trait for any type that /stores/ modules and can retrieve them by name and by URI.

Required Methods

fn len(&self) -> usize

Return the number of modules in the store.

fn contains(&self, name: &Identifier) -> bool

Returns true if the loader’s cache contains a module with the name name, else false.

fn get(&self, name: &Identifier) -> Option<&Module>

Returns a reference to the Module identified by name if the store contains it; else None.

fn get_mut(&mut self, name: &Identifier) -> Option<&mut Module>

Returns a mutable reference to the Module identified by name if the store contains it; else None.

fn insert(&mut self, module: Module)

Insert module into the store.

fn remove(&mut self, name: &Identifier) -> bool

Remove any module identified by name.

fn uri_to_module_name(&self, url: &Url) -> Option<&Identifier>

Return the module name corresponding to the provided url if it exists, or else None.

fn module_name_to_uri(&self, name: &Identifier) -> Option<&Url>

Return the module URI corresponding to the provided name if it exists, or else None.

Provided Methods

fn is_empty(&self) -> bool

Return true if there are no modules in this store, else false.

fn contains_by_uri(&self, uri: &Url) -> bool

Returns true if the loader’s cache contains a module with the base URI uri, else false.

fn get_by_uri(&self, uri: &Url) -> Option<&Module>

Returns a reference to the Module identified by uri if the store contains it; else None.

fn get_by_uri_mut(&mut self, uri: &Url) -> Option<&mut Module>

Returns a mutable reference to the Module identified by uri if the store contains it; else None.

fn remove_by_uri(&mut self, uri: &Url) -> bool

Remove any module identified by uri.

fn resolve(&self, definition: &QualifiedIdentifier) -> Option<&Definition>

Given a qualified identifier, find the named module or return None, then find the named member in the found module or return None.

Example

use sdml_core::model::identifiers::QualifiedIdentifier;
use sdml_core::store::{InMemoryModuleCache, ModuleStore};
use std::str::FromStr;

let cache = InMemoryModuleCache::default().with_stdlib();
let name = QualifiedIdentifier::from_str("xsd:integer").unwrap();
let integer = cache.resolve(&name).unwrap();
println!("{integer:?}");

fn resolve_or_in( &self, definition: &IdentifierReference, in_module: &Identifier, ) -> Option<&Definition>

If definition is a QualifiedIdentifier this is the same as resolve; however, if definition is an Identifier then look for definition in the module named in_module.

Example

use sdml_core::model::identifiers::{Identifier, IdentifierReference};
use sdml_core::store::{InMemoryModuleCache, ModuleStore};
use std::str::FromStr;

let cache = InMemoryModuleCache::default().with_stdlib();
let default_module = Identifier::from_str("xsd").unwrap();
let name = IdentifierReference::from_str("integer").unwrap();
let integer = cache.resolve_or_in(&name, &default_module).unwrap();
println!("{integer:?}");

Implementors

impl ModuleStore for InMemoryModuleCache