xspf: straightforward implementation of the XML Sharable Playlist Format in pure rust

goals:

• performant
• lenient while parsing
• strict while serializing
• minimal dependancies
• useful documentation
• minimal allocations when printing

limitations:

• does not handle URIs. users of this library should make an effort to properly resolve relative URIs for tags such as <location>.
• only deals with UTF-8 documents.

overview

the core type is Playlist.

all field names are taken from the spec, however camelCase names have been changed to snake_case.

example

//! simple example: append a track to a playlist, giving proper credit.

use std::env::{args, var};
use xspf::{Playlist, Track};

fn main() {
        let playlist_path = args().nth(1).unwrap();
        let track_location = args().nth(2).unwrap();
        let mut pl = Playlist::read_file(&playlist_path)
                .expect("unable to read playlist from file");
        // move the previous playlist identifier (and location) to the
        // attribution section.
        pl.accredit();
        // add track
        let mut track = Track::default();
        track.location.push(track_location.to_string());
        pl.track_list.push(track);
        // set the creator field to the current user
        pl.creator = Some(var("USER").expect("$USER is not set").to_string());
        // modify the playlist file in-place
        pl.write_file(&playlist_path)
                .expect("unable to write playlist to file");
}