Enum lofty::FileType

source ·

#[non_exhaustive]pub enum FileType {
Show 13 variants    Aac,
    Aiff,
    Ape,
    Flac,
    Mpeg,
    Mp4,
    Mpc,
    Opus,
    Vorbis,
    Speex,
    Wav,
    WavPack,
    Custom(&'static str),
}

Expand description

The type of file read

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

§

Custom(&'static str)

Implementations§

source §

impl FileType

source

pub fn primary_tag_type(&self) -> TagType

Returns the file type’s “primary” TagType, or the one most likely to be used in the target format

`FileType`	`TagType`
`Aac`, `Aiff`, `Mp3`, `Wav`	`Id3v2`
`Ape` , `Mpc`, `WavPack`	`Ape`
`Flac`, `Opus`, `Vorbis`, `Speex`	`VorbisComments`
`Mp4`	`Mp4Ilst`

§Panics

If an unregistered FileType (FileType::Custom) is encountered. See register_custom_resolver.

§Examples

use lofty::{FileType, TagType};

let file_type = FileType::Mpeg;
assert_eq!(file_type.primary_tag_type(), TagType::Id3v2);

source

pub fn supports_tag_type(&self, tag_type: TagType) -> bool

Returns if the target FileType supports a TagType

NOTE: This is feature dependent, meaning if you do not have the id3v2 feature enabled, FileType::Mpeg will return false for TagType::Id3v2.

§Panics

If an unregistered FileType (FileType::Custom) is encountered. See register_custom_resolver.

§Examples

use lofty::{FileType, TagType};

let file_type = FileType::Mpeg;
assert!(file_type.supports_tag_type(TagType::Id3v2));

source

pub fn from_ext<E>(ext: E) -> Option<Self>
where E: AsRef<OsStr>,

Attempts to extract a FileType from an extension

§Examples

use lofty::FileType;

let extension = "mp3";
assert_eq!(FileType::from_ext(extension), Some(FileType::Mpeg));

source

pub fn from_path(path: P) -> Option<Self>
where P: AsRef<Path>,

Attempts to determine a FileType from a path

§Examples

use lofty::FileType;
use std::path::Path;

let path = Path::new("path/to/my.mp3");
assert_eq!(FileType::from_path(path), Some(FileType::Mpeg));

source

pub fn from_buffer(buf: &[u8]) -> Option<Self>

Attempts to extract a FileType from a buffer

NOTES:

This is for use in Probe::guess_file_type, it is recommended to use it that way
This will not search past tags at the start of the buffer. For this behavior, use Probe::guess_file_type.

§Examples

use lofty::FileType;
use std::fs::File;
use std::io::Read;

let mut file = File::open(path_to_opus)?;

let mut buf = [0; 50]; // Search the first 50 bytes of the file
file.read_exact(&mut buf)?;

assert_eq!(FileType::from_buffer(&buf), Some(FileType::Opus));