Struct pixiv::Pixiv [−][src]
pub struct Pixiv { /* fields omitted */ }
Used to authenticate to the Pixiv servers and construct Pixiv requests through methods creating PixivRequestBuilder
.
Methods
impl Pixiv
[src]
impl Pixiv
pub fn new(client: &Client) -> Pixiv
[src]
pub fn new(client: &Client) -> Pixiv
Creates a new Pixiv struct.
pub fn login(&mut self, username: &str, password: &str) -> Result<(), AuthError>
[src]
pub fn login(&mut self, username: &str, password: &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>
[src]
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
[src]
pub fn access_token(&self) -> &String
Get the access token.
pub fn access_token_mut(&mut self) -> &mut String
[src]
pub fn access_token_mut(&mut self) -> &mut String
Get a mutable reference to the access token.
pub fn refresh_token(&self) -> &String
[src]
pub fn refresh_token(&self) -> &String
Get the refresh token.
pub fn refresh_token_mut(&mut self) -> &mut String
[src]
pub fn refresh_token_mut(&mut self) -> &mut String
Get a mutable reference to the refresh token.
pub fn bad_words(&self) -> PixivRequestBuilder
[src]
pub fn bad_words(&self) -> PixivRequestBuilder
pub fn work(&self, illust_id: usize) -> PixivRequestBuilder
[src]
pub fn work(&self, illust_id: usize) -> PixivRequestBuilder
Used to build a request to retrieve information of a work.
Request Transforms
image_sizes
(default:px_128x128,small,medium,large,px_480mw
)include_stats
(default:true
)
pub fn user(&self, user_id: usize) -> PixivRequestBuilder
[src]
pub fn user(&self, user_id: usize) -> PixivRequestBuilder
Used to build a request to retrieve information of a user.
Request Transforms
profile_image_sizes
(default:px_170x170,px_50x50
)image_sizes
(default:px_128x128,small,medium,large,px_480mw
)include_stats
(default:true
)
pub fn feed(&self) -> PixivRequestBuilder
[src]
pub fn feed(&self) -> PixivRequestBuilder
Used to build a request to retrieve your account's feed.
Request Transforms
show_r18
(default:true
)max_id
pub fn favorite_works(&self) -> PixivRequestBuilder
[src]
pub fn favorite_works(&self) -> PixivRequestBuilder
Used to build a request to retrieve works favorited on your account.
Request Transforms
page
(default:1
)per_page
(default:50
)publicity
(default:public
)image_sizes
(default:px_128x128,small,medium,large,px_480mw
)
pub fn favorite_work_add(&self, work_id: usize) -> PixivRequestBuilder
[src]
pub fn favorite_work_add(&self, work_id: usize) -> PixivRequestBuilder
Used to build a request to favorite a work on your account.
Request Transforms
publicity
(default:public
)
pub fn favorite_works_remove<B, I>(&self, work_ids: I) -> PixivRequestBuilder where
B: Borrow<usize>,
I: IntoIterator<Item = B>,
[src]
pub fn favorite_works_remove<B, I>(&self, work_ids: I) -> PixivRequestBuilder where
B: Borrow<usize>,
I: IntoIterator<Item = B>,
Used to build a request to remove favorited works on your account.
Request Transforms
publicity
(default:public
)
pub fn following_works(&self) -> PixivRequestBuilder
[src]
pub fn following_works(&self) -> PixivRequestBuilder
Used to build a request to retrieve newest works from whoever you follow on your account.
Request Transforms
page
(default:1
)per_page
(default:30
)image_sizes
(default:px_128x128,small,medium,large,px_480mw
)include_stats
(default:true
)include_sanity_level
(default:true
)
pub fn following(&self) -> PixivRequestBuilder
[src]
pub fn following(&self) -> PixivRequestBuilder
Used to build a request to retrieve users you follow.
Request Transforms
page
(default:1
)per_page
(default:30
)image_sizes
(default:px_128x128,small,medium,large,px_480mw
)include_stats
(default:true
)include_sanity_level
(default:true
)
pub fn following_add(&self, user_id: usize) -> PixivRequestBuilder
[src]
pub fn following_add(&self, user_id: usize) -> PixivRequestBuilder
Used to build a request to follow a user on your account.
Request Transforms
publicity
(default:public
)
pub fn following_remove<B, I>(&self, user_ids: I) -> PixivRequestBuilder where
B: Borrow<usize>,
I: IntoIterator<Item = B>,
[src]
pub fn following_remove<B, I>(&self, user_ids: I) -> PixivRequestBuilder where
B: Borrow<usize>,
I: IntoIterator<Item = B>,
Used to build a request to unfollow users on your account.
Request Transforms
publicity
(default:public
)
pub fn user_works(&self, user_id: usize) -> PixivRequestBuilder
[src]
pub fn user_works(&self, user_id: usize) -> PixivRequestBuilder
Used to build a request to retrive a list of works submitted by a user.
Request Transforms
page
(default:1
)per_page
(default:30
)image_sizes
(default:px_128x128,small,medium,large,px_480mw
)include_stats
(default:true
)include_sanity_level
(default:true
)
pub fn user_favorite_works(&self, user_id: usize) -> PixivRequestBuilder
[src]
pub fn user_favorite_works(&self, user_id: usize) -> PixivRequestBuilder
Used to build a request to retrive a list of works favorited by a user.
Request Transforms
page
(default:1
)per_page
(default:30
)image_sizes
(default:px_128x128,small,medium,large,px_480mw
)include_sanity_level
(default:true
)
pub fn user_feed(&self, user_id: usize) -> PixivRequestBuilder
[src]
pub fn user_feed(&self, user_id: usize) -> PixivRequestBuilder
pub fn user_following(&self, user_id: usize) -> PixivRequestBuilder
[src]
pub fn user_following(&self, user_id: usize) -> PixivRequestBuilder
Used to build a request to retrieve users a user follows.
Request Transforms
page
(default:1
)per_page
(default:30
)max_id
pub fn ranking(&self, ranking_type: RankingType) -> PixivRequestBuilder
[src]
pub fn ranking(&self, ranking_type: RankingType) -> PixivRequestBuilder
Used to build a request to retrieve a list of ranking posts.
Request Transforms
ranking_mode
(default:RankingMode::Daily
)page
(default:1
)per_page
(default:50
)include_stats
(default:true
)include_sanity_level
(default:true
)image_sizes
(default:px_128x128,small,medium,large,px_480mw
)profile_image_sizes
(default:px_170x170,px_50x50
)
pub fn search_works<'a, V>(&'a self, query: V) -> PixivRequestBuilder<'a> where
Cow<'a, str>: From<V>,
[src]
pub fn search_works<'a, V>(&'a self, query: V) -> PixivRequestBuilder<'a> where
Cow<'a, str>: From<V>,
Used to build a request to search for posts on a query.
Request Transforms
page
(default:1
)per_page
(default:30
)date
search_mode
(default:SearchMode::Text
)search_period
(default:SearchPeriod::All
)search_order
(default:desc
)search_sort
(default:date
)search_types
(default:illustration,manga,ugoira
)include_stats
(default:true
)include_sanity_level
(default:true
)image_sizes
(default:px_128x128,small,medium,large,px_480mw
)
pub fn latest_works(&self) -> PixivRequestBuilder
[src]
pub fn latest_works(&self) -> PixivRequestBuilder
Used to build a request to retrieve the latest submitted works by everyone.
Request Transforms
page
(default:1
)per_page
(default:50
)date
include_stats
(default:true
)include_sanity_level
(default:true
)image_sizes
(default:px_128x128,small,medium,large,px_480mw
)profile_image_sizes
(default:px_170x170,px_50x50
)
pub fn execute(&self, request: PixivRequest) -> Result<Response, Error>
[src]
pub fn execute(&self, request: PixivRequest) -> Result<Response, Error>
Executes a given PixivRequest
.
Trait Implementations
impl Debug for Pixiv
[src]
impl Debug for Pixiv
fn fmt(&self, f: &mut Formatter) -> Result
[src]
fn fmt(&self, f: &mut Formatter) -> Result
Formats the value using the given formatter. Read more
impl Clone for Pixiv
[src]
impl Clone for Pixiv