Skip to main content

SubtitleCodec

Enum SubtitleCodec 

Source
pub enum SubtitleCodec {
    Srt,
    Ass,
    Dvb,
    Hdmv,
    Webvtt,
    Other(String),
}
Expand description

Subtitle codec identifier.

This enum represents common subtitle codecs used in media files. It covers text-based and bitmap-based formats while remaining extensible via the Other variant.

Note: No Copy or Default derive because Other(String) is not Copy.

Variants§

§

Srt

SubRip / SRT — text-based timed subtitles

§

Ass

ASS/SSA (Advanced SubStation Alpha) — styled text subtitles

§

Dvb

DVB bitmap subtitles (digital broadcast)

§

Hdmv

HDMV/PGS — Blu-ray bitmap subtitles

§

Webvtt

WebVTT — web-standard text subtitles

§

Other(String)

Unrecognized codec; raw codec name stored for transparency

Implementations§

Source§

impl SubtitleCodec

Source

pub fn name(&self) -> &str

Returns the codec name as a short string.

§Examples
use ff_format::codec::SubtitleCodec;

assert_eq!(SubtitleCodec::Srt.name(), "srt");
assert_eq!(SubtitleCodec::Ass.name(), "ass");
Source

pub fn display_name(&self) -> &str

Returns the human-readable display name for the codec.

§Examples
use ff_format::codec::SubtitleCodec;

assert_eq!(SubtitleCodec::Srt.display_name(), "SubRip (SRT)");
assert_eq!(SubtitleCodec::Hdmv.display_name(), "HDMV/PGS");
Source

pub fn is_text_based(&self) -> bool

Returns true if this is a text-based subtitle codec.

§Examples
use ff_format::codec::SubtitleCodec;

assert!(SubtitleCodec::Srt.is_text_based());
assert!(SubtitleCodec::Ass.is_text_based());
assert!(!SubtitleCodec::Dvb.is_text_based());
Source

pub fn is_bitmap_based(&self) -> bool

Returns true if this is a bitmap-based subtitle codec.

§Examples
use ff_format::codec::SubtitleCodec;

assert!(SubtitleCodec::Dvb.is_bitmap_based());
assert!(SubtitleCodec::Hdmv.is_bitmap_based());
assert!(!SubtitleCodec::Srt.is_bitmap_based());
Source

pub fn is_unknown(&self) -> bool

Returns true if the codec is unrecognized.

§Examples
use ff_format::codec::SubtitleCodec;

assert!(SubtitleCodec::Other("dvd_subtitle".to_string()).is_unknown());
assert!(!SubtitleCodec::Srt.is_unknown());

Trait Implementations§

Source§

impl Clone for SubtitleCodec

Source§

fn clone(&self) -> SubtitleCodec

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SubtitleCodec

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for SubtitleCodec

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for SubtitleCodec

Source§

impl Hash for SubtitleCodec

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for SubtitleCodec

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for SubtitleCodec

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.