Expand description
§maxbot
Библиотека для работы с API мессенджера MAX на языке Rust.
Предоставляет клиент для отправки сообщений, получения обновлений, работы с вложениями и inline‑клавиатурами, а также управления глобальными настройками (базовый URL, ограничение частоты запросов).
§Пример использования
use maxbot::{Attachment, MaxClient, SendMessageParamsBuilder};
let client = MaxClient::new("your_api_token");
// Отправка изображения из локального файла
let builder = SendMessageParamsBuilder::new()
.text("Вот изображение")
.chat_id(123456789)
.attachment(Attachment::image_local("cat.jpg"));
let message_ids = client.send_message_builder(builder).await?;
println!("Сообщение отправлено, ID: {:?}", message_ids);Re-exports§
pub use vcard::VCard;pub use vcard::VCardProperty;pub use vcard::VCardParamMap;pub use vcard::parse_vcard;pub use vcard::VCardError;
Modules§
- vcard
- Разбор и генерация vCard (формат VCF).
Structs§
- BotCommand
- Команда бота.
- BotInfo
- Информация о боте.
- Callback
Query - Запрос функции обратного вызова при нажатии на строковую кнопку.
- Chat
- Групповой чат.
- Chat
Admin Request - Параметры для добавления администратора в чат.
- Chat
Member - Участник чата (пользователь или бот).
- Contact
- Контакт (устаревшее поле, оставлено для совместимости).
- Contact
Data - Данные контакта для вложения
contact. - Contact
Payload - Полезная нагрузка для контакта.
- Context
- Контекст, передаваемый каждому обработчику.
- Dispatcher
- Диспетчер направляет входящие обновления зарегистрированным обработчикам.
- Edit
Message Params - Параметры для редактирования сообщения.
- File
Payload - Полезная нагрузка для файлов.
- GetMessages
Params - Параметры для получения списка сообщений чата.
- GetUpdates
Params - Image
- Изображение (аватар, иконка).
- Inline
Keyboard - Inline‑клавиатура (двумерный массив кнопок).
- Inline
Keyboard Builder - Построитель inline‑клавиатуры.
- Inline
Keyboard Button - Кнопка inline‑клавиатуры.
- Keyboard
Payload - Полезная нагрузка для inline-клавиатуры.
- Location
- Геолокация.
- Location
Payload - Полезная нагрузка для геолокации.
- MaxClient
- Клиент для взаимодействия с API MAX.
- Media
Payload - Полезная нагрузка для медиа-вложений (изображение, видео, аудио).
- Message
- Сообщение.
- Message
Body - Тело сообщения.
- NewMessage
Body - Тело нового сообщения для отправки или замены.
- Recipient
- Получатель сообщения.
- Scheduled
Task Context - Контекст, передаваемый периодическим задачам.
- Send
Message Params - Параметры для отправки сообщения.
- Send
Message Params Builder - Построитель параметров для отправки сообщения.
- Share
Data - Данные для вложения
share(отсылка/предпросмотр ссылки). - Start
Context - Контекст, передаваемый обработчикам, запускаемым при старте бота (до начала polling).
- Sticker
Payload - Полезная нагрузка для стикеров.
- Subscription
- Подписка на webhook.
- Update
Chat Info - Параметры для обновления информации о чате.
- User
- Пользователь MAX.
- Video
Info - Информация о видеофайле.
Enums§
- Attachment
- Тип вложения.
- Attachment
Data - Вложение из API MAX.
- Attachment
Source - Источник файлового вложения: локальный файл или уже полученный токен.
- Chat
Admin Permission Kind - Права администратора чата.
- Chat
Status Kind - Статус чата.
- Chat
Type Kind - Тип чата.
- Error
- Тип ошибки, используемый во всей библиотеке.
- Filter
- Определяет, какие обновления интересуют обработчик.
- Keyboard
Validation Error - Ошибка проверки inline-клавиатуры.
- Update
- Тип обновления (события), получаемого через long polling или webhook.
- Update
Type - Тип обновления (строковый enum) – оставлен для обратной совместимости.
Traits§
- MaxClient
Simple Ext - Расширяющий типаж для
MaxClientс быстрыми методами отправки.
Functions§
- get_
global_ max_ rps - Возвращает текущее глобальное ограничение RPS.
- set_
global_ base_ url - Устанавливает глобальный базовый URL API для всех клиентов.
- set_
global_ max_ rps - Устанавливает глобальное ограничение частоты запросов (RPS).
- split_
text - Основная функция разбиения текста
Type Aliases§
- Result
- Сокращение для
Result<T, Error>.