Skip to main content

JobStreamer

Struct JobStreamer 

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

Job streamer that polls endpoints and dispatches to handlers.

Implementations§

Source§

impl JobStreamer

Source

pub fn new( base_url: impl Into<String>, api_key: impl Into<String>, job_id: impl Into<String>, ) -> Self

Create a new job streamer.

Source

pub fn with_endpoints(self, endpoints: StreamEndpoints) -> Self

Set the stream endpoints.

Source

pub fn with_config(self, config: StreamConfig) -> Self

Set the stream config.

Source

pub fn with_handler(self, handler: Arc<dyn StreamHandler>) -> Self

Add a handler.

Source

pub fn add_handler<H: StreamHandler + 'static>(&mut self, handler: H)

Add a handler (convenience method).

Source

pub async fn poll_status(&mut self) -> Result<Option<Value>, CoreError>

Poll status once.

Source

pub async fn poll_events(&mut self) -> Result<Vec<StreamMessage>, CoreError>

Poll events once.

Source

pub async fn poll_metrics(&mut self) -> Result<Vec<StreamMessage>, CoreError>

Poll metrics once.

Source

pub async fn poll_timeline(&mut self) -> Result<Vec<StreamMessage>, CoreError>

Poll timeline once.

Source

pub async fn stream_until_terminal(&mut self) -> Result<Value, CoreError>

Stream until the job reaches a terminal state.

Source

pub async fn stream_for_duration( &mut self, max_seconds: f64, ) -> Result<Option<Value>, CoreError>

Stream for a maximum duration, returning early if terminal.

Source

pub fn job_id(&self) -> &str

Get the job ID.

Source

pub fn last_event_seq(&self) -> Option<i64>

Get the last event sequence number.

Source

pub fn clear_seen(&mut self)

Clear seen messages (for re-streaming).

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> 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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

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

Source§

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

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

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,