Skip to main content

RealtimePipeline

Struct RealtimePipeline 

Source
pub struct RealtimePipeline<T: Send + 'static, O: Send + 'static> { /* private fields */ }
Expand description

Real-time streaming pipeline with backpressure.

Wraps any StreamingPipeline with a bounded input queue and drives it from a background worker thread. Flow control works as follows:

  • send blocks the caller when the queue is full — the producer is naturally throttled without any explicit rate-limiter code.
  • try_send never blocks; it drops the item and increments RealtimeMetrics::items_dropped when the queue is full.
  • Call finish to close the input, drain remaining items, join the worker, and retrieve the pipeline’s final output.
  • Dropping the pipeline without calling finish is safe: the channel is closed and the worker is joined in the Drop impl (result discarded).

§Example

use threecrate_algorithms::streaming::{
    StreamingCollector, BackpressureConfig, RealtimePipeline,
};
use threecrate_core::Point3f;

let config = BackpressureConfig { max_queue_depth: 64, chunk_size: 16, ..Default::default() };
let rt = RealtimePipeline::new(StreamingCollector::new(), config);
for i in 0..50_u32 {
    rt.send(Point3f::new(i as f32, 0.0, 0.0)).unwrap();
}
let cloud = rt.finish().unwrap();
assert_eq!(cloud.len(), 50);

Implementations§

Source§

impl<T: Send + 'static, O: Send + 'static> RealtimePipeline<T, O>

Source

pub fn new<P>(pipeline: P, config: BackpressureConfig) -> Self
where P: StreamingPipeline<T, Output = O> + Send + 'static,

Create a new real-time pipeline backed by pipeline.

The worker thread starts immediately and is ready to receive items.

Source

pub fn send(&self, item: T) -> Result<()>

Send an item, blocking until queue space is available (backpressure).

Returns Err if the worker thread has unexpectedly terminated.

Source

pub fn try_send(&self, item: T) -> Result<bool>

Try to send without blocking.

Returns Ok(true) when the item was queued, Ok(false) when the queue was full and the item was dropped (counted in RealtimeMetrics::items_dropped). Returns Err if the worker has terminated unexpectedly.

Source

pub fn metrics(&self) -> RealtimeMetrics

Snapshot current pipeline metrics.

Source

pub fn finish(self) -> Result<O>

Close the input queue, wait for the worker to drain all buffered items, and return the pipeline’s final output.

Trait Implementations§

Source§

impl<T: Send + 'static, O: Send + 'static> Drop for RealtimePipeline<T, O>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

Auto Trait Implementations§

§

impl<T, O> Freeze for RealtimePipeline<T, O>

§

impl<T, O> !RefUnwindSafe for RealtimePipeline<T, O>

§

impl<T, O> Send for RealtimePipeline<T, O>

§

impl<T, O> Sync for RealtimePipeline<T, O>

§

impl<T, O> Unpin for RealtimePipeline<T, O>

§

impl<T, O> UnsafeUnpin for RealtimePipeline<T, O>

§

impl<T, O> !UnwindSafe for RealtimePipeline<T, O>

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

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

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

Source§

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

Source§

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