Struct Http

pub struct Http {
    pub authority: String,
    pub rest_address: String,
    pub rest_address_versionless: String,
    pub headers: HeaderMap,
    pub request_client: Arc<Client<HttpsConnector<HttpConnector>, Full<Bytes>>>,
}

Fields

authority: String

rest_address: String

rest_address_versionless: String

headers: HeaderMap

request_client: Arc<Client<HttpsConnector<HttpConnector>, Full<Bytes>>>

Implementations

impl Http

pub async fn request<R: DeserializeOwned, T: Serialize + ?Sized, U>( &self, method: Method, uri: U, data: Option<&T>, ) -> LavalinkResult<R>

where Uri: TryFrom<U>, <Uri as TryFrom<U>>::Error: Into<Error>,

Makes an HTTP/1.1 request using Hyper to endpoints that return deserializable data.

pub async fn raw_request<T: Serialize + ?Sized, U>( &self, method: Method, uri: U, data: Option<&T>, ) -> LavalinkResult<String>

where Uri: TryFrom<U>, <Uri as TryFrom<U>>::Error: Into<Error>,

Makes an HTTP/1.1 request using Hyper to endpoints that return text data.

pub fn path_to_uri( &self, path: &str, with_version: bool, ) -> Result<Uri, InvalidUri>

Convert a path and query to a uri that points to the lavalink server.

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

Destroys the player for this guild in this session.

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

Updates or creates the player for this guild.

pub async fn set_resuming_state( &self, session_id: &str, resuming_state: &ResumingState, ) -> LavalinkResult<ResumingState>

Updates the session with the resuming state and timeout.

pub async fn load_tracks(&self, 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: “ytsearch:Ne Obliviscaris - Forget Not”

pub async fn version(&self) -> LavalinkResult<String>

Request Lavalink server version.

pub async fn stats(&self) -> LavalinkResult<Stats>

Request Lavalink statistics.

NOTE: The frame stats will never be returned.

pub async fn info(&self) -> LavalinkResult<Info>

Request Lavalink server information.

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

Decode a single track into its info.

Parameters

• track: base64 encoded track data.

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

Decode multiple tracks into their info.

Parameters

• tracks: base64 encoded tracks.

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

Returns the player for this guild in this session.

pub async fn get_players(&self, session_id: &str) -> LavalinkResult<Vec<Player>>

Returns a list of players in this specific session.

Trait Implementations

impl Clone for Http

fn clone(&self) -> Http

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Http

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl IntoPy<Py<PyAny>> for Http

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 Http

type Target = Http

The Python output type

type Output = Bound<'py, <Http 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 Http

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for Http

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

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 Http

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

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

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

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

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

impl PyTypeInfo for Http

const NAME: &'static str = "Http"

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 Http