Struct stack_overflow_client::client::StackClient

pub struct StackClient { /* private fields */ }

Implementations

impl StackClient

StackClient is a client for the Stack Exchange API

Construct a default client for StackOverflow site, API version 2.3 (https://meta.stackexchange.com/questions/366977/api-2-3-release)

use stack_overflow::client::StackClient;
let client = StackClient::new();

Construct a e client for a specific site and API version

use stack_overflow::client::StackClientBuilder;
use stack_overflow::common::{ApiVersion, StackSite};
let client = StackClientBuilder::new()
                .stack_site(StackSite::StackOverflow)
                .version(ApiVersion::V2_3)
                .build();

pub fn new() -> Self

StackClient defaults to StackOverflow as the site and api version 2.3

pub async fn get_info(&self) -> Result<Response<Info>, Box<dyn Error>>

Get info about the client’s Stack site. Returns a collection of statistics about the site. API Docs: https://api.stackexchange.com/docs/info

pub async fn get_featured_questions( &self, tag: &str ) -> Result<Response<Question>, Box<dyn Error>>

Get featured questions for a tag. Note that this only retrieves the first page of results. API Docs: https://api.stackexchange.com/docs/featured-questions

pub async fn get_featured_questions_paginated( &self, tag: &str, page: u32 ) -> Result<Response<Question>, Box<dyn Error>>

Get featured questions for a tag and explicitly provide a page. Note that pagination is not supported beyond 25 pages because authentication is required. API Docs: https://api.stackexchange.com/docs/featured-questions

pub async fn get_answers_for_user( &self, user_id: u32, page: Option<u32> ) -> Result<Response<Answer>, Box<dyn Error>>

Get answers provided by a user API Docs: https://api.stackexchange.com/docs/answers-on-users

Trait Implementations

impl Debug for StackClient

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

Formats the value using the given formatter.