Struct QueueRef

pub struct QueueRef { /* private fields */ }

A reference to the player queue

Implementations

impl QueueRef

pub async fn get_queue(&self) -> LavalinkResult<VecDeque<TrackInQueue>>

Get the current queue.

Note: This clones the entire queue. Use the Stream implementation instead to iterate through it.

pub async fn get_track( &self, index: usize, ) -> LavalinkResult<Option<TrackInQueue>>

Get the track at the index.

Note: This clones the track.

pub async fn get_count(&self) -> LavalinkResult<usize>

Get the amount of tracks in the queue, AKA the queue length.

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

Add the track at the end of the queue.

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

Add the track at the start of the queue.

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

Insert the track at the given index.

pub fn remove(&self, index: usize) -> LavalinkResult<()>

Remove the track at the given index.

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

Clear the queue.

pub fn replace(&self, tracks: VecDeque<TrackInQueue>) -> LavalinkResult<()>

Replace the entire queue with a new one.

pub fn append(&self, tracks: VecDeque<TrackInQueue>) -> LavalinkResult<()>

Append the list at the end of the current queue.

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

Swap the track at the index with a new track.

pub fn send(&self, queue_message: QueueMessage) -> LavalinkResult<()>

Send messages to the queue to obtain tracks from it, or modify it.

Trait Implementations

impl Clone for QueueRef

fn clone(&self) -> QueueRef

Returns a copy of the value.

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

Performs copy-assignment from source.

impl IntoPy<Py<PyAny>> for QueueRef

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

Performs the conversion.

impl PyClass for QueueRef

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for QueueRef

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

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 QueueRef

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

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

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

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

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

impl PyMethods<QueueRef> for PyClassImplCollector<QueueRef>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for QueueRef

const NAME: &'static str = "QueueRef"

Class name.

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

Module name, if any.

type AsRefTarget = PyCell<QueueRef>

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.

impl Stream for QueueRef

type Item = TrackInQueue

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.