Struct LocalMaps

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

A data structure which maintains LocalMaps for every applicable type. If you need to use Document::local_map for many different types, it may be more efficient to use this type, which calculates all maps in a single pass.

Implementations

impl LocalMaps<'_>

pub fn new() -> Self

Constructs a new LocalMaps with initializes all its fields to set but empty. This differs from default, which initializes them to None. Any None field will not be populated.

impl<'a> LocalMaps<'a>

pub fn set<T: HasId + 'a>(self) -> Self

Enable collection for the given type. This is used as part of a builder-style API for customizing collection before performing the collection pass. For example, if we only want to collect Geometry and Source types:

let maps = LocalMaps::default()
    .set::<Geometry>()
    .set::<Source>()
    .collect(&doc);

pub fn unset<T: HasId + 'a>(self) -> Self

Disable collection for the given type. This is used as part of a builder-style API for customizing collection before performing the collection pass. For example, if we want to collect everything except the ForceField and Sampler types:

let maps = LocalMaps::new()
    .unset::<ForceField>()
    .unset::<Sampler>()
    .collect(&doc);

pub fn collect(self, t: &'a Document) -> Self

Run the collection pass, putting all elements in the given IDs based on their types.

pub fn get_map<T: HasId + ?Sized>(&self) -> Option<&LocalMap<'a, T>>

Retrieve a map by type.

pub fn get_str<T: HasId + ?Sized>(&self, n: &str) -> Option<&'a T>

Look up an element by ID.

pub fn get_name<T: HasId + ?Sized>(&self, n: &NameRef<T>) -> Option<&'a T>

Look up an element by ID, in a NameRef.

pub fn get_raw<T: HasId + ?Sized>(&self, url: &Url) -> Option<&'a T>

Look up an element by URL reference.

This is a local map, meaning that it does not support references to URLs which are not of the special form #ref, referring to an element with ID ref in the same document.

pub fn get<T: HasId + ?Sized>(&self, url: &UrlRef<T>) -> Option<&'a T>

Look up an element by URL reference.

This is a simple wrapper around get_raw, but it has better type safety, since it ensures that the reference is a reference to a T.

This is a local map, meaning that it does not support references to URLs which are not of the special form #ref, referring to an element with ID ref in the same document.

Trait Implementations

impl<'a> Clone for LocalMaps<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for LocalMaps<'a>

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

Formats the value using the given formatter.

impl<'a> Default for LocalMaps<'a>

fn default() -> LocalMaps<'a>

Returns the “default value” for a type.

impl<'a, T: HasId + ?Sized> Index<&Ref<String, T>> for LocalMaps<'a>

type Output = T

The returned type after indexing.

fn index(&self, index: &NameRef<T>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a, T: HasId + ?Sized> Index<&Ref<Url, T>> for LocalMaps<'a>

type Output = T

The returned type after indexing.

fn index(&self, index: &UrlRef<T>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a, T: HasId> UrlResolver<'a, T> for LocalMaps<'a>

type Error = ()

The error type of the resolver.

fn resolve(&self, url: &UrlRef<T>) -> Result<&'a T, Self::Error>

Resolve an individual URL.