Skip to main content

SubsonicClient

Struct SubsonicClient 

Source
pub struct SubsonicClient { /* private fields */ }
Expand description

Subsonic/Navidrome API client.

Implementations§

Source§

impl SubsonicClient

Source

pub fn new(base_url: &str, username: &str, password: &str) -> Self

Source

pub fn ping(&self) -> Result<(), SubsonicError>

Ping the server — verify connection and credentials.

Source

pub fn get_artists(&self) -> Result<Vec<SubsonicArtist>, SubsonicError>

Get all artists (indexed).

Source

pub fn get_album(&self, id: &str) -> Result<SubsonicAlbumFull, SubsonicError>

Get an album by ID, including its tracks.

Source

pub fn get_album_list( &self, list_type: &str, size: u32, offset: u32, ) -> Result<Vec<SubsonicAlbum>, SubsonicError>

Get a paginated list of albums.

Source

pub fn stream_url(&self, track_id: &str) -> String

Build the streaming URL for a track (doesn’t make a request).

Source

pub fn stream_url_template(&self, track_id: &str) -> String

Stream URL without auth params — safe for database storage.

Source

pub fn download(&self, track_id: &str, dest: &Path) -> Result<(), SubsonicError>

Download a track to a local path.

Source

pub fn download_with_progress( &self, track_id: &str, dest: &Path, on_progress: impl Fn(u64, u64), ) -> Result<(), SubsonicError>

Download a track with progress reporting. The callback receives (bytes_downloaded, total_bytes). Total may be 0 if the server doesn’t send Content-Length.

Source

pub fn search(&self, query: &str) -> Result<SubsonicSearchResult, SubsonicError>

Search for tracks/albums/artists.

Source

pub fn scrobble(&self, track_id: &str) -> Result<(), SubsonicError>

Report a play (scrobble).

Source

pub fn star(&self, track_id: &str) -> Result<(), SubsonicError>

Star (favourite) a track on the server.

Source

pub fn unstar(&self, track_id: &str) -> Result<(), SubsonicError>

Unstar (unfavourite) a track on the server.

Source

pub fn get_starred(&self) -> Result<Vec<SubsonicSong>, SubsonicError>

Get all starred (favourite) songs from the server.

Source

pub fn create_share( &self, ids: &[&str], description: Option<&str>, ) -> Result<SubsonicShare, SubsonicError>

Create a sharing link for one or more resources (songs, albums, etc). Returns the created share including its ID which forms the public URL.

Source

pub fn get_similar_songs( &self, song_id: &str, count: usize, ) -> Result<Vec<SubsonicSong>, SubsonicError>

Get similar songs for a track (Subsonic getSimilarSongs2 endpoint). Returns up to count similar songs based on the server’s algorithm.

Source

pub fn get_top_songs( &self, artist_name: &str, count: usize, ) -> Result<Vec<SubsonicSong>, SubsonicError>

Get top songs for an artist by name.

Source

pub fn base_url(&self) -> &str

The configured server base URL (for constructing share links etc).

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<F, T> IntoSample<T> for F
where T: FromSample<F>,

Source§

fn into_sample(self) -> T

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

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<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,