Struct PostsRequestBuilder 

pub struct PostsRequestBuilder<'a> { /* private fields */ }

Request builder for the Posts endpoint.

See the posts function for proper usage.

Implementations

impl<'a> PostsRequestBuilder<'a>

pub fn limit(self, limit: usize) -> Self

Amount of posts to recieve.

When unspecified, default limit is 100, as set by the server.

pub fn tag<S: Into<Cow<'a, str>>>(self, tag: S) -> Self

Add a single tag to the list of tags to search for. To clear already set tags, see clear_tags.

Example

posts()
    .tag("hello")
    .tag("world".to_string())
    .send(&client)
    .await?;

pub fn tags<S: AsRef<str>>(self, tags: &'a [S]) -> Self

Tags to search for. Any tag combination that works on the website will work here, including meta-tags.

Can be chained; previously added tags are not overridden. To clear already set tags, see clear_tags.

Example

posts()
    .tags(&["hello", "world"])
    .tags(&vec!["how", "are", "you?"])
    .send(&client)
    .await?;

pub fn tags_raw<S: ToString>(self, raw_tags: S) -> Self

Append string directly to tag search

!! These are not checked when being submitted !! You can easily mess up the query construction using these.

Probably only useful for setting meta-tags.

pub fn clear_tags(self) -> Self

Clears the list of tags to search for. Tags set using tags_raw are also cleared.

Example

posts()
    .tags(&["herro", "world"])
    .clear_tags() // wait, nevermind! clear tags.
    .tags(&["hello", "world"])
    .send(&client)
    .await?;

pub fn rating(self, rating: Rating) -> Self

Filter by content ratings. See Rating.

Example

posts()
    .tags(&["hatsune_miku"])
    .rating(Rating::Safe)
    .send(&client)
    .await?;

pub fn random(self, random: bool) -> Self

Randomize the order of posts.

This is a server-side meta-tag feature, and is only provided for completeness’ sake.

Example

posts()
    .tags(&["hatsune_miku"])
    .random(true)
    .send(&client)
    .await?;

pub async fn send(self, client: &Client) -> Result<PostQuery, Error>

Trait Implementations

impl<'a> Clone for PostsRequestBuilder<'a>

fn clone(&self) -> PostsRequestBuilder<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for PostsRequestBuilder<'a>

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

Formats the value using the given formatter.