Skip to main content

SchemaRegistry

Struct SchemaRegistry 

Source
pub struct SchemaRegistry { /* private fields */ }
Expand description

Registry of metric and event schema metadata linked into the current binary.

global lazily discovers every spectra_schema! and spectra_metric! registration submitted through inventory. Schema modules must be compiled into the binary (linked with mod); declaring macros alone in unlinked files does not register them.

§Examples

use spectra_core::SchemaRegistry;

let registry = SchemaRegistry::global();
for name in registry.list_schemas() {
    let schema = registry.get_schema(name).expect("listed schema");
    println!("{} uses store {}", schema.table_name(), schema.store);
}

// "default" is always available even when this binary declares no schemas.
assert!(registry.distinct_store_names().iter().any(|name| name == "default"));

Implementations§

Source§

impl SchemaRegistry

Source

pub fn new() -> SchemaRegistry

Creates an empty registry.

Source

pub fn auto_discover() -> SchemaRegistry

Populate from all inventory::submit!-ed SchemaMetadataInit items.

Source

pub fn set_global(registry: SchemaRegistry)

Installs a custom registry as the process-global instance (call once).

Source

pub fn global() -> &'static SchemaRegistry

Returns the process-global registry, auto-discovering on first access.

Source

pub fn register(&mut self, metadata: &'static SchemaMetadata)

Registers a leaked schema metadata entry.

Source

pub fn get_schema( &self, table_or_metric: &str, ) -> Option<&'static SchemaMetadata>

Looks up schema metadata by table or metric name.

Source

pub fn list_schemas(&self) -> Vec<&str>

Lists all registered table and metric names.

Source

pub fn has_schema(&self, table_or_metric: &str) -> bool

Returns whether a schema is registered.

Source

pub fn distinct_store_names(&self) -> Vec<String>

Distinct store names from all registered schemas, always including "default".

Methods from Deref<Target = Registry<SchemaMetadata>>§

Source

pub fn get(&self, key: &str) -> Option<&'static T>

Look up an item by registry key.

Source

pub fn list(&self) -> Vec<&str>

Returns all registered keys in arbitrary order.

Source

pub fn len(&self) -> usize

Return the number of registered items.

Source

pub fn is_empty(&self) -> bool

Return true when no items are registered.

Source

pub fn iter(&self) -> impl Iterator<Item = &'static T>

Iterates over all registered descriptors in arbitrary order.

Trait Implementations§

Source§

impl Debug for SchemaRegistry

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for SchemaRegistry

Source§

fn default() -> SchemaRegistry

Returns the “default value” for a type. Read more
Source§

impl Deref for SchemaRegistry

Source§

type Target = Registry<SchemaMetadata>

The resulting type after dereferencing.
Source§

fn deref(&self) -> &<SchemaRegistry as Deref>::Target

Dereferences the value.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<U> As for U

Source§

fn as_<T>(self) -> T
where T: CastFrom<U>, U: Sized,

Casts self to type T. The semantics of numeric casting with the as operator are followed, so <T as As>::as_::<U> can be used in the same way as T as U for numeric conversions. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Is for T
where T: ?Sized,

Source§

type EqTo = T

Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more