Client

Struct Client 

Source
pub struct Client<'a> {
    pub sender: Option<&'a Account>,
    /* private fields */
}
Expand description

Client object for interacting with the API

You are forced to use this as a proxy for authentication: it is essentially a factory, but named for convenience (I think). A Client object can be constructed the constructors [new], [from_auth], [from_basic_auth], or [from_apikey].

Creates a synchronous (currently) client. Optimistically, we will implement an async version through tokio, but I have absolutely no idea what that entails.

§Examples

This example details the basic task of retrieving a quote from the Transdirect API.

#[ignore]

use transdirect::{TransdirectClient, BookingRequest};

Fields§

§sender: Option<&'a Account>

Implementations§

Source§

impl<'a> Client<'a>

Source

pub fn new() -> Self

Source

pub fn from_auth(auth: AuthenticateWith<'_>) -> Result<Self, Error>

Source

pub fn from_basic(user: &str, password: &str) -> Result<Self, Error>

Source

pub fn from_api_key(apikey: &str) -> Result<Self, Error>

Source

pub fn auth(&mut self, auth: AuthenticateWith<'_>) -> Result<(), Error>

Source

pub fn quotes<'b, T, U>( &self, request: &'b BookingRequest<'_, T, U>, ) -> Result<BookingResponse<T, U>, Error>

Source

pub fn booking<T, U>( &self, booking_id: u32, ) -> Result<BookingResponse<T, U>, Error>

Gets a copy of a booking from its id; note that this is different from its connote (consignment note or tracking number).

§Examples
use transdirect::BookingResponse;
use transdirect::TransdirectClient as Client;
let c = Client::new();
//...
let oldbooking: BookingResponse = c.booking(623630).expect("Valid booking");
// Do something interesting

Auto Trait Implementations§

§

impl<'a> !Freeze for Client<'a>

§

impl<'a> !RefUnwindSafe for Client<'a>

§

impl<'a> Send for Client<'a>

§

impl<'a> Sync for Client<'a>

§

impl<'a> Unpin for Client<'a>

§

impl<'a> !UnwindSafe for Client<'a>

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,