Crate sunk

Expand description

sunk

sunk provides natural Rust bindings to the Subsonic music server API. Many other popular music servers, such as Libresonic and Airsonic, also use the Subsonic API, so this crate can stretch far beyond just Subsonic.

Basic usage

extern crate sunk;
use sunk::song::Song;
use sunk::{Album, Artist, Client, Streamable};

let site = "http://subsonic.example.com";
let username = "admin";
let password = "hunter2";

let client = Client::new(site, username, password)?;

let random_songs = Song::random(&client, 20)?;
for mut song in random_songs {
    song.set_max_bit_rate(320);
    let bytes = song.stream(&client)?;
    // Use another library to stream the `bytes`!
}

Philosophy

The fundamental principle behind the way sunk works is to be able to pivot on everything. If you have something returned from a query, you should be able to investigate that object more deeply. This is modelled after what you’d typically expect from mobile or web clients.

An example can be seen below:

let client = Client::new(site, username, password)?;

// I want to play some <insert artist here>.
let an_artist = Artist::get(&client, 20)?;
let artist_info = an_artist.info(&client)?;
let artists_albums = an_artist.albums(&client)?;

// I love this album. Let's download it.
let ref fav_album = artists_albums[0];
let album_info_and_similar = fav_album.info(&client)?;
let album_songs = fav_album.songs(&client)?;

use std::fs::File;
use std::io::Write;
for song in &album_songs {
    let bytes = song.download(&client)?;
    let mut file =
        File::create(song.title.clone() + "." + song.encoding())?;
    file.write(&bytes)?;
}

// I want to find stuff like this song.
let ref this_is_good = album_songs[6];
let similar = this_is_good.similar(&client, 10)?;