Enum ibdl_common::ImageBoards

pub enum ImageBoards {
    Danbooru,
    E621,
    Rule34,
    Realbooru,
    Konachan,
    Gelbooru,
}

All currently supported imageboards and their underlying attributes

Variants

Danbooru

Represents the website https://danbooru.donmai.us or it’s safe variant https://safebooru.donmai.us.

E621

Represents the website https://e621.net or it’s safe variant https://e926.net.

Rule34

Represents the website https://rule34.xxx

Realbooru

Represents the website http://realbooru.com

Konachan

Represents the website https://konachan.com or it’s safe variant https://konachan.net.

Gelbooru

Represents the website https://gelbooru.com.

Implementations

impl ImageBoards

pub fn user_agent(self) -> String

Each variant can generate a specific user-agent to connect to the imageboard site.

It will always follow the version declared inside Cargo.toml

pub fn extractor_user_agent(self) -> String

pub fn post_url(&self) -> &'static str

Returns the endpoint for the post list with their respective tags.

pub fn max_post_limit(self) -> usize

Returns max number of posts per page a imageboard can have

pub fn auth_url(self) -> &'static str

Returns the url used for validating the login input and parsing the user’s profile.

pub fn auth_cache_dir() -> Result<PathBuf, Error>

Returns a PathBuf pointing to the imageboard’s authentication cache.

This is XDG-compliant and saves cache files to $XDG_CONFIG_HOME/imageboard-downloader/<imageboard> on Linux or %APPDATA%/FerrahWolfeh/imageboard-downloader/<imageboard> on Windows

pub async fn read_config_from_fs(
    &self
) -> Result<Option<ImageboardConfig>, AuthError>

Reads and parses the authentication cache from the path provided by auth_cache_dir.

Returns None if the file is corrupted or does not exist.

Trait Implementations

impl Clone for ImageBoards

fn clone(&self) -> ImageBoards

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ImageBoards

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ImageBoards

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Ord for ImageBoards

fn cmp(&self, other: &ImageBoards) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<ImageBoards> for ImageBoards

fn eq(&self, other: &ImageBoards) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<ImageBoards> for ImageBoards

fn partial_cmp(&self, other: &ImageBoards) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for ImageBoards

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToString for ImageBoards

fn to_string(&self) -> String

Converts the given value to a String.

impl Copy for ImageBoards

impl Eq for ImageBoards

impl StructuralEq for ImageBoards

impl StructuralPartialEq for ImageBoards