Struct indicator::gat::tumbling_operator::periodic::Periodic

pub struct Periodic<Q, const PUSH_FIRST: bool> { /* private fields */ }

Periodic Operator Builder.

Implementations

impl<Q, const PUSH_FIRST: bool> Periodic<Q, PUSH_FIRST>where Q: Queue,

pub fn new(queue: Q, period: Period) -> Self

Create a new periodic operator with the given queue.

impl<Q> Periodic<Q, true>where Q: Queue, Q::Item: Clone,

pub fn build<I, P>(self, op: P) -> TumblingOperator<Q, Op<P, true>>where I: Tickable, P: PeriodicOp<I, Q::Item>,

Build the periodic operator.

pub fn build_fn<I, F>( self, f: F ) -> TumblingOperator<Q, Op<PeroidicFn<F>, true>>where I: Tickable, F: for<'a> FnMut(QueueRef<'a, Q::Item>, bool, I) -> Q::Item,

Build the periodic operator using the given closure.

impl<Q> Periodic<Q, false>where Q: Queue,

pub fn build<I, P>(self, op: P) -> TumblingOperator<Q, Op<P, false>>where I: Tickable, P: PeriodicOp<I, Q::Item>,

Build periodic operator.

pub fn build_cache( self ) -> impl for<'out> GatOperator<Q::Item, Output<'out> = TickQueueRef<'out, Q::Item>>where Q: Queue + 'static, Q::Item: Tickable + 'static,

Build a cache operator.

pub fn build_fn<I, F>( self, f: F ) -> TumblingOperator<Q, Op<PeroidicFn<F>, false>>where I: Tickable, F: for<'a> FnMut(QueueRef<'a, Q::Item>, bool, I) -> Q::Item,

Build the periodic operator using the given closure.

pub fn push_first(self) -> Periodic<Q, true>where Q::Item: Clone,

Push before calculation.

impl Periodic<(), false>

pub fn with_circular<T>( length: NonZeroUsize, period: Period ) -> Periodic<Circular<0, T>, false>

Create a new periodic operator builder using circular queue.

pub fn with_circular_n<const N: usize, T>( period: Period ) -> Periodic<Circular<N, T>, false>

Create a new periodic operator builder using circular queue.

Panic

Panic if N is zero.

Trait Implementations

impl<Q: Clone, const PUSH_FIRST: bool> Clone for Periodic<Q, PUSH_FIRST>

fn clone(&self) -> Periodic<Q, PUSH_FIRST>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Q: Debug, const PUSH_FIRST: bool> Debug for Periodic<Q, PUSH_FIRST>

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

Formats the value using the given formatter.

impl<Q: Copy, const PUSH_FIRST: bool> Copy for Periodic<Q, PUSH_FIRST>