Struct Bot 

pub struct Bot { /* private fields */ }

Bot class with attributes

• connection_pool: ConnectionPool - Pool of HTTP connections for API requests
• token: String - Bot API token
• base_api_url: reqwest::Url - Base API URL
• base_api_path: String - Base API path
• event_id: std::sync::Arc<_> - Last event ID

Implementations

impl Bot

Listen for events and execute callback function

Parameters

• func - callback function with Result type ResponseEventsGet as argument

pub async fn event_listener<F, X>(&self, func: F) -> Result<()>

where F: Fn(Bot, ResponseEventsGet) -> X, X: Future<Output = Result<()>> + Send + Sync + 'static,

Listen for events and execute callback function

Parameters

• func - callback function with Result type and ResponseEventsGet argument

Errors

• BotError::Api - API error when getting events
• BotError::Network - network error when getting events
• BotError::Serialization - response deserialization error
• BotError::System - error when executing callback function

pub async fn event_listener_parallel<F, X>(&self, func: F) -> Result<()>

where F: Fn(Bot, ResponseEventsGet) -> X + Send + Sync + Clone + 'static, X: Future<Output = Result<()>> + Send + 'static,

Listen for events with parallel processing Enhanced version that processes events in parallel batches

impl Bot

pub fn new(version: APIVersionUrl) -> Self

Creates a new Bot with API version APIVersionUrl

Uses ConnectionPool with optimized settings for HTTP requests.

Get token from variable VKTEAMS_BOT_API_TOKEN in .env file

Get base url from variable VKTEAMS_BOT_API_URL in .env file

Set default path depending on API version

Errors

• BotError::Config - configuration error (invalid token or URL)
• BotError::Url - URL parsing error
• BotError::Network - network client creation error

Panics

• Unable to find token in .env file
• Unable to find or parse url in .env file
• Unable to create connection pool

pub fn with_params( version: &APIVersionUrl, token: &str, api_url: &str, ) -> Result<Self>

Creates a new Bot with direct parameters instead of environment variablesx

This method allows you to create a bot by directly providing the token and API URL, instead of reading them from environment variables. This is particularly useful when:

• You want to manage credentials programmatically
• You’re integrating with a system that doesn’t use environment variables
• You’re testing with different credentials

Uses ConnectionPool with optimized settings for HTTP requests.

Parameters

• version: APIVersionUrl - API version
• token: String - Bot API token
• api_url: String - Base API URL

Errors

• BotError::Url - URL parsing error
• BotError::Network - network client creation error

Example

use vkteams_bot::prelude::*;

#[tokio::main]
async fn main() -> Result<()> {
    let bot = Bot::with_params(
        &APIVersionUrl::V1,
        "your_bot_token",
        "https://api.example.com"
    )?;

    // Now use the bot...

    Ok(())
}

For most cases, consider using with_default_version which uses V1 API version and has a simpler signature.

pub fn get_last_event_id(&self) -> EventId

Get last event id (lock-free)

pub fn set_last_event_id(&self, id: EventId)

Set last event id (lock-free)

Parameters

• id: EventId - last event id

pub fn set_path(&self, path: &str) -> String

Append method path to base_api_path

• path: String - append path to base_api_path

pub fn get_parsed_url(&self, path: String, query: String) -> Result<Url>

Build full URL with optional query parameters

• path: String - append path to base_api_path
• query: String - append token query parameter to URL

Errors

• BotError::Url - URL parsing error

Parse with Url::parse

pub async fn send_api_request<Rq>( &self, message: Rq, ) -> Result<Rq::ResponseType>

where Rq: BotRequest + Serialize + Debug,

Send request, get response Serialize request generic type Rq with serde_url_params::to_string into query string Get response body using connection pool Deserialize response with serde_json::from_str

• message: generic type Rq - request type

Errors

• BotError::UrlParams - URL parameters serialization error
• BotError::Url - URL parsing error
• BotError::Network - network error when sending request
• BotError::Serialization - response deserialization error
• BotError::Io - file operation error
• BotError::Api - API error when processing request

Panics

• Unable to deserialize response

impl Bot

pub fn with_default_version(token: &str, api_url: &str) -> Result<Self>

Creates a new bot with default API version (V1) and direct parameters

This is the recommended method for creating a bot with direct parameters. It uses the default connection pool with optimized settings.

Parameters

• token: String - Bot API token
• api_url: String - Base API URL

Errors

• BotError::Url - URL parsing error
• BotError::Network - network client creation error

Example

use vkteams_bot::{Bot, error::Result};

#[tokio::main]
async fn main() -> Result<()> {
    let bot = Bot::with_default_version(
        "your_bot_token",
        "https://api.example.com"
    )?;

    // Now use the bot...

    Ok(())
}

Trait Implementations

impl Clone for Bot

fn clone(&self) -> Bot

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Bot

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

Formats the value using the given formatter.

impl Default for Bot

fn default() -> Self

Returns the “default value” for a type.