Struct DiscId 

pub struct DiscId { /* private fields */ }

DiscId holds information about a disc (TOC, MCN, ISRCs).

Use DiscId::read, DiscId::read_features, DiscId::put or DiscId::parse to initialize an instance of DiscId.

Internally this type uses libdiscid handles which must not be accessed concurrently or moved across threads. Consequently, DiscId does not implement Send or Sync.

Implementations

impl DiscId

pub fn read(device: Option<&str>) -> Result<Self, DiscError>

Read the disc in the given CD-ROM/DVD-ROM drive extracting only the TOC.

This function reads the disc in the drive specified by the given device identifier. If the device is None, the default device, as returned by DiscId::default_device, is used.

This function will only read the TOC, hence only the disc ID itself will be available. Use DiscId::read_features if you want to read also MCN and ISRCs.

Errors

Will return Err if reading the disc failed for any reason, e.g. no CD drive available or no disc inserted.

Examples

Read from default device

use discid::DiscId;

let disc = DiscId::read(None).expect("Reading disc failed");
println!("ID: {}", disc.id());

Read from specific device

let disc = DiscId::read(Some("/dev/sr1")).expect("Reading disc failed");
println!("ID: {}", disc.id());

pub fn read_features( device: Option<&str>, features: Features, ) -> Result<Self, DiscError>

Read the disc in the given CD-ROM/DVD-ROM drive with additional features.

This function is similar to DiscId::read but allows to read information about MCN and per-track ISRCs in addition to the normal TOC data.

The parameter features accepts a bitwise combination of values defined in Features. Features::READ is always implied, so it is not necessary to specify it.

Reading MCN and ISRCs is not available on all platforms. You can use the has_feature method to check if a specific feature is available. Passing unsupported features here will just be ignored.

Note that reading MCN and ISRC data is significantly slower than just reading the TOC, so only request the features you actually need.

Errors

Will return Err if reading the disc failed for any reason, e.g. no CD drive available or no disc inserted.

Examples

Read both ISRC and MCN from default device

use discid::{DiscId, Features};

let features = Features::MCN | Features::ISRC;
let disc = DiscId::read_features(None, features).expect("Reading disc failed");
println!("ID : {}", disc.id());
println!("MCN: {}", disc.mcn());
for track in disc.tracks() {
    println!("#{} ISRC: {}", track.number, track.isrc);
}

Examples found in repository

examples/readisrcs.rs (line 4)

fn main() {
    let result = DiscId::read_features(None, Features::ISRC);

    match result {
        Ok(disc) => {
            println!("Disc ID: {}", disc.id());

            for track in disc.tracks() {
                println!("Track #{} ISRC: {}", track.number, track.isrc);
            }
        }
        Err(e) => {
            eprintln!("{}", e);
            std::process::exit(1);
        }
    }
}

examples/readdiscid.rs (line 12)

fn main() {
    // Read the device name from the command line or use the default.
    let arg1 = env::args().nth(1).unwrap_or_default();
    let device = if !arg1.is_empty() {
        Some(&arg1[..])
    } else {
        None
    };
    let result = DiscId::read_features(device, Features::all());

    match result {
        Ok(disc) => print_disc_info(disc),
        Err(e) => {
            eprintln!("{}", e);
            std::process::exit(1);
        }
    }
}

pub fn put(first: i32, offsets: &[i32]) -> Result<Self, DiscError>

Provides the TOC of a known CD.

This function may be used if the TOC has been read earlier and you want to calculate the disc ID afterwards, without accessing the disc drive.

first is the track number of the first track (1-99). The offsets parameter points to an array which contains the track offsets for each track. The first element, offsets[0], is the lead-out track. It must contain the total number of sectors on the disc. offsets must not be longer than 100 elements (lead-out + 99 tracks).

Errors

Will return Err if the provided offsets are invalid.

Examples:

use discid::DiscId;

let first_track = 1;
// The offsets contain the total number of sectors as first element, followed by
// the start sectors of each track.
let offsets = [
   242457, 150, 44942, 61305, 72755, 96360, 130485, 147315, 164275, 190702, 205412, 220437,
];
let disc = DiscId::put(first_track, &offsets).expect("DiscId::put() failed");
assert_eq!("lSOVc5h6IXSuzcamJS1Gp4_tRuA-", disc.id());

Examples found in repository

examples/discfromtoc.rs (line 7)

fn main() {
    let offsets = [
        242457, 150, 44942, 61305, 72755, 96360, 130485, 147315, 164275, 190702, 205412, 220437,
    ];
    let result = DiscId::put(1, &offsets);

    match result {
        Ok(disc) => print_disc_info(disc),
        Err(e) => {
            eprintln!("{}", e);
            std::process::exit(1);
        }
    }
}

pub fn parse(toc: &str) -> Result<Self, DiscError>

Parses a TOC string and returns a DiscId instance for it.

The TOC string provided here must have the same format as returned by toc_string.

This function can be used if you already have a TOC string like e.g. 1 11 242457 150 44942 61305 72755 96360 130485 147315 164275 190702 205412 220437.

Errors

Will return Err if the provided toc is invalid.

Examples:

use discid::DiscId;

let toc = "1 11 242457 150 44942 61305 72755 96360 130485 147315 164275 190702 205412 220437";
let disc = DiscId::parse(toc).expect("DiscId::put() failed");
assert_eq!("lSOVc5h6IXSuzcamJS1Gp4_tRuA-", disc.id());
assert_eq!(toc, disc.toc_string());

Examples found in repository

examples/parsetoc.rs (line 5)

fn main() {
    let toc = "1 11 242457 150 44942 61305 72755 96360 130485 147315 164275 190702 205412 220437";
    let result = DiscId::parse(toc);

    match result {
        Ok(disc) => print_disc_info(disc),
        Err(e) => {
            eprintln!("{}", e);
            std::process::exit(1);
        }
    }
}

pub fn has_feature(feature: Features) -> bool

Check if a certain feature is implemented on the current platform.

Support for multiple features can be tested by providing a bit masks of features. The function will return true only if all features are supported.

See the libdiscid feature matrix for a list of supported features per platform.

Examples

Check for a single feature:

use discid::{DiscId, Features};

let can_read = DiscId::has_feature(Features::READ);
assert!(can_read);

Check support of multiple features:

use discid::{DiscId, Features};

let can_read = DiscId::has_feature(Features::READ | Features::ISRC);
assert!(can_read);

pub fn version_string() -> String

Return version information about libdiscid.

The returned string will be e.g. "libdiscid 0.6.2".

Examples

use discid::DiscId;

println!("{}", DiscId::version_string());

Examples found in repository

examples/discidinfo.rs (line 4)

fn main() {
    println!("Version       : {}", DiscId::version_string());
    println!("Default device: {}", DiscId::default_device());
}

pub fn default_device() -> String

Return the name of the default disc drive for this operating system.

The default device is system dependent, e.g. /dev/cdrom on Linux and D: on Windows.

Examples

use discid::DiscId;

println!("{}", DiscId::default_device());

Examples found in repository

examples/discidinfo.rs (line 5)

fn main() {
    println!("Version       : {}", DiscId::version_string());
    println!("Default device: {}", DiscId::default_device());
}

pub fn id(&self) -> String

The MusicBrainz disc ID.

Examples found in repository

examples/discfromtoc.rs (line 19)

fn print_disc_info(disc: DiscId) {
    println!("DiscId: {}", disc.id());
    println!("TOC   : {}", disc.toc_string());
    println!("\nSubmit via {}", disc.submission_url());
}

examples/readisrcs.rs (line 8)

fn main() {
    let result = DiscId::read_features(None, Features::ISRC);

    match result {
        Ok(disc) => {
            println!("Disc ID: {}", disc.id());

            for track in disc.tracks() {
                println!("Track #{} ISRC: {}", track.number, track.isrc);
            }
        }
        Err(e) => {
            eprintln!("{}", e);
            std::process::exit(1);
        }
    }
}

examples/parsetoc.rs (line 17)

fn print_disc_info(disc: DiscId) {
    println!("DiscID      : {}", disc.id());
    println!("FreeDB ID   : {}", disc.freedb_id());
    println!("TOC         : {}", disc.toc_string());
    println!("First track : {}", disc.first_track_num());
    println!("Last track  : {}", disc.last_track_num());
    println!("Sectors     : {}\n", disc.sectors());

    for track in disc.tracks() {
        println!("Track #{}", track.number);
        println!("    Offset  : {}", track.offset);
        println!("    Sectors : {}", track.sectors);
    }

    println!("\nSubmit via {}", disc.submission_url());
}

examples/readdiscid.rs (line 24)

fn print_disc_info(disc: DiscId) {
    println!("DiscID      : {}", disc.id());
    println!("FreeDB ID   : {}", disc.freedb_id());
    println!("TOC         : {}", disc.toc_string());
    println!("MCN         : {}", disc.mcn());
    println!("First track : {}", disc.first_track_num());
    println!("Last track  : {}", disc.last_track_num());
    println!("Sectors     : {}\n", disc.sectors());

    for track in disc.tracks() {
        println!("Track #{}", track.number);
        println!("    ISRC    : {}", track.isrc);
        println!("    Offset  : {}", track.offset);
        println!("    Sectors : {}", track.sectors);
    }
}

pub fn freedb_id(&self) -> String

The FreeDB disc ID.

Examples found in repository

examples/parsetoc.rs (line 18)

fn print_disc_info(disc: DiscId) {
    println!("DiscID      : {}", disc.id());
    println!("FreeDB ID   : {}", disc.freedb_id());
    println!("TOC         : {}", disc.toc_string());
    println!("First track : {}", disc.first_track_num());
    println!("Last track  : {}", disc.last_track_num());
    println!("Sectors     : {}\n", disc.sectors());

    for track in disc.tracks() {
        println!("Track #{}", track.number);
        println!("    Offset  : {}", track.offset);
        println!("    Sectors : {}", track.sectors);
    }

    println!("\nSubmit via {}", disc.submission_url());
}

examples/readdiscid.rs (line 25)

fn print_disc_info(disc: DiscId) {
    println!("DiscID      : {}", disc.id());
    println!("FreeDB ID   : {}", disc.freedb_id());
    println!("TOC         : {}", disc.toc_string());
    println!("MCN         : {}", disc.mcn());
    println!("First track : {}", disc.first_track_num());
    println!("Last track  : {}", disc.last_track_num());
    println!("Sectors     : {}\n", disc.sectors());

    for track in disc.tracks() {
        println!("Track #{}", track.number);
        println!("    ISRC    : {}", track.isrc);
        println!("    Offset  : {}", track.offset);
        println!("    Sectors : {}", track.sectors);
    }
}

pub fn toc_string(&self) -> String

Return a string representing CD Table Of Contents (TOC).

The TOC string is a list of integers separated by a single space character. The integers represent (in order):

• First track number (normally one)
• Last track number
• Lead-out track offset
• Up to 99 frame offsets

See also DiscId::parse and the documentation for Disc ID Calculation.

Examples found in repository

examples/discfromtoc.rs (line 20)

fn print_disc_info(disc: DiscId) {
    println!("DiscId: {}", disc.id());
    println!("TOC   : {}", disc.toc_string());
    println!("\nSubmit via {}", disc.submission_url());
}

examples/parsetoc.rs (line 19)

fn print_disc_info(disc: DiscId) {
    println!("DiscID      : {}", disc.id());
    println!("FreeDB ID   : {}", disc.freedb_id());
    println!("TOC         : {}", disc.toc_string());
    println!("First track : {}", disc.first_track_num());
    println!("Last track  : {}", disc.last_track_num());
    println!("Sectors     : {}\n", disc.sectors());

    for track in disc.tracks() {
        println!("Track #{}", track.number);
        println!("    Offset  : {}", track.offset);
        println!("    Sectors : {}", track.sectors);
    }

    println!("\nSubmit via {}", disc.submission_url());
}

examples/readdiscid.rs (line 26)

fn print_disc_info(disc: DiscId) {
    println!("DiscID      : {}", disc.id());
    println!("FreeDB ID   : {}", disc.freedb_id());
    println!("TOC         : {}", disc.toc_string());
    println!("MCN         : {}", disc.mcn());
    println!("First track : {}", disc.first_track_num());
    println!("Last track  : {}", disc.last_track_num());
    println!("Sectors     : {}\n", disc.sectors());

    for track in disc.tracks() {
        println!("Track #{}", track.number);
        println!("    ISRC    : {}", track.isrc);
        println!("    Offset  : {}", track.offset);
        println!("    Sectors : {}", track.sectors);
    }
}

pub fn submission_url(&self) -> String

An URL for submitting the DiscID to MusicBrainz.

Examples found in repository

examples/discfromtoc.rs (line 21)

fn print_disc_info(disc: DiscId) {
    println!("DiscId: {}", disc.id());
    println!("TOC   : {}", disc.toc_string());
    println!("\nSubmit via {}", disc.submission_url());
}

examples/parsetoc.rs (line 30)

fn print_disc_info(disc: DiscId) {
    println!("DiscID      : {}", disc.id());
    println!("FreeDB ID   : {}", disc.freedb_id());
    println!("TOC         : {}", disc.toc_string());
    println!("First track : {}", disc.first_track_num());
    println!("Last track  : {}", disc.last_track_num());
    println!("Sectors     : {}\n", disc.sectors());

    for track in disc.tracks() {
        println!("Track #{}", track.number);
        println!("    Offset  : {}", track.offset);
        println!("    Sectors : {}", track.sectors);
    }

    println!("\nSubmit via {}", disc.submission_url());
}

pub fn first_track_num(&self) -> i32

The number of the first track on this disc.

Examples found in repository

examples/parsetoc.rs (line 20)

fn print_disc_info(disc: DiscId) {
    println!("DiscID      : {}", disc.id());
    println!("FreeDB ID   : {}", disc.freedb_id());
    println!("TOC         : {}", disc.toc_string());
    println!("First track : {}", disc.first_track_num());
    println!("Last track  : {}", disc.last_track_num());
    println!("Sectors     : {}\n", disc.sectors());

    for track in disc.tracks() {
        println!("Track #{}", track.number);
        println!("    Offset  : {}", track.offset);
        println!("    Sectors : {}", track.sectors);
    }

    println!("\nSubmit via {}", disc.submission_url());
}

examples/readdiscid.rs (line 28)

fn print_disc_info(disc: DiscId) {
    println!("DiscID      : {}", disc.id());
    println!("FreeDB ID   : {}", disc.freedb_id());
    println!("TOC         : {}", disc.toc_string());
    println!("MCN         : {}", disc.mcn());
    println!("First track : {}", disc.first_track_num());
    println!("Last track  : {}", disc.last_track_num());
    println!("Sectors     : {}\n", disc.sectors());

    for track in disc.tracks() {
        println!("Track #{}", track.number);
        println!("    ISRC    : {}", track.isrc);
        println!("    Offset  : {}", track.offset);
        println!("    Sectors : {}", track.sectors);
    }
}

pub fn last_track_num(&self) -> i32

The number of the last track on this disc.

Examples found in repository

examples/parsetoc.rs (line 21)

fn print_disc_info(disc: DiscId) {
    println!("DiscID      : {}", disc.id());
    println!("FreeDB ID   : {}", disc.freedb_id());
    println!("TOC         : {}", disc.toc_string());
    println!("First track : {}", disc.first_track_num());
    println!("Last track  : {}", disc.last_track_num());
    println!("Sectors     : {}\n", disc.sectors());

    for track in disc.tracks() {
        println!("Track #{}", track.number);
        println!("    Offset  : {}", track.offset);
        println!("    Sectors : {}", track.sectors);
    }

    println!("\nSubmit via {}", disc.submission_url());
}

examples/readdiscid.rs (line 29)

fn print_disc_info(disc: DiscId) {
    println!("DiscID      : {}", disc.id());
    println!("FreeDB ID   : {}", disc.freedb_id());
    println!("TOC         : {}", disc.toc_string());
    println!("MCN         : {}", disc.mcn());
    println!("First track : {}", disc.first_track_num());
    println!("Last track  : {}", disc.last_track_num());
    println!("Sectors     : {}\n", disc.sectors());

    for track in disc.tracks() {
        println!("Track #{}", track.number);
        println!("    ISRC    : {}", track.isrc);
        println!("    Offset  : {}", track.offset);
        println!("    Sectors : {}", track.sectors);
    }
}

pub fn sectors(&self) -> i32

The length of the disc in sectors.

Examples found in repository

examples/parsetoc.rs (line 22)

fn print_disc_info(disc: DiscId) {
    println!("DiscID      : {}", disc.id());
    println!("FreeDB ID   : {}", disc.freedb_id());
    println!("TOC         : {}", disc.toc_string());
    println!("First track : {}", disc.first_track_num());
    println!("Last track  : {}", disc.last_track_num());
    println!("Sectors     : {}\n", disc.sectors());

    for track in disc.tracks() {
        println!("Track #{}", track.number);
        println!("    Offset  : {}", track.offset);
        println!("    Sectors : {}", track.sectors);
    }

    println!("\nSubmit via {}", disc.submission_url());
}

examples/readdiscid.rs (line 30)

fn print_disc_info(disc: DiscId) {
    println!("DiscID      : {}", disc.id());
    println!("FreeDB ID   : {}", disc.freedb_id());
    println!("TOC         : {}", disc.toc_string());
    println!("MCN         : {}", disc.mcn());
    println!("First track : {}", disc.first_track_num());
    println!("Last track  : {}", disc.last_track_num());
    println!("Sectors     : {}\n", disc.sectors());

    for track in disc.tracks() {
        println!("Track #{}", track.number);
        println!("    ISRC    : {}", track.isrc);
        println!("    Offset  : {}", track.offset);
        println!("    Sectors : {}", track.sectors);
    }
}

pub fn mcn(&self) -> String

The media catalogue number on the disc, if present.

Examples found in repository

examples/readdiscid.rs (line 27)

fn print_disc_info(disc: DiscId) {
    println!("DiscID      : {}", disc.id());
    println!("FreeDB ID   : {}", disc.freedb_id());
    println!("TOC         : {}", disc.toc_string());
    println!("MCN         : {}", disc.mcn());
    println!("First track : {}", disc.first_track_num());
    println!("Last track  : {}", disc.last_track_num());
    println!("Sectors     : {}\n", disc.sectors());

    for track in disc.tracks() {
        println!("Track #{}", track.number);
        println!("    ISRC    : {}", track.isrc);
        println!("    Offset  : {}", track.offset);
        println!("    Sectors : {}", track.sectors);
    }
}

pub fn tracks(&self) -> TrackIter

Returns an iterator to access information about each track on the disc.

Returns an instance of Track for each track.

Examples

use discid::DiscId;

let offsets = [
   242457, 150, 44942, 61305, 72755, 96360, 130485, 147315, 164275, 190702, 205412, 220437,
];
let disc = DiscId::put(1, &offsets).expect("DiscId::put() failed");
for track in disc.tracks() {
    println!("Track #{}", track.number);
    println!("    ISRC    : {}", track.isrc);
    println!("    Offset  : {}", track.offset);
    println!("    Sectors : {}", track.sectors);
}

Examples found in repository

examples/readisrcs.rs (line 10)

fn main() {
    let result = DiscId::read_features(None, Features::ISRC);

    match result {
        Ok(disc) => {
            println!("Disc ID: {}", disc.id());

            for track in disc.tracks() {
                println!("Track #{} ISRC: {}", track.number, track.isrc);
            }
        }
        Err(e) => {
            eprintln!("{}", e);
            std::process::exit(1);
        }
    }
}

examples/parsetoc.rs (line 24)

fn print_disc_info(disc: DiscId) {
    println!("DiscID      : {}", disc.id());
    println!("FreeDB ID   : {}", disc.freedb_id());
    println!("TOC         : {}", disc.toc_string());
    println!("First track : {}", disc.first_track_num());
    println!("Last track  : {}", disc.last_track_num());
    println!("Sectors     : {}\n", disc.sectors());

    for track in disc.tracks() {
        println!("Track #{}", track.number);
        println!("    Offset  : {}", track.offset);
        println!("    Sectors : {}", track.sectors);
    }

    println!("\nSubmit via {}", disc.submission_url());
}

examples/readdiscid.rs (line 32)

fn print_disc_info(disc: DiscId) {
    println!("DiscID      : {}", disc.id());
    println!("FreeDB ID   : {}", disc.freedb_id());
    println!("TOC         : {}", disc.toc_string());
    println!("MCN         : {}", disc.mcn());
    println!("First track : {}", disc.first_track_num());
    println!("Last track  : {}", disc.last_track_num());
    println!("Sectors     : {}\n", disc.sectors());

    for track in disc.tracks() {
        println!("Track #{}", track.number);
        println!("    ISRC    : {}", track.isrc);
        println!("    Offset  : {}", track.offset);
        println!("    Sectors : {}", track.sectors);
    }
}

pub fn get_track(&self, number: i32) -> Option<Track>

Returns information about a specific track on the disc.

This method retrieves a Track instance for the given track number, if it exists on the disc. If the requested track number is outside the valid range of first_track_num to last_track_num, None is returned.

Parameters

• number: The track number (1-99) you want to access.

Returns

• Some(Track) if the track exists.
• None if the track number is out of bounds.

Examples

use discid::DiscId;

let offsets = [242457, 150, 44942, 61305, 72755];
let disc = DiscId::put(1, &offsets).expect("DiscId::put() failed");

if let Some(track) = disc.get_track(3) {
    println!("Track #{} offset: {}", track.number, track.offset);
} else {
    println!("Track not found");
}

pub fn nth_track(&self, number: i32) -> Track

Returns a Track instance for the nth track.

Panics

Panics if number is outside the range given by first_track_num and last_track_num.

Consider using get_track for accessing tracks without the possibility of panicking.

Examples

use discid::DiscId;

let offsets = [
   242457, 150, 44942, 61305, 72755, 96360, 130485, 147315, 164275, 190702, 205412, 220437,
];
let disc = DiscId::put(1, &offsets).expect("DiscId::put() failed");
let track = disc.nth_track(7);
assert_eq!(7, track.number);
assert_eq!(147315, track.offset);
assert_eq!(16960, track.sectors);

Trait Implementations

impl Debug for DiscId

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

Formats the value using the given formatter.