UserListBuilder

Struct UserListBuilder 

Source
pub struct UserListBuilder { /* private fields */ }

Implementations§

Source§

impl UserListBuilder

Source

pub fn new(username: &str) -> Self

Takes a MyAnimeList username, and initializes a user’s animelist retriever

Source

pub fn status(&mut self, status: Status) -> &mut Self

A filter added to UserListBuilder that will tell the run() to filter by the user’s listed status

Source

pub fn sort(&mut self, sort: Sort) -> &mut Self

A filter added to UserListBuilder that will tell the run() to sort the User’s list

Source

pub fn limit(&mut self, limit: u32) -> &mut Self

A filter added to UserListBuilder that will tell the run() to limit the entries in the User’s list

Source

pub fn offset(&mut self, offset: u32) -> &mut Self

A filter added to UserListBuilder that will tell the run() to offset the starting point of the user’s list. For example, if the limit is 10 for a first run(), and you want the 10 afterwards, you’d add .offset(10)

Source

pub fn include_list_status(&mut self) -> &mut Self

A field added to UserListBuilder that will tell the run() to add the user’s list details

Source

pub async fn run(&self) -> Result<MalAnimeSearch, Box<dyn Error>>

Calls the MyAnimeList API to recieve a user’s animelist created by the builder, based on the username, and fields added from the other methods.
The user does not need to be logged in, aside from using the .add_my_list_status() to the result. The user searched must also not be private
This method returns a Result, containing either the data in a MalAnimeSearch, or an error. Example usage:

use mal_query::myanimelist::builders::UserListBuilder;
use mal_query::myanimelist::models::Status;
async fn user_list_builder_example() {
    let api = UserListBuilder::new("naginis_api")
        .limit(10)
        .status(Status::Watching)
        .run()
        .await;
    match api {
        Err(_e) => assert!(false),
        Ok(data_vec) => assert!(true),
    }
}

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