Enum Format 

#[non_exhaustive]
pub enum Format {
    Jpeg,
    Png,
    Webp,
    Pdf,
    Tiff,
    Gif,
    Heif,
    Avif,
    Docx,
    Xlsx,
    Pptx,
    Odt,
    Ods,
    Odp,
    Svg,
    Jxl,
    Flac,
    Wav,
    Mp3,
    Ogg,
    Opus,
    OggFlac,
    Mp4,
    M4a,
}

A format strypt has a handler for.

Variants (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.

Jpeg

JPEG, in a JFIF or EXIF container.

Png

PNG.

Webp

WebP, which is a RIFF container.

Pdf

PDF.

Tiff

TIFF, including the multi-page files scanners produce.

Gif

GIF, in either the 87a or the 89a spelling.

Heif

HEIF — .heic and .heif, the format an iPhone photograph arrives in.

Avif

AVIF: the same container as HEIF, carrying AV1 rather than HEVC.

Docx

A WordprocessingML document — .docx.

Xlsx

A SpreadsheetML workbook — .xlsx.

Pptx

A PresentationML presentation — .pptx.

Odt

An OpenDocument text document — .odt.

Ods

An OpenDocument spreadsheet — .ods.

Odp

An OpenDocument presentation — .odp.

Svg

SVG, which is XML text rather than a container of encoded pixels.

Jxl

JPEG XL, in either of its two spellings: a bare codestream or a BMFF container.

Flac

FLAC, in its native spelling — a fLaC marker and a list of metadata blocks.

Wav

WAV: a RIFF container of form type WAVE. RF64 and BW64 are a different container and are named separately in detect_unsupported.

Mp3

MP3: MPEG-1 Audio Layer III frames, with or without the tags glued to either end of them.

Ogg

Ogg Vorbis. One handler serves all three Ogg spellings; they are separate formats here because they are separate mappings with separate header packets (ADR-0041).

Opus

Opus, in its Ogg encapsulation (RFC 7845). The only encapsulation strypt handles.

OggFlac

FLAC carried in Ogg pages rather than in its native container.

Mp4

MP4: the ISO base media file format carrying tracks. .mp4 and .m4v.

M4a

M4A: the same container carrying audio only. .m4a and .m4b.

Implementations

impl Format

pub const fn id(self) -> &'static str

The stable lowercase identifier used in reports and JSON output.

Stable across releases: front-ends and downstream scripts key on it.

pub const fn conventional_extension(self) -> &'static str

The conventional extension for this format, without a leading dot.

Used when deriving a default output filename. Never used to detect anything.

Trait Implementations

impl Clone for Format

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Format

impl Debug for Format

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

Formats the value using the given formatter.

impl Display for Format

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

Formats the value using the given formatter.

impl Eq for Format

impl Hash for Format

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Format

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Format

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Format

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Format