Skip to main content

Catalogue

Struct Catalogue 

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

The validated catalogue and every index derived from it. Immutable: built once from an index and a registry, read many times.

Implementations§

Source§

impl Catalogue

Source

pub fn build(index: &Index, registry: &CapabilityRegistry) -> Self

Build the catalogue from an index and the registry its capability references resolve against. Deterministic: the same objects produce the same value, and no derivation reads a clock or the filesystem.

Source§

impl Catalogue

Source

pub fn all(&self) -> &[Moment]

Every moment the catalogue holds, in presentation order, whatever its status.

Source

pub fn audiences(&self) -> &[Audience]

Every audience, in presentation order.

Source

pub fn areas(&self) -> &[Area]

Every area, in presentation order.

Source

pub fn moment(&self, id: &str) -> Option<&Moment>

One moment by id.

Source

pub fn audience(&self, id: &str) -> Option<&Audience>

One audience by id.

Source

pub fn area(&self, id: &str) -> Option<&Area>

One area by id.

Source

pub fn findings(&self) -> &[Finding]

Every finding: unresolved references, duplicate identities, and records that do not meet the floor their status promises.

Source

pub fn errors(&self) -> usize

How many findings are errors.

Source

pub fn fingerprint(&self) -> &str

The hash of the catalogue’s own sources.

Source

pub fn responsibilities(&self, id: &str) -> &[String]

The responsibilities a moment touches, derived from the claims it names.

The moments that name this one in their related. Never authored.

Source

pub fn naming(&self, field: &str, value: &str) -> Vec<&Moment>

The moments that name this thing, whatever kind of thing it is. This is the one reverse index every “the moments this answers” list is read from.

Source

pub fn signal_owner(&self, signal: &str) -> Option<&Moment>

The moment a signal belongs to.

Source

pub fn select(&self, q: &Query) -> Vec<&Moment>

The moments a query selects, in presentation order.

Source§

impl Catalogue

Source

pub fn facets(&self) -> Facets

The facets, counted over the public moments. A value with no public moment is not offered: a filter that answers nothing is not a filter.

Source§

impl Catalogue

Source

pub fn diagnose(&self, selected: &[String]) -> Diagnosis

Diagnose a selection. Each name may be a signal id or a moment id; a signal resolves to the moment that owns it, so a reader ticking symptoms and a script naming moments reach the same answer.

Trait Implementations§

Source§

impl Clone for Catalogue

Source§

fn clone(&self) -> Catalogue

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Catalogue

Source§

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

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

impl Default for Catalogue

Source§

fn default() -> Catalogue

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

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<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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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.

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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