Struct pixieve_rs::pixiv::client::PixivClient

pub struct PixivClient {
    pub client: Client,
    pub access_token: String,
    pub refresh_token: String,
}

Used to authenticate to the PixivClient servers and construct PixivClient requests through methods creating PixivRequestBuilder.

Fields

client: Client

access_token: String

refresh_token: String

Implementations

impl PixivClient

pub fn new() -> Result<PixivClient, Error>

Creates a new PixivClient struct.

pub fn login<'a, 'b, 'c>(
    &'a mut self,
    username: &'b str,
    password: &'c str
) -> Result<(), AuthError>

This is required to use all the other functions this library provides. Requires a valid username and password.

pub fn refresh_auth(&mut self) -> Result<(), AuthError>

Refreshes the authentication. You should use this when your access token is close to expiring.

pub fn access_token(&self) -> &String

Get the access token.

pub fn access_token_mut(&mut self) -> &mut String

Get a mutable reference to the access token.

pub fn refresh_token(&self) -> &String

Get the refresh token.

pub fn refresh_token_mut(&mut self) -> &mut String

Get a mutable reference to the refresh token.

pub fn execute_with_auth(
    &self,
    request: PixivRequest
) -> Result<Response, Error>

Executes a given PixivRequest. TODO: Add another function that can execute without authentication (is there even anything like this?)

pub fn download_illustration<'a, 'b, 'c>(
    &'a self,
    illustration: &'c Illustration,
    path: &'b Path
)

Download a given illustration to path

Trait Implementations

impl Clone for PixivClient

fn clone(&self) -> PixivClient

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PixivClient

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

Formats the value using the given formatter.