Struct boticordrs::BoticordClient

source · [−]

pub struct BoticordClient { /* private fields */ }

Expand description

You can use it to make it much easier to use the Boticord API.

Implementations

source

impl BoticordClient

source

pub fn new(token: String, version: u64) -> Result<Self, BoticordError>

Constructs a new Client.

In BotiCord API v2 there are some changes with token. Read more here

Arguments

token - Your BotiCord token
version - Version of BotiCord API.

source

pub fn new_with_client(
    client: ReqwestClient,
    token: String,
    version: u64
) -> Self

Constructs a new Client with ReqwestClient specified by user.

In BotiCord API v2 there are some changes with token. Read more here

Arguments

client - Your custom ReqwestClient
token - Your BotiCord token
version - Version of BotiCord API

source

pub async fn get_bot_info(&self, bot: String) -> Result<Bot, BoticordError>

Get information about a specific bot.

Arguments

bot - Id of bot.

source

pub async fn get_server_info(
&self,
server: String
) -> Result<Server, BoticordError>

Get information about a specific server.

Arguments

server - Id of server.

source

pub async fn get_user_info(
&self,
user: String
) -> Result<UserInformation, BoticordError>

Get information about a specific user.

Arguments

user - Id of user.

source

pub async fn get_bot_comments(
&self,
bot: String
) -> Result<Vec<SingleComment>, BoticordError>

Get Vec of bot’s comments.

Arguments

bot - Id of bot.

source

pub async fn get_server_comments(
&self,
server: String
) -> Result<Vec<SingleComment>, BoticordError>

Get Vec of server’s comments.

Arguments

server - Id of server.

source

pub async fn get_user_comments(
&self,
user: String
) -> Result<UserComments, BoticordError>

Get Vec of user’s comments.

Arguments

user - Id of user.

source

pub async fn get_user_bots(
&self,
user: String
) -> Result<Vec<SingleUserBot>, BoticordError>

Get Vec of user’s bots.

Arguments

user - Id of user.

source

pub async fn get_my_shorted_links(
&self
) -> Result<Vec<ShortedLink>, BoticordError>

Get Vec of shorted by current user links

source

pub async fn search_for_shorted_link(
&self,
shortener_body: ShortenerBody
) -> Result<Vec<ShortedLink>, BoticordError>

Get Vec of shorted by current user links with the provided code

Arguments

shortener_body - Short information about a link, that we will search.

source

pub async fn create_shorted_link(
&self,
shortener_body: ShortenerBody
) -> Result<ShortedLink, BoticordError>

Creates new shorted link

Arguments

shortener_body - Information about link we will create.

source

pub async fn delete_shorted_link(
&self,
shortener_body: ShortenerBody
) -> Result<(), BoticordError>

Deletes shorted link

Arguments

shortener_body - Information about link we will delete.

source

pub async fn post_bot_stats(&self, stats: BotStats) -> Result<(), BoticordError>

Post current bot’s stats.

How to set BotStats? (example)

Arguments

stats - Stats that we will post

Examples

use boticordrs::types::{BotStats};

let stats = BotStats{servers: 2514, shards: 3, users: 338250};

source

pub async fn post_server_stats(
&self,
stats: ServerStats
) -> Result<(), BoticordError>

Post Server Stats Method.

Remember, that only Boticord-Service Bots can do it in global, other will get an 403 error. (but it may works for custom bots, but you need a special API-token)

Arguments

stats - Stats that we will post

Trait Implementations

source

impl Clone for BoticordClient

source

fn clone(&self) -> BoticordClient

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

Auto Trait Implementations

impl !RefUnwindSafe for BoticordClient

impl Send for BoticordClient

impl Sync for BoticordClient

impl Unpin for BoticordClient

impl !UnwindSafe for BoticordClient

Blanket Implementations

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct boticordrs::BoticordClient

Implementations

impl BoticordClient

pub fn new(token: String, version: u64) -> Result<Self, BoticordError>

pub fn new_with_client( client: ReqwestClient, token: String, version: u64) -> Self

pub async fn get_bot_info(&self, bot: String) -> Result<Bot, BoticordError>

pub async fn get_server_info( &self, server: String) -> Result<Server, BoticordError>

pub async fn get_user_info( &self, user: String) -> Result<UserInformation, BoticordError>

pub async fn get_bot_comments( &self, bot: String) -> Result<Vec<SingleComment>, BoticordError>

pub async fn get_server_comments( &self, server: String) -> Result<Vec<SingleComment>, BoticordError>

pub async fn get_user_comments( &self, user: String) -> Result<UserComments, BoticordError>

pub async fn get_user_bots( &self, user: String) -> Result<Vec<SingleUserBot>, BoticordError>

pub async fn get_my_shorted_links( &self) -> Result<Vec<ShortedLink>, BoticordError>

pub async fn search_for_shorted_link( &self, shortener_body: ShortenerBody) -> Result<Vec<ShortedLink>, BoticordError>

pub async fn create_shorted_link( &self, shortener_body: ShortenerBody) -> Result<ShortedLink, BoticordError>

pub async fn delete_shorted_link( &self, shortener_body: ShortenerBody) -> Result<(), BoticordError>

pub async fn post_bot_stats(&self, stats: BotStats) -> Result<(), BoticordError>

pub async fn post_server_stats( &self, stats: ServerStats) -> Result<(), BoticordError>

Trait Implementations

impl Clone for BoticordClient

fn clone(&self) -> BoticordClient

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

Auto Trait Implementations

impl !RefUnwindSafe for BoticordClient

impl Send for BoticordClient

impl Sync for BoticordClient

impl Unpin for BoticordClient

impl !UnwindSafe for BoticordClient

Blanket Implementations

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

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

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

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

pub fn new_with_client(
client: ReqwestClient,
token: String,
version: u64
) -> Self

pub async fn get_server_info(
&self,
server: String
) -> Result<Server, BoticordError>

pub async fn get_user_info(
&self,
user: String
) -> Result<UserInformation, BoticordError>

pub async fn get_bot_comments(
&self,
bot: String
) -> Result<Vec<SingleComment>, BoticordError>

pub async fn get_server_comments(
&self,
server: String
) -> Result<Vec<SingleComment>, BoticordError>

pub async fn get_user_comments(
&self,
user: String
) -> Result<UserComments, BoticordError>

pub async fn get_user_bots(
&self,
user: String
) -> Result<Vec<SingleUserBot>, BoticordError>

pub async fn get_my_shorted_links(
&self
) -> Result<Vec<ShortedLink>, BoticordError>

pub async fn search_for_shorted_link(
&self,
shortener_body: ShortenerBody
) -> Result<Vec<ShortedLink>, BoticordError>

pub async fn create_shorted_link(
&self,
shortener_body: ShortenerBody
) -> Result<ShortedLink, BoticordError>

pub async fn delete_shorted_link(
&self,
shortener_body: ShortenerBody
) -> Result<(), BoticordError>

pub async fn post_server_stats(
&self,
stats: ServerStats
) -> Result<(), BoticordError>

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

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,