Struct PlayerContext

pub struct PlayerContext {
    pub guild_id: GuildId,
    pub client: LavalinkClient,
    /* private fields */
}

The player context.

Fields

guild_id: GuildId

client: LavalinkClient

Implementations

impl PlayerContext

pub fn close(self) -> LavalinkResult<()>

Close the current player.

pub fn skip(&self) -> LavalinkResult<()>

Skip the current track and play the next in the queue.

pub fn finish(&self, should_continue: bool) -> LavalinkResult<()>

Finish the current track.

Parameters

• should_continue: if the next track in the queue should play.

pub fn update_player_data(&self, player: Player) -> LavalinkResult<()>

Update player data in the context.

pub fn queue(&self, track: impl Into<TrackInQueue>) -> LavalinkResult<()>

Add a track to the end of the queue.

pub fn get_queue(&self) -> QueueRef

Get a reference to the current queue.

pub async fn get_player(&self) -> LavalinkResult<Player>

Get the current player information.

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

Request a raw player update.

pub async fn play(&self, track: &TrackData) -> LavalinkResult<Player>

Try and play a track. Does not change tracks if one is already playing.

NOTE: Does not modify the queue.

pub async fn play_now(&self, track: &TrackData) -> LavalinkResult<Player>

Force play a track, replacing the current track.

NOTE: Does not modify the queue.

pub async fn stop_now(&self) -> LavalinkResult<Player>

Stop playing the current track.

This does not continue playback of the queue.

pub async fn set_pause(&self, pause: bool) -> LavalinkResult<Player>

Set the pause state of the player.

pub async fn set_volume(&self, volume: u16) -> LavalinkResult<Player>

Set the volume of the player.

pub async fn set_filters(&self, filters: Filters) -> LavalinkResult<Player>

Set the filters of the player.

pub async fn set_position(&self, position: Duration) -> LavalinkResult<Player>

Jump to a specific position in the currently playing track.

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

Get the custom data provided when creating the player context.

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 player context.

Trait Implementations

impl Clone for PlayerContext

fn clone(&self) -> PlayerContext

Returns a copy of the value.

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

Performs copy-assignment from source.

impl IntoPy<Py<PyAny>> for PlayerContext

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

👎Deprecated since 0.23.0: IntoPy is going to be replaced by IntoPyObject. See the migration guide (https://pyo3.rs/v0.23.0/migration) for more information.

Performs the conversion.

impl<'py> IntoPyObject<'py> for PlayerContext

type Target = PlayerContext

The Python output type

type Output = Bound<'py, <PlayerContext as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for PlayerContext

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for PlayerContext

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<PlayerContext>

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 PlayerContext

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

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

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

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

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

impl PyMethods<PlayerContext> for PyClassImplCollector<PlayerContext>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for PlayerContext

const NAME: &'static str = "PlayerContext"

Class name.

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

Module name, if any.

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

Returns the PyTypeObject instance for this type.

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

Returns the safe abstraction over the type object.

fn type_object_bound(py: Python<'_>) -> Bound<'_, PyType>

👎Deprecated since 0.23.0: renamed to PyTypeInfo::type_object

Deprecated name for PyTypeInfo::type_object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

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

fn is_type_of_bound(object: &Bound<'_, PyAny>) -> bool

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_type_of

Deprecated name for PyTypeInfo::is_type_of.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

fn is_exact_type_of_bound(object: &Bound<'_, PyAny>) -> bool

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_exact_type_of

Deprecated name for PyTypeInfo::is_exact_type_of.

impl DerefToPyAny for PlayerContext