Struct artichoke_backend::module::Registry

pub struct Registry<S = RandomState>(_);

A registry for Module specs that uses types as keys.

This data structure is used for associating data type metadata with a Rust type which can be used to ensure the lifetime of the associated metadata.

Example: mrb_data_type

In the mruby C API, custom data types define a mrb_data_type struct which contains the custom data type's module name and free function. The C API requires that this struct live at least as long as the mrb_state. Typically, the mrb_data_type is static.

static const struct mrb_data_type mrb_time_type = { "Time", mrb_free };

The registry resembles an append-only HashMap.

The registry stores Module specs behind a Box pointer to ensure pointers to the interior of the spec, like the CString module name, are not invalidated as the underlying storage reallocates.

Implementations

impl Registry<RandomState>

#[must_use]pub fn new() -> Self

Construct a new, empty Registry.

#[must_use]pub fn with_capacity(capacity: usize) -> Self

Construct a new Registry with the given capacity.

impl<S> Registry<S>

#[must_use]pub fn with_hasher(hash_builder: S) -> Self

Construct a new Registry with the given hash_builder.

#[must_use]pub fn with_capacity_and_hasher(capacity: usize, hash_builder: S) -> Self

Construct a new Registry with the given capacity and hash_builder.

#[must_use]pub fn capacity(&self) -> usize

Returns the number of module specs the registry can hold without reallocating.

This number is a lower bound; the Registry might be able to hold more, but is guaranteed to be able to hold at least this many.

#[must_use]pub fn module_specs(&self) -> ModuleSpecs<'_>

An iterator of all module specs stored in the Registry in arbitrary order.

#[must_use]pub fn len(&self) -> usize

Returns the number of module specs in the registry.

#[must_use]pub fn is_empty(&self) -> bool

Returns true if the registry contains module specs.

#[must_use]pub fn hasher(&self) -> &S

Returns a reference to the registry's BuildHasher.

impl<S> Registry<S> where
    S: BuildHasher, 

#[must_use]pub fn contains<K>(&self) -> bool where
    K: Any, 

Returns true if the registry contains a module spec for the specified type.

pub fn insert<K>(&mut self, spec: Box<Spec>) where
    K: Any, 

Inserts a type-module spec pair into the registry.

This operation will only succeed if K has never been inserted into the registry.

Panics

If insert has previously been called with type K, this function will panic. Registry is append-only and does not allow mutations.

#[must_use]pub fn get<K>(&self) -> Option<&Spec> where
    K: Any, 

Returns a reference to the module spec corresponding to the type key.

If the type K has not been registered, None is returned.

pub fn reserve(&mut self, additional: usize)

Reserves capacity for at least additional more elements to be inserted in the Registry. The collection may reserve more space to avoid frequent reallocations.

pub fn shrink_to_fit(&mut self)

Shrinks the capacity of the map as much as possible. It will drop down as much as possible while maintaining the internal rules and possibly leaving some space in accordance with the resize policy.

Trait Implementations

impl<S: Debug> Debug for Registry<S>

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

Formats the value using the given formatter.

impl<S: Default> Default for Registry<S>

fn default() -> Registry<S>

Returns the "default value" for a type.

impl<S> Eq for Registry<S> where
    S: BuildHasher, 

impl<'a, S> IntoIterator for &'a Registry<S>

type Item = &'a Spec

The type of the elements being iterated over.

type IntoIter = ModuleSpecs<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<S> PartialEq<Registry<S>> for Registry<S> where
    S: BuildHasher, 

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.