Struct SubsonicClient 

pub struct SubsonicClient { /* private fields */ }

Subsonic/Navidrome API client.

Holds two HTTP clients with different timeout semantics: http bounds a whole JSON request, which is right for small API responses read in one go; downloader bounds only connect and per-read stalls, so a large track on a slow link is never cut off for taking too long overall.

Implementations

impl SubsonicClient

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

pub fn from_auth(auth: SubsonicAuth) -> Self

pub fn get_cover_art( &self, id: &str, size: Option<u32>, ) -> Result<Vec<u8>, SubsonicError>

Fetch cover art bytes for a song or album ID.

Returns the raw image rather than a parsed response — getCoverArt answers with image data, not JSON, so it can’t go through get(). size requests a square thumbnail; omit it for the original.

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

Ping the server — verify connection and credentials.

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

Get all artists (indexed).

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

Get an album by ID, including its tracks.

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

Get a paginated list of albums.

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

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

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

Stream URL without auth params — safe for database storage.

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

Download a track to a local path.

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 is 0 when the server sends no Content-Length, and the count restarts from zero if an attempt is retried. dest only appears once the file is complete.

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

Fetch a track through /rest/stream instead of /rest/download.

download returns the untranscoded original and is what library sync wants from Navidrome. koan’s own server implements only stream, so that is how the remote bridge pulls audio from a koan serve instance.

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

Search for tracks/albums/artists.

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

Report a play (scrobble).

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

Star (favourite) a track on the server.

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

Unstar (unfavourite) a track on the server.

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

Get all starred (favourite) songs from the server.

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

Everything the server has starred: songs, albums and artists.

Subsonic returns all three from one call, so asking for songs alone leaves a starred album invisible to us for no saving.

pub fn star_album(&self, album_id: &str) -> Result<(), SubsonicError>

Star an album. Subsonic keys this off a different parameter to a song — id would be read as a track and silently star nothing.

pub fn unstar_album(&self, album_id: &str) -> Result<(), SubsonicError>

pub fn star_artist(&self, artist_id: &str) -> Result<(), SubsonicError>

pub fn unstar_artist(&self, artist_id: &str) -> Result<(), SubsonicError>

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.

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.

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

Get top songs for an artist by name.

pub fn base_url(&self) -> &str

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