Struct ExtensionRegistry

pub struct ExtensionRegistry { /* private fields */ }

Extension Registries store extensions to be looked up e.g. during validation.

Implementations

impl ExtensionRegistry

pub fn new_with_extension_resolution( extensions: impl IntoIterator<Item = Extension>, other_extensions: &WeakExtensionRegistry, ) -> Result<ExtensionRegistry, ExtensionResolutionError>

Given a list of extensions that has been deserialized, create a new registry while updating any internal Weak<Extension> reference to point to the newly created Arcs in the registry.

Errors

• If an opaque operation cannot be resolved to an extension operation.
• If an extension operation references an extension that is missing from the registry.
• If a custom type references an extension that is missing from the registry.

impl ExtensionRegistry

pub fn new(extensions: impl IntoIterator<Item = Arc<Extension>>) -> Self

Create a new empty extension registry.

pub fn load_json( reader: impl Read, other_extensions: &ExtensionRegistry, ) -> Result<Self, ExtensionRegistryLoadError>

Load an ExtensionRegistry serialized as json.

After deserialization, updates all the internal Weak<Extension> references to point to the newly created Arcs in the registry, or extensions in the additional_extensions parameter.

pub fn get(&self, name: &str) -> Option<&Arc<Extension>>

Gets the Extension with the given name

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

Returns true if the registry contains an extension with the given name.

pub fn validate(&self) -> Result<(), ExtensionRegistryError>

Validate the set of extensions.

pub fn register( &mut self, extension: impl Into<Arc<Extension>>, ) -> Result<(), ExtensionRegistryError>

Registers a new extension to the registry.

Returns a reference to the registered extension if successful.

pub fn register_updated(&mut self, extension: impl Into<Arc<Extension>>)

Registers a new extension to the registry, keeping the one most up to date if the extension already exists.

If extension IDs match, the extension with the higher version is kept. If versions match, the original extension is kept. Returns a reference to the registered extension if successful.

Takes an Arc to the extension. To avoid cloning Arcs unless necessary, see ExtensionRegistry::register_updated_ref.

pub fn register_updated_ref(&mut self, extension: &Arc<Extension>)

Registers a new extension to the registry, keeping the one most up to date if the extension already exists.

If extension IDs match, the extension with the higher version is kept. If versions match, the original extension is kept. Returns a reference to the registered extension if successful.

Clones the Arc only when required. For no-cloning version see ExtensionRegistry::register_updated.

pub fn len(&self) -> usize

Returns the number of extensions in the registry.

pub fn is_empty(&self) -> bool

Returns true if the registry contains no extensions.

pub fn iter(&self) -> <&Self as IntoIterator>::IntoIter

Returns an iterator over the extensions in the registry.

pub fn ids(&self) -> impl Iterator<Item = &ExtensionId>

Returns an iterator over the extensions ids in the registry.

pub fn remove_extension(&mut self, name: &ExtensionId) -> Option<Arc<Extension>>

Delete an extension from the registry and return it if it was present.

pub fn new_cyclic<F, E>( extensions: impl IntoIterator<Item = Extension>, init: F, ) -> Result<Self, E>

where F: FnOnce(Vec<Extension>, &WeakExtensionRegistry) -> Result<Vec<Extension>, E>,

Constructs a new ExtensionRegistry from a list of Extensions while giving you a WeakExtensionRegistry to the allocation. This allows you to add Weak self-references to the Extensions while constructing them, before wrapping them in Arcs.

This is similar to Arc::new_cyclic, but for ExtensionRegistries.

Calling Weak::upgrade on a weak reference in the WeakExtensionRegistry inside your closure will return an extension with no internal (op / type / value) definitions.

Trait Implementations

impl Clone for ExtensionRegistry

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExtensionRegistry

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

Formats the value using the given formatter.

impl Default for ExtensionRegistry

fn default() -> ExtensionRegistry

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ExtensionRegistry

Encode/decode ExtensionRegistry as a list of extensions.

Any Weak<Extension> references inside the registry will be left unresolved. Prefer using ExtensionRegistry::load_json when deserializing.

fn deserialize<D>(deserializer: D) -> Result<ExtensionRegistry, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ExtensionRegistry

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

Formats the value using the given formatter.

impl<'a> Extend<&'a Arc<Extension>> for ExtensionRegistry

fn extend<T: IntoIterator<Item = &'a Arc<Extension>>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Extend<Arc<Extension>> for ExtensionRegistry

fn extend<T: IntoIterator<Item = Arc<Extension>>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<'a> From<&'a ExtensionRegistry> for WeakExtensionRegistry

fn from(reg: &'a ExtensionRegistry) -> Self

Converts to this type from the input type.

impl<'a> IntoIterator for &'a ExtensionRegistry

type Item = &'a Arc<Extension>

The type of the elements being iterated over.

type IntoIter = Values<'a, IdentList, Arc<Extension>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for ExtensionRegistry

type Item = Arc<Extension>

The type of the elements being iterated over.

type IntoIter = IntoValues<IdentList, Arc<Extension>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for ExtensionRegistry

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ExtensionRegistry

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> TryFrom<&'a WeakExtensionRegistry> for ExtensionRegistry

type Error = ()

The type returned in the event of a conversion error.

fn try_from(weak: &'a WeakExtensionRegistry) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<WeakExtensionRegistry> for ExtensionRegistry

type Error = ()

The type returned in the event of a conversion error.

fn try_from(weak: WeakExtensionRegistry) -> Result<Self, Self::Error>

Performs the conversion.