Struct PixClient

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

A strongly typed client for performing requests to a pix-api compliant provider.

§Example

Implementations§

Source§

impl PixClient

Source

pub fn cob(&self) -> CobEndpoint<'_>

Source§

impl PixClient

Source

pub fn webhook(&self) -> WebhookEndpoint<'_>

Source§

impl PixClient

Source

pub fn oauth(&self) -> OauthTokenEndpoint<'_>

Source§

impl PixClient

Source

pub fn new_with_custom_headers<F>( endpoint: &str, custom_headers: F, certificate: Vec<u8>, ) -> PixClient
where F: FnMut(&mut HeaderMap),

Creates a new PixClient with customized headers.

This is specially useful, since how the authorization is encoded varies between PSP’s.

§Example
use pix_api_client::PixClient;
use reqwest::header;

let mut cert_buffer = Vec::new();
File::open("my_cert.pem")?.read_to_end(&mut cert_buffer)?;

let username = "my-id";
let secret = "my-secret";
let formatted_authorization = format!("{}:{}", username, secret);
let encoded_auth = base64::encode(formatted_authorization);

let pix_client = PixClient::new_with_custom_headers(
    "https://*",
    |headers| {
        headers
            .insert(header::AUTHORIZATION, encoded_auth.parse().unwrap())
            .unwrap();
    },
    cert_buffer,
);
Source

pub fn swap_authorization_token(&self, authorization_header_value: String)

Call this method in order to change the value of your Authorization header.

For Bearer: format!("Bearer {}", token)

For Basic: format!("Basic {}:{}", id, secret)

This is usually done after you fetch the oauth token.

Trait Implementations§

Source§

impl Debug for PixClient

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. 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> 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, 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<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<T> ErasedDestructor for T
where T: 'static,