Expand description
§TeamTalk SDK for Rust
This crate is a high-level, safety-first wrapper for the BearWare.dk TeamTalk 5 SDK. It provides strict typing and a pure event-driven model for performance and reliability.
§Links
- User guides: https://github.com/BlindMaster24/TeamTalkRust/tree/main/docs
- API reference: https://docs.rs/teamtalk
Re-exports§
pub use async_api::AsyncClient;pub use async_api::AsyncConfig;pub use bot::RedisStateStore;pub use bot::SqliteStateStore;pub use bot::Args;pub use bot::Bot;pub use bot::BotApp;pub use bot::BotBuilder;pub use bot::BotConfig;pub use bot::Command;pub use bot::CommandArgPattern;pub use bot::CommandOnly;pub use bot::CommandPattern;pub use bot::CommandPatternError;pub use bot::Context;pub use bot::DialogFlow;pub use bot::DialogMachine;pub use bot::DialogState;pub use bot::DialogStatus;pub use bot::DialogTimeoutPolicy;pub use bot::FnMiddleware;pub use bot::HandlerResult;pub use bot::JobErrorPolicy;pub use bot::MemoryStateStore;pub use bot::Middleware;pub use bot::Permissions;pub use bot::RateLimitBySource;pub use bot::RequireChannelMessage;pub use bot::RequireClientRightsAll;pub use bot::RequireClientRightsAny;pub use bot::RequireCommand;pub use bot::RequireCommandPrefix;pub use bot::RequirePrivateMessage;pub use bot::RequireUserIds;pub use bot::RequireUserType;pub use bot::RouteMatcher;pub use bot::Router;pub use bot::Scheduler;pub use bot::StateStore;pub use bot::UnknownCommandPolicy;pub use bot::parse_command;pub use bot::AsyncBot;pub use bot::AsyncBotBuilder;pub use bot::AsyncBotConfig;pub use client::audio::AudioDeviceProfile;pub use client::audio::AudioBlockSink;pub use client::audio::AudioBlockSubscription;pub use client::audio::AudioBlockView;pub use client::audio::CallbackSink;pub use client::audio::UdpSink;pub use client::audio::WriterSink;pub use client::recording::RecordSession;pub use client::recording::RecordingOptions;pub use client::recording::RecordingSampleFormat;pub use client::recording::RecordingSession;pub use client::recording::RecordingTarget;pub use client::recording::SilencePolicy;pub use client::recording::SyncedUserRecording;pub use client::recording::SyncedUserRecordingBus;pub use client::recording::SyncedUserRecordingOptions;pub use client::recording::SyncedUserRecordingSession;pub use client::recording::UserRecordingOptions;pub use client::recording::UserRecordingSession;pub use client::users::LoginParams;pub use client::users::SendTextOptions;pub use client::Client;pub use client::ClientCommands;pub use client::ClientEvent;pub use client::ClientEvents;pub use client::ClientHealth;pub use client::ClientHooks;pub use client::ClientInfo;pub use client::ClientManager;pub use client::ClientRegistry;pub use client::EventContext;pub use client::EventData;pub use client::EventSubscriptionId;pub use client::Message;pub use client::ReconnectConfig;pub use client::ReconnectPhaseTimeouts;pub use client::ServerInfo;pub use client::StoreSnapshot;pub use dispatch::ClientConfig;pub use dispatch::ConnectParamsOwned;pub use dispatch::DispatchFlow;pub use dispatch::Dispatcher;pub use dispatch::EventContext as DispatchEventContext;pub use dispatch::ReconnectSettings;pub use events::ConnectionState;pub use events::Error;pub use events::Event;pub use events::Result;pub use mock::MockClient;pub use mock::MockMessage;pub use mock::MockUserBuilder;pub use types::ClientId;pub use types::MessageBuilder;pub use types::UserRights;
Modules§
- async_
api - Async wrapper around the polling client.
- bot
- High-level bot framework built on top of TeamTalk client polling.
- client
- Core client type and message wrapper.
- dispatch
- Event dispatcher built on top of Client::poll.
- events
- Event and error types emitted by the TeamTalk client.
- extensions
- loader
- Runtime loader for TeamTalk SDK binaries.
- logging
- Tracing integration for client events.
- mock
- Mock event source for tests and offline simulations.
- types
- Core data structures and constants used by the SDK.
- utils
- Utility helpers used across the TeamTalk SDK.
Functions§
- init
- Initializes the TeamTalk SDK by loading the runtime DLL from the default location.
- init_
with_ path - Initializes the TeamTalk SDK using a custom DLL path.
- set_
license - Sets TeamTalk license information before creating any
Client.