Skip to main content

Source

Struct Source 

Source
pub struct Source<T: Record> { /* private fields */ }
Expand description

A streaming data source. Cloneable for multi-producer use.

Implementations§

Source§

impl<T: Record> Source<T>

Source

pub fn push(&self, record: T) -> Result<(), StreamingError>

Pushes a record. Non-blocking — returns ChannelFull if the buffer is full.

§Errors

Returns StreamingError::ChannelFull if the buffer is full or the sink was dropped.

Source

pub fn try_push(&self, record: T) -> Result<(), TryPushError<T>>

Pushes a record, returning it on failure.

§Errors

Returns TryPushError containing the record if the channel is full.

Source

pub fn push_batch(&self, records: &[T]) -> usize
where T: Clone,

Pushes multiple records (cloned). Stops at the first failure.

Source

pub fn push_batch_drain<I>(&self, records: I) -> usize
where I: IntoIterator<Item = T>,

Pushes records from an iterator, consuming them (zero-clone). Stops at the first failure. Returns the number pushed.

Source

pub fn push_arrow(&self, batch: RecordBatch) -> Result<(), StreamingError>

Pushes an Arrow RecordBatch directly.

This is more efficient than pushing individual records when you already have data in Arrow format.

§Errors

Returns StreamingError::SchemaMismatch if the batch schema doesn’t match. Returns StreamingError::ChannelClosed if the sink has been dropped.

Source

pub fn watermark(&self, timestamp: i64)

Emits a watermark timestamp.

Watermarks signal that no events with timestamps less than or equal to this value will arrive in the future. This enables window triggers and garbage collection.

Watermarks are monotonically increasing - if a lower timestamp is passed, it will be ignored.

Source

pub fn current_watermark(&self) -> i64

Returns the current watermark value.

Source

pub fn schema(&self) -> SchemaRef

Returns the schema for this source.

Source

pub fn name(&self) -> Option<&str>

Returns the source name, if configured.

Source

pub fn is_closed(&self) -> bool

Returns true if the sink has been dropped.

Source

pub fn pending(&self) -> usize

Returns the number of pending items in the buffer.

Source

pub fn capacity(&self) -> usize

Returns the buffer capacity.

Source

pub fn sequence(&self) -> u64

Returns the current sequence number (total successful pushes).

Source

pub fn sequence_counter(&self) -> Arc<AtomicU64>

Returns the shared sequence counter for checkpoint registration.

Source

pub fn watermark_atomic(&self) -> Arc<AtomicI64>

Returns the shared watermark atomic for checkpoint registration.

Source

pub fn set_event_time_column(&self, column: &str)

Declare which column in the source data represents event time.

When set, source.watermark() enables late-row filtering without a SQL WATERMARK FOR clause.

Only the first call takes effect; subsequent calls are silently ignored.

Source

pub fn event_time_column(&self) -> Option<String>

Returns the configured event-time column, if any.

Source

pub fn set_max_out_of_orderness(&self, dur: Duration)

Set the max out-of-orderness bound for watermark generation.

Only the first call takes effect; subsequent calls are silently ignored.

Source

pub fn max_out_of_orderness(&self) -> Option<Duration>

Returns the configured max out-of-orderness, if any.

Trait Implementations§

Source§

impl<T: Record> Clone for Source<T>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Record + Debug> Debug for Source<T>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> Freeze for Source<T>

§

impl<T> !RefUnwindSafe for Source<T>

§

impl<T> Send for Source<T>

§

impl<T> Sync for Source<T>

§

impl<T> Unpin for Source<T>

§

impl<T> UnsafeUnpin for Source<T>

§

impl<T> !UnwindSafe for Source<T>

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
§

impl<T> ArchivePointee for T

§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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.

§

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.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> LayoutRaw for T

§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
§

impl<T> Pointee for T

§

type Metadata = ()

The metadata type for pointers and references to this type.
§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> Scope for T

§

fn with<F, R>(self, f: F) -> R
where Self: Sized, F: FnOnce(Self) -> R,

Scoped with ownership.
§

fn with_ref<F, R>(&self, f: F) -> R
where F: FnOnce(&Self) -> R,

Scoped with reference.
§

fn with_mut<F, R>(&mut self, f: F) -> R
where F: FnOnce(&mut Self) -> R,

Scoped with mutable reference.
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<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

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
§

impl<T> Value for T
where T: Send + Sync + 'static,