Skip to main content

PublishSink

Struct PublishSink 

Source
pub struct PublishSink<T> { /* private fields */ }
Expand description

A bidirectional streaming publish sink for the Salesforce Pub/Sub API.

Created by crate::handler::PubSubHandler::publish_stream. Holds an open gRPC PublishStream channel and allows callers to send multiple batches of events, streaming publish acknowledgements back.

§Type parameter

T is the event payload type. It must implement serde::Serialize so that payloads can be Avro-encoded before transmission.

§Example

let mut sink = handler.publish_stream::<MyEvent>("/event/MyEvent__e").await?;

sink.send("schema-id", vec![MyEvent { id: "e1".into() }]).await?;
sink.send("schema-id", vec![MyEvent { id: "e2".into() }]).await?;

// Drain acknowledgement responses
let mut acks = sink.responses();
while let Some(resp) = acks.next().await {
    let r = resp?;
    println!("acked {} event(s) on {}", r.results.len(), r.topic_name);
}
sink.close().await?;

Implementations§

Source§

impl<T: Serialize + Send + 'static> PublishSink<T>

Source

pub async fn send(&mut self, schema_id: &str, events: Vec<T>) -> Result<()>

Encode a batch of events and send them to the open PublishStream.

The Avro schema is resolved via the schema cache (or fetched from the GetSchema RPC on a miss). Subsequent calls reuse the cached schema.

§Errors
Source

pub fn responses( &mut self, ) -> &mut (impl Stream<Item = Result<PublishResponse>> + '_)

Return a reference to the server acknowledgement response stream.

Each item is a PublishResponse containing per-event results for the most recently acknowledged batch.

§Errors

Items may be Err(PubSubError::Transport) if the gRPC stream reports an error.

Source

pub async fn close(self) -> Result<()>

Close the sink.

Drops the sender side of the mpsc channel, which signals to tonic that the client input stream is complete. Then drains any remaining server acknowledgement responses so the gRPC stream shuts down cleanly.

§Errors

Returns the first transport error encountered while draining responses, if any.

Auto Trait Implementations§

§

impl<T> Freeze for PublishSink<T>

§

impl<T> !RefUnwindSafe for PublishSink<T>

§

impl<T> Send for PublishSink<T>
where T: Send,

§

impl<T> !Sync for PublishSink<T>

§

impl<T> Unpin for PublishSink<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for PublishSink<T>

§

impl<T> !UnwindSafe for PublishSink<T>

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

Source§

fn into_request(self) -> Request<T>

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

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
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