Skip to main content

Engine

Struct Engine 

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

Drives changes from a source through to a sink.

Implementations§

Source§

impl Engine

Source

pub fn new( source: Arc<dyn ChangeCapture>, documents: Arc<dyn DocumentBuilder>, sink: Arc<dyn Sink>, ) -> Self

Source

pub fn with_observer(self, observer: Arc<dyn Observer>) -> Self

Report lifecycle and progress events to observer (metrics, a live status surface, …). Defaults to NoopObserver. See Observer.

Source

pub fn with_queue_capacity(self, capacity: usize) -> Self

Set how many changes may buffer between capture and the worker.

Source

pub fn with_batch(self, batch: BatchPolicy) -> Self

Set how the worker groups changes into one sink flush (see BatchPolicy). max_changes is clamped to at least 1.

Source

pub fn skip_backfill(self, skip: bool) -> Self

Force-skip the backfill phase entirely, regardless of what the sink reports. An escape hatch for sinks that can’t persist seeded-state (so they would otherwise re-seed every run) or to resume without re-checking.

Source

pub fn with_failure_policies(self, policies: FailurePolicies) -> Self

Set how the engine resolves the policy for documents a sink rejects at the item level (see FailurePolicies). Defaults to FailurePolicy::Stop for every index.

Source

pub async fn run(self) -> Result<()>

Run until the live change stream ends or an error stops the pipeline.

First seeds any unseeded index (unless skip_backfill is set), then follows live changes.

Trait Implementations§

Source§

impl Debug for Engine

Source§

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

Formats the value using the given formatter. 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> 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, 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