Struct SampleRequestBuilder 

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

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(())
}

Implementations

impl<'a> SampleRequestBuilder<'a>

pub fn count(&mut self, count: u64) -> &mut Self

Sets the count parameter for the request

pub fn include_dead(&mut self, include_dead: bool) -> &mut Self

Sets the include_dead parameter for the request

pub fn iter(&'a mut self) -> impl Iterator<Item = Instance> + 'a

Returns an iterator over the returned Instances

pub fn send(&self) -> Result<SampleResponse, Box<dyn Error>>

Send the request

Trait Implementations

impl<'a> Serialize for SampleRequestBuilder<'a>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.