Struct meztide::client::Client

pub struct Client { /* private fields */ }

Starting point for interacting with a lotide API

Implementations

impl Client

pub fn new(instance_url: impl ToString) -> Self

Create a new Client

instance_url should be the full base url to the instance’s API, e.g. https://lotide.example.com/api/unstable

pub fn set_lang(&mut self, lang: impl ToString)

Set the language

pub fn with_lang(self, lang: impl ToString) -> Self

Set the language

pub fn lang(&self) -> Option<&str>

Get the language

pub fn reqwest_client(&self) -> &Client

Get the internal reqwest::Client instance

pub fn reqwest_client_mut(&mut self) -> &mut Client

Get the internal reqwest::Client instance mutably

pub fn instance_url(&self) -> &str

Get the stored instance URL

This is the URL prepended to every request

pub fn set_token(&mut self, token: impl ToString)

Set the bearer token to be used with requests

pub fn has_token(&self) -> bool

Does the Client have a token set?

pub fn get_token(&self) -> Option<Secret<String>>

Get the stored token

pub async fn instance_info(&self) -> Result<InstanceInfo>

Make a request to the instance for information about itself

pub async fn login( &self, username: impl ToString, password: impl ToString ) -> Result<(Client, LoginInfo)>

Log in to the service

pub async fn current_login(&self) -> Result<LoginInfo>

Fetch current login state

pub async fn log_out(&self) -> Result<()>

Log out

pub async fn register<'a>( &self, req: &ReqRegister<'a> ) -> Result<(Option<Client>, LoginInfo)>

Register a new account

pub async fn communities<'a>( &self, req: &ReqCommunities<'a> ) -> Result<List<CommunityInfo>>

List communities on the instance

pub async fn posts<'a>(&self, req: &ReqPosts<'a>) -> Result<List<PostListPost>>

List posts on the instance

pub async fn new_post<'a>(&self, req: &ReqNewPost<'a>) -> Result<PostId>

Create a new post

pub async fn media(&self, mime: &str, data: Vec<u8>) -> Result<String>

Updload an image to the instance

pub async fn request<T: DeserializeOwned>( &self, method: Method, subpath: &str ) -> Result<T, Error>

Make a request to the instance

pub async fn request_with<T: DeserializeOwned>( &self, method: Method, subpath: &str, f: impl FnOnce(RequestBuilder) -> RequestBuilder ) -> Result<T, Error>

Like Ctx::request, but allows you to modify the RequestBuilder before sending

Trait Implementations

impl PartialEq for Client

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.