Trait lv2::prelude::URIDCollection

pub trait URIDCollection {
    fn from_map<M>(map: &M) -> Option<Self>
    where
        M: Map + ?Sized;
}

A store of pre-mapped URIDs

This trait can be used to easily cache URIDs. The usual way of creating such a collection is to define a struct of URID<T>s, where T implements UriBound, and then using the derive macro to implement URIDCollection for it. Then, you can populate it with a map and access it any time, even in a real-time-sensitive context.

Usage example:

// Defining all URI bounds.
#[uri("urn:my-type-a")]
struct MyTypeA;
 
#[uri("urn:my-type-b")]
struct MyTypeB;

// Defining the collection.
#[derive(URIDCollection)]
struct MyCollection {
    my_type_a: URID<MyTypeA>,
    my_type_b: URID<MyTypeB>,
}

// Creating a mapper and collecting URIDs.
let map = HashURIDMapper::new();
let collection = MyCollection::from_map(&map).unwrap();

// Asserting.
assert_eq!(1, collection.my_type_a);
assert_eq!(2, collection.my_type_b);

Required methods

fn from_map<M>(map: &M) -> Option<Self> where
    M: Map + ?Sized, 

Construct the collection from the mapper.

Loading content...

Implementors

impl URIDCollection for AtomURIDCollection

pub fn from_map<M>(map: &M) -> Option<AtomURIDCollection> where
    M: Map + ?Sized, 

impl URIDCollection for MidiURIDCollection

pub fn from_map<M>(map: &M) -> Option<MidiURIDCollection> where
    M: Map + ?Sized, 

impl URIDCollection for UnitURIDCollection

pub fn from_map<M>(map: &M) -> Option<UnitURIDCollection> where
    M: Map + ?Sized, 

impl<T> URIDCollection for URID<T> where
    T: UriBound + ?Sized, 

pub fn from_map<M>(map: &M) -> Option<URID<T>> where
    M: Map + ?Sized, 

Loading content...