Skip to main content

ChapterInfo

Struct ChapterInfo 

Source
pub struct ChapterInfo { /* private fields */ }
Expand description

Information about a chapter within a media file.

Chapters are discrete, named segments within a container (e.g., a chapter in an audiobook or a scene in a movie). Each chapter has a start and end time, and optionally a title and other metadata tags.

§Construction

Use ChapterInfo::builder() for fluent construction:

use ff_format::chapter::ChapterInfo;
use std::time::Duration;

let chapter = ChapterInfo::builder()
    .id(0)
    .title("Intro")
    .start(Duration::ZERO)
    .end(Duration::from_secs(30))
    .build();

Implementations§

Source§

impl ChapterInfo

Source

pub fn builder() -> ChapterInfoBuilder

Creates a new builder for constructing ChapterInfo.

Source

pub fn id(&self) -> i64

Returns the chapter ID.

Source

pub fn title(&self) -> Option<&str>

Returns the chapter title, if available.

Source

pub fn start(&self) -> Duration

Returns the chapter start time.

Source

pub fn end(&self) -> Duration

Returns the chapter end time.

Source

pub fn time_base(&self) -> Option<Rational>

Returns the chapter time base, if available.

Source

pub fn metadata(&self) -> Option<&HashMap<String, String>>

Returns the chapter metadata tags (excluding “title”), if any.

Source

pub fn has_title(&self) -> bool

Returns true if the chapter has a title.

Source

pub fn duration(&self) -> Duration

Returns the chapter duration (end − start).

Uses saturating subtraction so that malformed chapters where end < start return Duration::ZERO instead of panicking.

Trait Implementations§

Source§

impl Clone for ChapterInfo

Source§

fn clone(&self) -> ChapterInfo

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ChapterInfo

Source§

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

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

impl Default for ChapterInfo

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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, 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.