[−][src]Struct instances_social::Instances

pub struct Instances<'a>(_);

Container for the /instances/* API calls

Sample instances

use instances_social::Client;

const TOKEN: &'static str = "...";

fn main() -> Result<(), Box<std::error::Error>> {
    let client = Client::new(TOKEN);

    let result = client.instances()
        .sample() // returns this builder
        .count(100) // sets the ?count=100 querystring param
        // ...etc
        .send()?; // actually sends the request
    Ok(())
}

Show instance

use instances_social::Client;

const TOKEN: &'static str = "...";

fn main() -> Result<(), Box<std::error::Error>> {
    let client = Client::new(TOKEN);

    let result = client.instances()
        .show("mastodon.social") // returns this builder
        .send()?; // actually sends the request
    Ok(())
}

List instances

use instances_social::Client;

const TOKEN: &'static str = "...";

fn main() -> Result<(), Box<std::error::Error>> {
    let client = Client::new(TOKEN);

    let result = client.instances()
        .list() // returns this builder
        .count(100) // sets the ?count=100 querystring param
        // ...etc
        .send()?; // actually sends the request
    Ok(())
}

Search instances

use instances_social::Client;

const TOKEN: &'static str = "...";

fn main() -> Result<(), Box<std::error::Error>> {
    let client = Client::new(TOKEN);

    let result = client.instances()
        .search("some-query") // returns this builder
        .count(100) // sets the ?count=100 querystring param
        // ...etc
        .send()?; // actually sends the request
    Ok(())
}

Methods

impl<'a> Instances<'a>[src]

pub fn sample(&self) -> SampleRequestBuilder[src]

Represents a request to the https://instances.social/api/1.0/instances/sample endpoint

use instances_social::Client;

const TOKEN: &'static str = "...";

fn main() -> Result<(), Box<std::error::Error>> {
    let client = Client::new(TOKEN);

    let result = client.instances()
        .sample() // returns this builder
        .count(100) // sets the ?count=100 querystring param
        // ...etc
        .send()?; // actually sends the request
    Ok(())
}

pub fn list(&self) -> ListRequestBuilder[src]

Request builder for the instances/list call

use instances_social::Client;

const TOKEN: &'static str = "...";

fn main() -> Result<(), Box<std::error::Error>> {
    let client = Client::new(TOKEN);

    let result = client.instances()
        .list() // returns this builder
        .count(100) // sets the ?count=100 querystring param
        // ...etc
        .send()?; // actually sends the request
    Ok(())
}

pub fn search(&self, q: &str) -> SearchRequestBuilder[src]

Represents a request to the https://instances.social/api/1.0/instances/search endpoint

use instances_social::Client;

const TOKEN: &'static str = "...";

fn main() -> Result<(), Box<std::error::Error>> {
    let client = Client::new(TOKEN);

    let result = client.instances()
        .search("some-query") // returns this builder
        .count(100) // sets the ?count=100 querystring param
        // ...etc
        .send()?; // actually sends the request
    Ok(())
}

pub fn show(&self, name: &str) -> ShowRequestBuilder[src]

Represents a request to the https://instances.social/api/1.0/instances/show endpoint

use instances_social::Client;

const TOKEN: &'static str = "...";

fn main() -> Result<(), Box<std::error::Error>> {
    let client = Client::new(TOKEN);

    let result = client.instances()
        .show("mastodon.social") // returns this builder
        .send()?; // actually sends the request
    Ok(())
}

Auto Trait Implementations

impl<'a> Send for Instances<'a>

impl<'a> Sync for Instances<'a>

Blanket Implementations

impl<T> From for T[src]

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

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

type Error = !

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

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

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

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

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

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

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

impl<T> Erased for T