ClientBuilder

Struct ClientBuilder 

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

§Example

  use lib_mal::ClientBuilder;
  fn example() {
     let client = ClientBuilder::new().secret("[YOUR_CLIENT_ID]".to_string()).access_token("exampleExAmPlE".to_string()).build_no_refresh();
  }

Implementations§

Source§

impl ClientBuilder

Source

pub fn new() -> Self

Creates a new ClientBuilder. All fields are set to None by default.

Source

pub fn secret(self, secret: impl Into<Option<String>>) -> Self

Sets the client_secret

§Example
     let client =
     ClientBuilder::new().secret("[YOUR_CLIENT_ID]".to_string()).build_no_refresh();

     let another_client = ClientBuilder::new().secret(None).build_no_refresh();
Source

pub fn cache_dir(self, path: impl Into<Option<PathBuf>>) -> Self

Sets the directory the client will use to cache the tokens

§Example
use std::path::PathBuf;
    let client = ClientBuilder::new().cache_dir(PathBuf::new()).build_no_refresh();
Source

pub fn access_token(self, token: impl Into<Option<String>>) -> Self

Sets the access token for the client

§Example
    let client =
    ClientBuilder::new().access_token("exampleToKeN".to_string()).build_no_refresh();
Source

pub fn caching(self, caching: bool) -> Self

Sets wether or not the client should cache the tokens

§Example
    let client = ClientBuilder::new().caching(false).build_no_refresh();
Source

pub fn build_no_refresh(self) -> MALClient

Builds a MALClient without attempting to refresh the access token

§Example
use lib_mal::ClientBuilder;
use std::path::PathBuf;
fn example() {
    let client =
    ClientBuilder::new().secret("[YOUR_CLIENT_ID]".to_string()).caching(true).cache_dir(PathBuf::new()).build_no_refresh();
}
Source

pub async fn build_with_refresh(self) -> Result<MALClient, MALError>

Builds a MALClient after attempting to refresh the access token from cache

§Example
use lib_mal::ClientBuilder;
use lib_mal::MALError;
use std::path::PathBuf;
async fn example() -> Result<(), MALError> {
    let client =
    ClientBuilder::new().secret("[YOUR_CLIENT_ID]".to_string()).caching(true).cache_dir(PathBuf::new()).build_with_refresh().await?;

    Ok(())
}

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> 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
Source§

impl<T> ErasedDestructor for T
where T: 'static,