[−][src]Struct vndb_rs::sync::client::Client

pub struct Client<IO> where
    IO: Read + Write,  { /* fields omitted */ }

Sync client used to call VNDB api

Implementations

impl<IO> Client<IO> where
    IO: Read + Write, [src]

pub fn new(stream: IO) -> Self[src]

pub fn login(&mut self) -> VndbResult<()>[src]

Login without credentials, using set commands will result in error

pub fn login_with_credentials(
    &mut self,
    username: &str,
    password: &str
) -> VndbResult<()>[src]

Login using credentials, allowing using set commands

pub fn get_dbstats(&mut self) -> VndbResult<DbStatsResponse>[src]

Get vndb stats

pub fn get_vn(
    &mut self,
    flags: &[GetFlag],
    filters: String,
    options: Option<Options>
) -> VndbResult<GetVnResults>[src]

Get visual novels

pub fn get_release(
    &mut self,
    flags: &[GetFlag],
    filters: String,
    options: Option<Options>
) -> VndbResult<GetReleaseResults>[src]

Get releases

pub fn get_producer(
    &mut self,
    flags: &[GetFlag],
    filters: String,
    options: Option<Options>
) -> VndbResult<GetProducerResults>[src]

Get producers

pub fn get_character(
    &mut self,
    flags: &[GetFlag],
    filters: String,
    options: Option<Options>
) -> VndbResult<GetCharacterResults>[src]

Get characters

pub fn get_staff(
    &mut self,
    flags: &[GetFlag],
    filters: String,
    options: Option<Options>
) -> VndbResult<GetStaffResults>[src]

Get staff

pub fn get_user(
    &mut self,
    flags: &[GetFlag],
    filters: String,
    options: Option<Options>
) -> VndbResult<GetUserResults>[src]

Get users

pub fn get_ulist_labels(
    &mut self,
    flags: &[GetFlag],
    filters: String,
    options: Option<Options>
) -> VndbResult<GetUListLabelsResults>[src]

Get user list labels

pub fn get_ulist(
    &mut self,
    flags: &[GetFlag],
    filters: String,
    options: Option<Options>
) -> VndbResult<GetUListResults>[src]

Get user lists

pub fn set_ulist(&mut self, id: usize, ulist: UListFields) -> VndbResult<()>[src]

This command facilitates adding, removing and modifying your VN list.

The id argument is the visual novel ID

pub fn delete_ulist(&mut self, id: usize) -> VndbResult<()>[src]

Remove visual novel from user list

When removing a ulist item, any releases associated with the VN will be removed from the users' list as well.

Trait Implementations

impl<IO: Debug> Debug for Client<IO> where
    IO: Read + Write, [src]

Auto Trait Implementations

impl<IO> RefUnwindSafe for Client<IO> where
    IO: RefUnwindSafe, 

impl<IO> Send for Client<IO> where
    IO: Send, 

impl<IO> Sync for Client<IO> where
    IO: Sync, 

impl<IO> Unpin for Client<IO> where
    IO: Unpin, 

impl<IO> UnwindSafe for Client<IO> where
    IO: UnwindSafe, 

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, [src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.