Skip to main content

SourceSpec

Struct SourceSpec 

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

The enabled indexes a source must build, each paired with its schema.

Everything here is treated as live — disabled indexes are dropped by the composition root when it translates the config into this spec, so the source never has to re-check an enabled flag.

Implementations§

Source§

impl SourceSpec

Source

pub fn new(indexes: BTreeMap<IndexName, IndexSchema>) -> Self

Build a spec from an explicit set of (index, schema) pairs. Every entry is treated as live; the caller (the composition root) is responsible for having filtered out disabled indexes when translating from a config.

Source

pub fn indexes(&self) -> impl Iterator<Item = (&IndexName, &IndexSchema)>

Iterate the indexes and their schemas, in index-name order.

Source

pub fn schema(&self, index: &IndexName) -> Option<&IndexSchema>

Source

pub fn index_mappings(&self) -> Vec<IndexMapping>

Project every index into its fully-typed IndexMapping, using only the declared schema — the database-free counterpart the engine creates indexes from up front.

Source

pub fn all_tables(&self) -> BTreeSet<QualifiedTable>

Every table any enabled index reads — each index’s root table plus every table a join or aggregate (and any through junction) pulls from.

Relations carry no schema of their own; the resolver qualifies a related table with the index’s db_schema (see the Postgres resolve module), so this does the same. This is the set a source must be able to stream — what CaptureProvisioning checks coverage against.

Trait Implementations§

Source§

impl Clone for SourceSpec

Source§

fn clone(&self) -> SourceSpec

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 SourceSpec

Source§

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

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

impl Default for SourceSpec

Source§

fn default() -> SourceSpec

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
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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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