Struct File

pub struct File { /* private fields */ }

A representation of an audio file, with meta-data and properties.

Implementations

impl File

pub fn new<P: AsRef<Path>>(path: P) -> Result<File, FileError>

Creates a new taglib::File for the given filename.

Examples found in repository

examples/tagreader.rs (line 10)

pub fn main() {
    let args: Vec<String> = env::args().collect();

    for i in 1..args.len() {
        let ref arg = args[i];
        let file = match taglib::File::new(arg) {
            Ok(f) => f,
            Err(e) => {
                println!("Invalid file {} (error: {:?})", arg, e);
                continue;
            }
        };

        println!("*** \"{}\" ***", arg);

        match file.tag() {
            Ok(t) => {
                println!("-- TAG --");
                println!("title   - {}", t.title().unwrap_or_default());
                println!("artist  - {}", t.artist().unwrap_or_default());
                println!("album   - {}", t.album().unwrap_or_default());
                println!("year    - {}", t.year().unwrap_or_default());
                println!("comment - {}", t.comment().unwrap_or_default());
                println!("track   - {}", t.track().unwrap_or_default());
                println!("genre   - {}", t.genre().unwrap_or_default());
            }
            Err(e) => {
                println!("No available tags for {} (error: {:?})", arg, e);
            }
        }

        match file.audioproperties() {
            Ok(p) => {
                let secs = p.length() % 60;
                let mins = (p.length() - secs) / 60;

                println!("-- AUDIO --");
                println!("bitrate     - {}", p.bitrate());
                println!("sample rate - {}", p.samplerate());
                println!("channels    - {}", p.channels());
                println!("length      - {}m:{}s", mins, secs);
            }
            Err(e) => {
                println!("No available audio properties for {} (error: {:?})", arg, e);
            }
        }
    }
}

pub fn new_type(filename: &str, filetype: FileType) -> Result<File, FileError>

Creates a new taglib::File for the given filename and type of file.

pub fn tag(&self) -> Result<Tag<'_>, FileError>

Returns the taglib::Tag instance for the given file.

Examples found in repository

examples/tagreader.rs (line 20)

pub fn main() {
    let args: Vec<String> = env::args().collect();

    for i in 1..args.len() {
        let ref arg = args[i];
        let file = match taglib::File::new(arg) {
            Ok(f) => f,
            Err(e) => {
                println!("Invalid file {} (error: {:?})", arg, e);
                continue;
            }
        };

        println!("*** \"{}\" ***", arg);

        match file.tag() {
            Ok(t) => {
                println!("-- TAG --");
                println!("title   - {}", t.title().unwrap_or_default());
                println!("artist  - {}", t.artist().unwrap_or_default());
                println!("album   - {}", t.album().unwrap_or_default());
                println!("year    - {}", t.year().unwrap_or_default());
                println!("comment - {}", t.comment().unwrap_or_default());
                println!("track   - {}", t.track().unwrap_or_default());
                println!("genre   - {}", t.genre().unwrap_or_default());
            }
            Err(e) => {
                println!("No available tags for {} (error: {:?})", arg, e);
            }
        }

        match file.audioproperties() {
            Ok(p) => {
                let secs = p.length() % 60;
                let mins = (p.length() - secs) / 60;

                println!("-- AUDIO --");
                println!("bitrate     - {}", p.bitrate());
                println!("sample rate - {}", p.samplerate());
                println!("channels    - {}", p.channels());
                println!("length      - {}m:{}s", mins, secs);
            }
            Err(e) => {
                println!("No available audio properties for {} (error: {:?})", arg, e);
            }
        }
    }
}

pub fn is_valid(&self) -> bool

Returns whether the file is valid.

pub fn audioproperties(&self) -> Result<AudioProperties<'_>, FileError>

Returns the taglib::AudioProperties instance for the given file.

Examples found in repository

examples/tagreader.rs (line 36)

pub fn main() {
    let args: Vec<String> = env::args().collect();

    for i in 1..args.len() {
        let ref arg = args[i];
        let file = match taglib::File::new(arg) {
            Ok(f) => f,
            Err(e) => {
                println!("Invalid file {} (error: {:?})", arg, e);
                continue;
            }
        };

        println!("*** \"{}\" ***", arg);

        match file.tag() {
            Ok(t) => {
                println!("-- TAG --");
                println!("title   - {}", t.title().unwrap_or_default());
                println!("artist  - {}", t.artist().unwrap_or_default());
                println!("album   - {}", t.album().unwrap_or_default());
                println!("year    - {}", t.year().unwrap_or_default());
                println!("comment - {}", t.comment().unwrap_or_default());
                println!("track   - {}", t.track().unwrap_or_default());
                println!("genre   - {}", t.genre().unwrap_or_default());
            }
            Err(e) => {
                println!("No available tags for {} (error: {:?})", arg, e);
            }
        }

        match file.audioproperties() {
            Ok(p) => {
                let secs = p.length() % 60;
                let mins = (p.length() - secs) / 60;

                println!("-- AUDIO --");
                println!("bitrate     - {}", p.bitrate());
                println!("sample rate - {}", p.samplerate());
                println!("channels    - {}", p.channels());
                println!("length      - {}m:{}s", mins, secs);
            }
            Err(e) => {
                println!("No available audio properties for {} (error: {:?})", arg, e);
            }
        }
    }
}

pub fn save(&self) -> bool

Updates the meta-data of the file.

Trait Implementations

impl Drop for File

fn drop(&mut self)

Executes the destructor for this type.