Skip to main content

PcsExternalClient

Struct PcsExternalClient 

Source
pub struct PcsExternalClient<S: PcsExternalScopeSet> { /* private fields */ }
Expand description

Phantom-typed gRPC client for the PCS External Developer Platform.

The type parameter S: PcsExternalScopeSet constrains which methods are callable at compile time. Construct via crate::PcsExternalClientBuilder.

§Capability gating

MethodRequired capability
send_alertS: SendAlertCapable
get_send_statusS: GetSendStatusCapable

Calling a method your scope set doesn’t satisfy is a compile-time E0277 — see crate::scopes for the compile_fail doctest.

Implementations§

Source§

impl<S: SendAlertCapable> PcsExternalClient<S>

Source

pub async fn send_alert( &self, template: &TemplateId, recipients: &RecipientList, poll: Option<&PollConfig>, ) -> Result<SendOutcome, Error>

Send a batch of templated messages to recipients.

Translates to ExternalMessageService::CreateSendRequest.

§Errors
Source§

impl<S: GetSendStatusCapable> PcsExternalClient<S>

Source

pub async fn get_send_status( &self, id: &SendRequestId, ) -> Result<SendStatus, Error>

Poll aggregate delivery status for a previously-issued send request.

Translates to ExternalMessageService::GetSendRequestStatus.

§Errors

Same shape as PcsExternalClient::send_alert.

Source

pub async fn stream_send_request_events( &self, send_request_id: Option<&SendRequestId>, after_event_id: Option<&str>, ) -> Result<DeliveryStream, Error>

Open a server-streaming delivery event channel.

Streams per-recipient lifecycle events for all send requests issued by this app. Pass after_event_id to resume from a cursor after a reconnect so no events are replayed.

§Errors

Returns crate::Error::TokenRefresh if the JWT cannot be acquired, crate::Error::Rejected / crate::Error::Transport if the initial RPC handshake fails. Stream-level errors surface through DeliveryStream::message.

Trait Implementations§

Source§

impl<S: PcsExternalScopeSet> Clone for PcsExternalClient<S>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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