Skip to main content

VkBot

Struct VkBot 

Source
pub struct VkBot { /* private fields */ }
Expand description

Main bot structure

Implementations§

Source§

impl VkBot

Source

pub fn new<T: Into<String>>(token: T, group_id: i64) -> VkResult<Self>

Create new bot with default config

Source

pub fn builder() -> VkBotBuilder

Create new bot with builder

Source

pub fn add_handler<H>(&mut self, handler: H)
where H: MessageHandler + 'static,

Add message handler

Source

pub async fn init(&mut self) -> VkResult<()>

Initialize bot (get Long Poll server)

Source

pub async fn run(&mut self) -> VkResult<()>

Main bot loop

Source

pub fn api(&self) -> &VkApi

Get API client reference

Source

pub fn group_id(&self) -> i64

Get group ID

Source

pub fn config(&self) -> &VkBotConfig

Get bot config

Source

pub async fn broadcast( &self, message: &str, user_ids: &[i64], delay_ms: u64, ) -> VkResult<Vec<(i64, VkResult<i64>)>>

Send broadcast message to multiple users

Source

pub async fn get_history( &self, peer_id: i64, limit: i32, ) -> VkResult<Vec<Value>>

Get conversation history

Source

pub async fn get_user_info( &self, user_id: i64, fields: Option<&str>, ) -> VkResult<Value>

Get user information

Source

pub async fn set_typing( &self, peer_id: i64, user_id: Option<i64>, ) -> VkResult<()>

Set typing indicator

Source

pub async fn mark_as_read( &self, peer_id: i64, start_message_id: Option<i64>, ) -> VkResult<()>

Mark messages as read

Trait Implementations§

Source§

impl Debug for VkBot

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for VkBot

§

impl !RefUnwindSafe for VkBot

§

impl Send for VkBot

§

impl Sync for VkBot

§

impl Unpin for VkBot

§

impl !UnwindSafe for VkBot

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,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

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<U> for T
where U: From<T>,

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::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