Struct IntervalPipe 

pub struct IntervalPipe { /* private fields */ }

Periodic producer Pipe. Fires every period, dispatches a Request built by request_factory to inner.

The pipe is content-agnostic: the request factory decides whether the body is empty Bytes, Bytes::from_static(b"..."), a Carry typed payload, or stream — anything the spine can hold. The method-byte and path are configurable per the discriminant convention; default to TICK / /tick so a bare IntervalPipe works as a heartbeat source without any extra config.

Implementations

impl IntervalPipe

pub fn new( period: Duration, inner: PipeHandle, request_factory: RequestFactory, name: impl Into<String>, ) -> Self

Construct directly. Most callers should use Self::builder.

pub fn builder() -> IntervalPipeBuilder

Fluent builder entry point (workspace principle 4).

pub fn name(&self) -> &str

The source’s label, set via IntervalPipeBuilder::name (default "interval"). Used as the ProducerLifecycle::spawn_from_source task name by convention; carries no other runtime behaviour.

pub fn empty_request_factory() -> RequestFactory

Build the default RequestFactory — emits a Request with method DEFAULT_TICK_METHOD, path DEFAULT_TICK_PATH, no headers, and an empty Bytes body. Useful when the inner Pipe only cares about the timing edge, not the payload.

Trait Implementations

impl SendPipe for IntervalPipe

type In = Signal

Input the pipe consumes.

type Out = ()

Output the pipe produces.

type Err = ProximaError

Error the pipe can fail with — Send here so it can cross cores.

fn call( &self, cancel: Signal, ) -> impl Future<Output = Result<(), ProximaError>> + Send

Apply the pipe. The returned future IS Send.