Skip to main content

PcsExternalClientBuilder

Struct PcsExternalClientBuilder 

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

Builder for PcsExternalClient<S>.

§Minimal wiring

use pcs_external::{PcsExternalClientBuilder, scopes::SendOnly};

let client = PcsExternalClientBuilder::new(
    "https://api.ppoppo.com/ext",
    "https://accounts.ppoppo.com/oauth/token",
    "my-client-id",
    "my-client-secret",
)
.build::<SendOnly>()
.await?;

§From environment variables

Reads PCS_API_URL, PAS_TOKEN_URL, PAS_PCS_CLIENT_ID, PAS_PCS_CLIENT_SECRET. Returns None if any is unset.

use pcs_external::{PcsExternalClientBuilder, scopes::SendOnly};

let client = PcsExternalClientBuilder::from_env()?
    .build::<SendOnly>()
    .await
    .ok()?;

Implementations§

Source§

impl PcsExternalClientBuilder

Source

pub fn new( api_url: impl Into<String>, token_url: impl Into<String>, client_id: impl Into<String>, client_secret: impl Into<String>, ) -> Self

Construct from explicit parameters.

Source

pub fn from_env() -> Option<Self>

Construct from environment variables.

Reads:

  • PCS_API_URL — e.g. https://api.ppoppo.com/ext
  • PAS_TOKEN_URL — e.g. https://accounts.ppoppo.com/oauth/token
  • PAS_PCS_CLIENT_ID — OAuth2 client_id
  • PAS_PCS_CLIENT_SECRET — OAuth2 client_secret

Returns None if any variable is missing.

Source

pub fn with_cache_config(self, config: TokenCacheConfig) -> Self

Override the token cache configuration (e.g. refresh_skew).

Source

pub async fn build<S: PcsExternalScopeSet>( self, ) -> Result<PcsExternalClient<S>, Error>

Build the client, connecting to the PCS External API endpoint.

§Errors

Returns Error::Transport or Error::InvalidPathPrefix if the connection cannot be established.

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> 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, 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