Struct furbooru::Client

pub struct Client { /* fields omitted */ }

Implementations

impl Client

pub async fn comment(&self, id: u64) -> Result<Comment>

Fetch an individual comment by ID.

pub async fn comment_search<T: Into<String>>(
    &self,
    query: T,
    page: u64
) -> Result<Vec<Comment>>

Search for comments.

impl Client

pub async fn filter(&self, id: u64) -> Result<Filter>

Fetch a filter by its ID.

pub async fn system_filters(&self) -> Result<Vec<Filter>>

Fetch the list of system filters.

pub async fn user_filters(&self, page: u64) -> Result<Vec<Filter>>

Fetch the list of user-level filters.

impl Client

pub async fn firehose(
    &self,
    callback: impl FirehoseAdaptor + Sync
) -> Result<()>

On every new site event, call methods on the callback. Explode if the callback explodes.

Here is an example Adaptor implementation:

use async_trait::async_trait;
use furbooru::*;
struct Adaptor;

#[async_trait]
impl furbooru::FirehoseAdaptor for Adaptor {
  async fn image_created(&self, img: Image) -> Result<()> {
    println!("new image: {} {} {}", img.id, img.name, img.view_url);
    Ok(())
  }

  async fn comment_created(&self, cmt: Comment) -> Result<()> {
    println!("new comment on image {}: {}", cmt.image_id, cmt.body);
    Ok(())
  }
}

impl Client

pub async fn forums(&self) -> Result<Vec<Forum>>

Get the list of forums.

pub async fn forum<T: Into<String>>(&self, id: T) -> Result<Forum>

Get details about an individual forum by ID.

impl Client

pub async fn featured_image(&self) -> Result<Image>

Get information about the currently featured image.

pub async fn image(&self, id: u64) -> Result<Image>

Get information about an image by ID.

pub async fn image_search<T: Into<String>>(
    &self,
    q: T,
    page: u64
) -> Result<Vec<Image>>

Search for images that match a set of tags.

pub async fn post_image(
    &self,
    image_url: String,
    im: ImageMeta
) -> Result<Image>

Upload an image to the booru.

Test this call with a custom instance of philomena. Abuse of this call will likely result in a ban from the booru you are posting things to.

impl Client

pub async fn post(&self, id: u64) -> Result<Post>

Fetches a forum post by ID.

pub async fn forum_thread<T: Into<String>>(
    &self,
    forum: T,
    thread: T,
    page: u64
) -> Result<Vec<Post>>

Fetches page n of posts in a thread in a forum.

impl Client

pub async fn profile(&self, id: u64) -> Result<User>

Get information about a user’s profile by ID.

impl Client

pub async fn tag<T: Into<String>>(&self, name: T) -> Result<Tag>

pub async fn tag_search<T: Into<String>>(
    &self,
    q: T,
    page: u64
) -> Result<Vec<Tag>>

impl Client

pub async fn topic<T: Into<String>>(&self, forum: T, thread: T) -> Result<Topic>

impl Client

pub fn new<T: Into<String>>(user_agent: T, token: T) -> Result<Self>

Create a new client targeting Furbooru.

pub fn derpi<T: Into<String>>(user_agent: T, token: T) -> Result<Self>

Create a new client targeting Derpibooru.

pub fn with_baseurl<T: Into<String>>(
    user_agent: T,
    token: T,
    api_base: T
) -> Result<Self>

Create a new client targeting any server you want.