Struct file_format::FileFormat

pub struct FileFormat { /* fields omitted */ }

A file format.

Implementations

impl FileFormat

pub fn from_bytes(bytes: &[u8]) -> FileFormat

Determines FileFormat from bytes.

If the FileFormat is not recognized, the default value will be returned.

Examples

Detects from the first bytes of a PNG file:

use file_format::FileFormat;

let format = FileFormat::from_bytes(b"\x89\x50\x4E\x47\x0D\x0A\x1A\x0A");
assert_eq!(format.media_type(), "image/png");
assert_eq!(format.extension(), "png");

Detects from a zeroed buffer:

use file_format::FileFormat;

let format = FileFormat::from_bytes(&[0; 1000]);
assert_eq!(format, FileFormat::default());
assert_eq!(format.media_type(), "application/octet-stream");
assert_eq!(format.extension(), "bin");

pub fn from_file<P: AsRef<Path>>(path: P) -> Result<FileFormat>

Determines FileFormat from a file.

Examples

use file_format::FileFormat;

let format = FileFormat::from_file("fixtures/video/sample.mkv")?;
assert_eq!(format.media_type(), "video/x-matroska");
assert_eq!(format.extension(), "mkv");

pub fn media_type(&self) -> &str

Returns the media type (formerly known as MIME type) of the FileFormat.

Examples

use file_format::FileFormat;

let format = FileFormat::from_file("fixtures/application/sample.zst")?;
assert_eq!(format.media_type(), "application/zstd");

pub fn extension(&self) -> &str

Returns the preferred extension of the FileFormat.

Examples

use file_format::FileFormat;

let format = FileFormat::from_file("fixtures/video/sample.wmv")?;
assert_eq!(format.extension(), "wmv");

Trait Implementations

impl Clone for FileFormat

fn clone(&self) -> FileFormat

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FileFormat

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

Formats the value using the given formatter.

impl Default for FileFormat

fn default() -> FileFormat

Returns the default FileFormat which corresponds to arbitrary binary data.

impl PartialEq<FileFormat> for FileFormat

fn eq(&self, other: &FileFormat) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &FileFormat) -> bool

This method tests for !=.

impl StructuralPartialEq for FileFormat