Struct IdMap

pub struct IdMap { /* private fields */ }

Bi-directional mapping between an integer id and a name ([u8]).

Backed by the filesystem.

Implementations

impl IdMap

pub fn open(path: impl AsRef<Path>) -> Result<Self>

Create an IdMap backed by the given directory.

By default, only read-only operations are allowed. For writing access, call [IdMap::make_writable] to get a writable instance.

impl IdMap

pub fn find_name_by_id(&self, id: Id) -> Result<Option<&[u8]>>

Find name by a specified integer id.

pub fn find_vertex_name_by_id(&self, id: Id) -> Result<Option<VertexName>>

Find VertexName by a specified integer id.

pub fn find_id_by_name(&self, name: &[u8]) -> Result<Option<Id>>

Find the integer id matching the given name.

pub fn find_id_by_name_with_max_group( &self, name: &[u8], max_group: Group, ) -> Result<Option<Id>>

Similar to find_name_by_id, but returns None if group > max_group.

pub fn insert(&mut self, id: Id, name: &[u8]) -> Result<()>

Insert a new entry mapping from a name to an id.

Errors if the new entry conflicts with existing entries.

Trait Implementations

impl Debug for IdMap

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

Formats the value using the given formatter.

impl IdConvert for IdMap

fn vertex_id<'life0, 'async_trait>( &'life0 self, name: VertexName, ) -> Pin<Box<dyn Future<Output = Result<Id>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn vertex_id_with_max_group<'life0, 'life1, 'async_trait>( &'life0 self, name: &'life1 VertexName, max_group: Group, ) -> Pin<Box<dyn Future<Output = Result<Option<Id>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

fn vertex_name<'life0, 'async_trait>( &'life0 self, id: Id, ) -> Pin<Box<dyn Future<Output = Result<VertexName>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn contains_vertex_name<'life0, 'life1, 'async_trait>( &'life0 self, name: &'life1 VertexName, ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

fn contains_vertex_id_locally<'life0, 'life1, 'async_trait>( &'life0 self, ids: &'life1 [Id], ) -> Pin<Box<dyn Future<Output = Result<Vec<bool>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Test if an id is present locally. Do not trigger remote fetching.

fn contains_vertex_name_locally<'life0, 'life1, 'async_trait>( &'life0 self, names: &'life1 [VertexName], ) -> Pin<Box<dyn Future<Output = Result<Vec<bool>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Test if an name is present locally. Do not trigger remote fetching.

fn map_id(&self) -> &str

Identity of the map.

fn map_version(&self) -> &VerLink

Version of the map. Useful to figure out compatibility between two maps.

fn vertex_id_optional<'life0, 'life1, 'async_trait>( &'life0 self, name: &'life1 VertexName, ) -> Pin<Box<dyn Future<Output = Result<Option<Id>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

fn vertex_name_batch<'life0, 'life1, 'async_trait>( &'life0 self, ids: &'life1 [Id], ) -> Pin<Box<dyn Future<Output = Result<Vec<Result<VertexName>>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Convert Ids to VertexNames in batch.

fn vertex_id_batch<'life0, 'life1, 'async_trait>( &'life0 self, names: &'life1 [VertexName], ) -> Pin<Box<dyn Future<Output = Result<Vec<Result<Id>>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Convert VertexNames to Ids in batch.

impl IdMapWrite for IdMap

fn insert<'life0, 'life1, 'async_trait>( &'life0 mut self, id: Id, name: &'life1 [u8], ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Insert a new (id, name) pair to the map.

fn remove_range<'life0, 'async_trait>( &'life0 mut self, low: Id, high: Id, ) -> Pin<Box<dyn Future<Output = Result<Vec<VertexName>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Remove ids in the range low..=high and their associated names. Return removed names.

impl Persist for IdMap

type Lock = File

Return type of lock().

fn lock(&mut self) -> Result<Self::Lock>

Obtain an exclusive lock for writing. This should prevent other writers.

fn reload(&mut self, _lock: &Self::Lock) -> Result<()>

Reload from the source of truth. Drop pending changes.

fn persist(&mut self, _lock: &Self::Lock) -> Result<()>

Write pending changes to the source of truth.

impl PrefixLookup for IdMap

fn vertexes_by_hex_prefix<'life0, 'life1, 'async_trait>( &'life0 self, hex_prefix: &'life1 [u8], limit: usize, ) -> Pin<Box<dyn Future<Output = Result<Vec<VertexName>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Lookup vertexes by hex prefix.

impl TryClone for IdMap

fn try_clone(&self) -> Result<Self>