JetstreamConnector

jetstream_oxide

Struct JetstreamConnector

pub struct JetstreamConnector { /* private fields */ }

Expand description

A wrapper connector type for working with a WebSocket connection to a Jetstream instance to receive and consume events. See JetstreamConnector::connect for more info.

Implementations§

impl JetstreamConnector

pub fn new(config: JetstreamConfig) -> Result<Self, ConfigValidationError>

Create a Jetstream connector with a valid JetstreamConfig.

After creation, you can call [connect] to connect to the provided Jetstream instance.

pub async fn connect(&self) -> Result<JetstreamReceiver, ConnectionError>

Connects to a Jetstream instance as defined in the JetstreamConfig.

A JetstreamReceiver is returned which can be used to respond to events. When all instances of this receiver are dropped, the connection and task are automatically closed.

Auto Trait Implementations§

impl Freeze for JetstreamConnector

impl RefUnwindSafe for JetstreamConnector

impl Send for JetstreamConnector

impl Sync for JetstreamConnector

impl Unpin for JetstreamConnector

impl UnwindSafe for JetstreamConnector

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Same for T

type Output = T

Should always be Self

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V