Skip to main content

PollingTrigger

Struct PollingTrigger 

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

A trigger that periodically polls an external source.

See the module-level documentation for usage examples.

§Examples

use std::time::Duration;
use ironflow_runtime::trigger::polling::{
    PollingTrigger, PollingTriggerConfig, PollingProbe, ProbeFuture, ProbeResult,
};

struct Stub;
impl PollingProbe for Stub {
    fn name(&self) -> &str { "stub" }
    fn poll(&self) -> ProbeFuture<'_> {
        Box::pin(async { Ok(Some(ProbeResult::new(serde_json::json!(null)))) })
    }
}

let trigger = PollingTrigger::new(PollingTriggerConfig {
    interval: Duration::from_secs(30),
    probe: Box::new(Stub),
    workflow_name: "ingest".to_string(),
    dedup: false,
});

Implementations§

Source§

impl PollingTrigger

Source

pub fn new(config: PollingTriggerConfig) -> Self

Create a new polling trigger.

§Examples
use std::time::Duration;
use ironflow_runtime::trigger::polling::{
    PollingTrigger, PollingTriggerConfig, PollingProbe, ProbeFuture, ProbeResult,
};

struct Stub;
impl PollingProbe for Stub {
    fn name(&self) -> &str { "stub" }
    fn poll(&self) -> ProbeFuture<'_> {
        Box::pin(async { Ok(Some(ProbeResult::new(serde_json::json!(null)))) })
    }
}

let trigger = PollingTrigger::new(PollingTriggerConfig {
    interval: Duration::from_secs(10),
    probe: Box::new(Stub),
    workflow_name: "check".to_string(),
    dedup: true,
});

Trait Implementations§

Source§

impl Trigger for PollingTrigger

Source§

fn name(&self) -> &str

Human-readable name for logging.
Source§

fn start<'a>( &'a self, sink: TriggerSink, token: &'a CancellationToken, ) -> TriggerFuture<'a>

Start the trigger. 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + 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
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<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