Struct spotify_oauth::SpotifyCallback

pub struct SpotifyCallback { /* fields omitted */ }

The Spotify Callback URL

This struct follows the parameters given at this link.

The main use of this object is to convert the callback URL into an object that can be used to generate a token. If needed you can also create this callback object using the new function in the struct.

Example

use spotify_oauth::SpotifyCallback;
use std::str::FromStr;

// Create a new spotify callback object using the callback url given by the authorization process.
// This object can then be converted into the token needed for the application.
let callback = SpotifyCallback::from_str("https://example.com/callback?code=NApCCgBkWtQ&state=test").unwrap();

assert_eq!(callback, SpotifyCallback::new(Some("NApCCgBkWtQ".to_string()), None, String::from("test")));

Methods

impl SpotifyCallback

Conversion and helper functions for SpotifyCallback.

pub fn new(code: Option<String>, error: Option<String>, state: String) -> Self

Create a new Spotify Callback object with given values.

Example

use spotify_oauth::SpotifyCallback;

// Create a new spotify callback object using the new function.
// This object can then be converted into the token needed for the application.
let callback = SpotifyCallback::new(Some("NApCCgBkWtQ".to_string()), None, String::from("test"));

pub fn convert_into_token(
    self,
    client_id: String,
    client_secret: String,
    redirect_uri: Url
) -> Result<SpotifyToken, SpotifyError>

Converts the Spotify Callback object into a Spotify Token object.

Example

use spotify_oauth::{SpotifyAuth, SpotifyCallback, SpotifyScope};
use std::str::FromStr;

// Create a new Spotify auth object.
let auth = SpotifyAuth::new("00000000000".into(), "secret".into(), "code".into(), "http://localhost:8000/callback".into(), vec![SpotifyScope::Streaming], false);

// Create a new spotify callback object using the callback url given by the authorization process and convert it into a token.
let token = SpotifyCallback::from_str("https://example.com/callback?code=NApCCgBkWtQ&state=test").unwrap()
    .convert_into_token(auth.client_id, auth.client_secret, auth.redirect_uri);

Trait Implementations

impl PartialEq<SpotifyCallback> for SpotifyCallback

fn eq(&self, other: &SpotifyCallback) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &SpotifyCallback) -> bool

This method tests for !=.

impl Debug for SpotifyCallback

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

Formats the value using the given formatter.

impl FromStr for SpotifyCallback

Implementation of FromStr for Spotify Callback URLs.

Example

use spotify_oauth::SpotifyCallback;
use std::str::FromStr;

// Create a new spotify callback object using the callback url given by the authorization process.
// This object can then be converted into the token needed for the application.
let callback = SpotifyCallback::from_str("https://example.com/callback?code=NApCCgBkWtQ&state=test").unwrap();

assert_eq!(callback, SpotifyCallback::new(Some("NApCCgBkWtQ".to_string()), None, String::from("test")));

type Err = SpotifyError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.