Struct LavalinkClient

pub struct LavalinkClient {
    pub nodes: Vec<Arc<Node>>,
    pub players: Arc<DashMap<GuildId, (ArcSwapOption<PlayerContext>, Arc<Node>)>>,
    pub events: Events,
    /* private fields */
}

The main client, where everything gets done, from events to requests to management.

Fields

nodes: Vec<Arc<Node>>

players: Arc<DashMap<GuildId, (ArcSwapOption<PlayerContext>, Arc<Node>)>>

events: Events

Implementations

impl LavalinkClient

pub async fn new( events: Events, nodes: Vec<NodeBuilder>, strategy: NodeDistributionStrategy, ) -> LavalinkClient

Create a new Lavalink Client. It also establish the connection(s) and start listening for events.

Parameters

• events: The lavalink event handler.
• nodes: List of nodes to connect to.

pub async fn new_with_data<Data: Any + Send + Sync>( events: Events, nodes: Vec<NodeBuilder>, strategy: NodeDistributionStrategy, user_data: Arc<Data>, ) -> LavalinkClient

Create a new Lavalink Client with custom user data. It also establish the connection(s) and start listening for events.

Parameters

• events: The lavalink event handler.
• nodes: List of nodes to connect to.
• user_data: Set the data that will be accessible from anywhere with the client.

pub fn get_node_by_index(&self, idx: usize) -> Option<Arc<Node>>

pub async fn get_node_for_guild( &self, guild_id: impl Into<GuildId>, ) -> Arc<Node>

Get the node assigned to a guild.

pub fn get_player_context( &self, guild_id: impl Into<GuildId>, ) -> Option<PlayerContext>

Get the player context for a guild, if it exists.

pub async fn create_player( &self, guild_id: impl Into<GuildId>, connection_info: impl Into<ConnectionInfo>, ) -> LavalinkResult<Player>

Creates a new player without a context.

Calling this method is required to play tracks on a guild.

pub async fn create_player_context( &self, guild_id: impl Into<GuildId>, connection_info: impl Into<ConnectionInfo>, ) -> LavalinkResult<PlayerContext>

Creates a new player with context.

Calling this method is required to create the initial player, and be able to use the built-in queue.

pub async fn create_player_context_with_data<Data: Any + Send + Sync>( &self, guild_id: impl Into<GuildId>, connection_info: impl Into<ConnectionInfo>, user_data: Arc<Data>, ) -> LavalinkResult<PlayerContext>

Creates a new player with context with custom user data.

Calling this method is required to create the initial player, and be able to use the built-in queue.

pub async fn delete_player( &self, guild_id: impl Into<GuildId>, ) -> LavalinkResult<()>

Deletes and closes a specific player context, if it exists.

pub async fn delete_all_player_contexts(&self) -> LavalinkResult<()>

Deletes all stored player contexts.

This is useful to put on the ready event, to close already open players in case the Lavalink server restarts.

pub async fn update_player( &self, guild_id: impl Into<GuildId>, update_player: &UpdatePlayer, no_replace: bool, ) -> LavalinkResult<Player>

Request a raw player update.

pub async fn load_tracks( &self, guild_id: impl Into<GuildId>, identifier: &str, ) -> LavalinkResult<Track>

Resolves audio tracks for use with the update_player endpoint.

Parameters

• identifier: A track identifier.
• Can be a url: “https://youtu.be/watch?v=DrM2lo6B04I”
• A unique identifier: “DrM2lo6B04I”
• A search: “

pub async fn decode_track( &self, guild_id: impl Into<GuildId>, track: &str, ) -> LavalinkResult<TrackData>

Decode a single track into its info.

Parameters

• track: base64 encoded track data.

pub async fn decode_tracks( &self, guild_id: impl Into<GuildId>, tracks: &[String], ) -> LavalinkResult<Vec<TrackData>>

Decode multiple tracks into their info.

Parameters

• tracks: base64 encoded tracks.

pub async fn request_version( &self, guild_id: impl Into<GuildId>, ) -> LavalinkResult<String>

Request Lavalink server version.

pub async fn request_stats( &self, guild_id: impl Into<GuildId>, ) -> LavalinkResult<Stats>

Request Lavalink statistics.

NOTE: The frame stats will never be returned.

pub async fn request_info( &self, guild_id: impl Into<GuildId>, ) -> LavalinkResult<Info>

Request Lavalink server information.

pub async fn request_player( &self, guild_id: impl Into<GuildId>, ) -> LavalinkResult<Player>

Returns the player for the guild.

pub async fn request_all_players( &self, guild_id: impl Into<GuildId>, ) -> LavalinkResult<Vec<Player>>

Returns all players from the Node bound to the guild.

pub fn data<Data: Send + Sync + 'static>(&self) -> LavalinkResult<Arc<Data>>

Get the custom data provided when creating the client.

Errors

Returns LavalinkError::InvalidDataType if the type argument provided does not match the type of the data provided, or if no data was provided when creating the client.

pub fn handle_voice_server_update( &self, guild_id: impl Into<GuildId>, token: String, endpoint: Option<String>, )

Method to handle the VOICE_SERVER_UPDATE event.

pub fn handle_voice_state_update( &self, guild_id: impl Into<GuildId>, channel_id: Option<impl Into<ChannelId>>, user_id: impl Into<UserId>, session_id: String, )

Method to handle the VOICE_STATE_UPDATE event.

pub async fn get_connection_info( &self, guild_id: impl Into<GuildId>, timeout: Duration, ) -> LavalinkResult<ConnectionInfo>

Returns the connection information needed for creating a player.

This methods requires that handle_voice_server_update and handle_voice_state_update be defined and handled inside their respective discord events.

Note

This methid may take longer to execute than the set timeout. Every event handled will reset the timeout. This method also uses interior mutability via logs, so if it is called multiple times with the same guild_id, it will execute them sequentially.

Errors

If the custom timeout was reached. This can happen if the bot never connected to the voice channel, or the events were not handled correctly, or the timeout was too short.

impl LavalinkClient

pub fn get_node_for_guild_py<'a>( &self, py: Python<'a>, guild_id: PyGuildId, ) -> PyResult<&'a PyAny>

Trait Implementations

impl Clone for LavalinkClient

fn clone(&self) -> LavalinkClient

Returns a copy of the value.

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

Performs copy-assignment from source.

impl IntoPy<Py<PyAny>> for LavalinkClient

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl PyClass for LavalinkClient

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for LavalinkClient

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<LavalinkClient>

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn doc(py: Python<'_>) -> PyResult<&'static CStr>

Rendered class doc

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a LavalinkClient

type Holder = Option<PyRef<'py, LavalinkClient>>

fn extract(obj: &'py PyAny, holder: &'a mut Self::Holder) -> PyResult<Self>

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a mut LavalinkClient

type Holder = Option<PyRefMut<'py, LavalinkClient>>

fn extract(obj: &'py PyAny, holder: &'a mut Self::Holder) -> PyResult<Self>

impl PyMethods<LavalinkClient> for PyClassImplCollector<LavalinkClient>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for LavalinkClient

const NAME: &'static str = "LavalinkClient"

Class name.

const MODULE: Option<&'static str> = ::core::option::Option::None

Module name, if any.

type AsRefTarget = PyCell<LavalinkClient>

Utility type to make Py::as_ref work.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> &PyType

Returns the safe abstraction over the type object.

fn is_type_of(object: &PyAny) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &PyAny) -> bool

Checks if object is an instance of this type.