Skip to main content

Metadata

Struct Metadata 

Source
pub struct Metadata {
    pub title: Option<String>,
    pub author: Option<String>,
    pub subject: Option<String>,
    pub keywords: Vec<String>,
    pub creator: Option<String>,
    pub producer: Option<String>,
    pub created_at: Option<String>,
    pub modified_at: Option<String>,
    pub custom: BTreeMap<String, String>,
}
Expand description

Scene-level metadata. Carried through to exports when the target format supports it (PDF document info dict, MP4 meta box, etc).

producer and creator are intentionally distinct, mirroring PDF’s /Info dictionary:

  • creator — the tool that authored the source content (e.g. the NLE, drawing app, or word processor the user worked in).
  • producer — the tool that wrote the output file (this crate / oxideav exporter).

Fields§

§title: Option<String>§author: Option<String>§subject: Option<String>§keywords: Vec<String>§creator: Option<String>

Authoring application — the tool used to create the source content. Distinct from producer; PDF’s /Info dictionary has separate /Creator and /Producer keys for the same reason.

§producer: Option<String>

Producing tool name — the writer that emitted the output file.

§created_at: Option<String>

ISO-8601 string; not parsed here so exporters can pass it through unchanged.

§modified_at: Option<String>

ISO-8601 modification timestamp. Mirrors created_at; PDF /Info has both /CreationDate and /ModDate, mp4 mvhd has both creation_time and modification_time, etc.

§custom: BTreeMap<String, String>

Extensible per-format extras. Lets callers carry metadata the standard fields don’t cover: PDF /Info custom keys, Matroska ContentTrack tags, RDF properties, mp4 udta items not covered by the standard fields, ID3 frames, and so on. Keys are case-sensitive; uniqueness is the caller’s responsibility (the map enforces it).

Trait Implementations§

Source§

impl Clone for Metadata

Source§

fn clone(&self) -> Metadata

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 Metadata

Source§

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

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

impl Default for Metadata

Source§

fn default() -> Metadata

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.