Skip to main content

CompositionPlaylist

Struct CompositionPlaylist 

Source
pub struct CompositionPlaylist {
Show 20 fields pub namespace: CplNamespace, pub id: ImfUuid, pub annotation: Option<LanguageString>, pub issue_date: String, pub issuer: Option<LanguageString>, pub creator: Option<LanguageString>, pub content_originator: Option<LanguageString>, pub content_title: LanguageString, pub content_kind: ContentKindElement, pub content_version_list: Option<ContentVersionList>, pub essence_descriptor_list: Option<EssenceDescriptorList>, pub edit_rate: Option<EditRate>, pub total_running_time: Option<String>, pub locale_list: Option<LocaleList>, pub extension_properties: Option<ExtensionProperties>, pub composition_timecode: Option<CompositionTimecode>, pub has_signer: bool, pub has_signature: bool, pub source_xml: Option<String>, pub segment_list: SegmentList,
}
Expand description

Root CPL structure — defines a complete IMF composition.

§Spec-required vs Option<T> policy (FIX-7 audit)

The parser is intentionally lenient: every spec-required element that isn’t strictly necessary to construct a valid CompositionPlaylist is exposed as Option<T> (or via a default = "…" serde attribute). Missing-required-field violations are surfaced as catalogue diagnostics by the validator (validate_cpl) rather than as parse errors, so a caller can still inspect the parsed structure of a non-conformant CPL.

Field-by-field map against ST 2067-3 §6 / §7 (2013 / 2016 — the 2020 edition reuses the 2016 schema verbatim):

FieldTypeSpec status
idImfUuidrequired §6.1 — parse error if missing
annotationOption<…>optional §6.2
issue_dateStringrequired §6.3 — parse error if missing
issuerOption<…>optional §6.4
creatorOption<…>optional §6.5
content_originatorOption<…>optional §6.6
content_titleLanguageStringrequired §6.7 — parse error if missing
content_kindconcrete (default)required §6.8 — default_content_kind
content_version_listOption<…>optional §6.10
essence_descriptor_listOption<…>required per ST 2067-2 §6.1.5 —
parser-lenient; absence is reported by
validate_cpl as Error
edit_rateOption<…>required §6.13 — parser-lenient; absence
reported by validate_cpl
total_running_timeOption<String>optional §6.14
locale_listOption<…>optional §6.15
extension_propertiesOption<…>optional §6.16
composition_timecodeOption<…>optional §6.9
segment_listSegmentListrequired §6.17 — parse error if missing
has_signer/has_signatureboolreflect presence in raw XML (§8 signatures unparsed)
source_xmlOption<String>retained when parsed from XML; absent for JSON-deserialised

Five fields are spec-required but stored as Option<T> (with default on the serde side) to support the parser-lenient model: content_kind (defaults via default_content_kind), content_version_list, essence_descriptor_list, edit_rate, locale_list. The validator surfaces missing-required findings against the ST 2067-3 prose.

Fields§

§namespace: CplNamespace

The SMPTE spec version detected from the root xmlns of the CPL XML. Set after deserialization by parse_cpl().

§id: ImfUuid§annotation: Option<LanguageString>§issue_date: String§issuer: Option<LanguageString>§creator: Option<LanguageString>§content_originator: Option<LanguageString>§content_title: LanguageString§content_kind: ContentKindElement§content_version_list: Option<ContentVersionList>§essence_descriptor_list: Option<EssenceDescriptorList>§edit_rate: Option<EditRate>§total_running_time: Option<String>§locale_list: Option<LocaleList>§extension_properties: Option<ExtensionProperties>§composition_timecode: Option<CompositionTimecode>§has_signer: bool

Whether the original CPL XML contained a <Signer> element. Set by parse_cpl() from raw XML before namespace stripping.

§has_signature: bool

Whether the original CPL XML contained a <Signature> element. Set by parse_cpl() from raw XML before namespace stripping.

§source_xml: Option<String>

The raw CPL XML as parsed, retained so callers running through validate_cpl(&cpl) can transparently invoke the runtime-XSD validator (which needs the unparsed source). Set by parse_cpl(). None when the struct was built via JSON deserialization or manual construction.

§segment_list: SegmentList

Trait Implementations§

Source§

impl Debug for CompositionPlaylist

Source§

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

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

impl<'de> Deserialize<'de> for CompositionPlaylist

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for CompositionPlaylist

Source§

fn eq(&self, other: &CompositionPlaylist) -> 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 Serialize for CompositionPlaylist

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for CompositionPlaylist

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> Same for T

Source§

type Output = T

Should always be Self
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.