Struct Session

Source
pub struct Session(/* private fields */);
Expand description

A shared reference to a Spotify session.

After instantiating, you need to login via Session::connect. You can either implement the whole playback logic yourself by using this structs interface directly or hand it to a Player.

Note: Session instances cannot yet be reused once invalidated. After an unexpectedly closed connection, you’ll need to create a new Session.

Implementations§

Source§

impl Session

Source

pub fn new(config: SessionConfig, cache: Option<Cache>) -> Self

Source

pub async fn connect( &self, credentials: Credentials, store_credentials: bool, ) -> Result<(), Error>

Source

pub fn apresolver(&self) -> &ApResolver

Source

pub fn audio_key(&self) -> &AudioKeyManager

Source

pub fn channel(&self) -> &ChannelManager

Source

pub fn http_client(&self) -> &HttpClient

Source

pub fn mercury(&self) -> &MercuryManager

Source

pub fn spclient(&self) -> &SpClient

Source

pub fn token_provider(&self) -> &TokenProvider

Source

pub fn time_delta(&self) -> i64

Source

pub fn spawn<T>(&self, task: T)
where T: Future + Send + 'static, T::Output: Send + 'static,

Source

pub fn send_packet(&self, cmd: PacketType, data: Vec<u8>) -> Result<(), Error>

Source

pub fn cache(&self) -> Option<&Arc<Cache>>

Source

pub fn config(&self) -> &SessionConfig

Source

pub fn user_data(&self) -> UserData

Source

pub fn device_id(&self) -> &str

Source

pub fn client_id(&self) -> String

Source

pub fn set_client_id(&self, client_id: &str)

Source

pub fn client_name(&self) -> String

Source

pub fn set_client_name(&self, client_name: &str)

Source

pub fn client_brand_name(&self) -> String

Source

pub fn set_client_brand_name(&self, client_brand_name: &str)

Source

pub fn client_model_name(&self) -> String

Source

pub fn set_client_model_name(&self, client_model_name: &str)

Source

pub fn connection_id(&self) -> String

Source

pub fn set_connection_id(&self, connection_id: &str)

Source

pub fn username(&self) -> String

Source

pub fn set_username(&self, username: &str)

Source

pub fn country(&self) -> String

Source

pub fn filter_explicit_content(&self) -> bool

Source

pub fn autoplay(&self) -> bool

Source

pub fn set_user_attribute(&self, key: &str, value: &str) -> Option<String>

Source

pub fn set_user_attributes(&self, attributes: UserAttributes)

Source

pub fn get_user_attribute(&self, key: &str) -> Option<String>

Source

pub fn shutdown(&self)

Source

pub fn is_invalid(&self) -> bool

Trait Implementations§

Source§

impl Clone for Session

Source§

fn clone(&self) -> Session

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,