Struct Catalog 

#[non_exhaustive]
pub struct Catalog {
    pub generated_at: Option<u64>,
    pub is_complete: bool,
    pub tracks: Vec<Track>,
}

A snapshot of an MSF catalog: the tracks currently in a broadcast.

This is a version-agnostic view. The on-wire details (the catalog version field, and draft-01’s initDataList/initRef indirection for initialization data) are handled during (de)serialization, so callers only ever see resolved tracks with inline Track::init_data. Parsing accepts both draft-00 and draft-01 catalogs; serializing always emits the newest draft.

Marked #[non_exhaustive] because the MSF drafts continue to grow optional root fields. External callers build a catalog with Catalog::new or Catalog::default and then assign whichever optional fields they need.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

generated_at: Option<u64>

Catalog generation time as Unix epoch milliseconds.

is_complete: bool

Whether the broadcast has finished and no more tracks will appear.

tracks: Vec<Track>

The tracks in this catalog snapshot.

Implementations

impl Catalog

pub fn new(tracks: Vec<Track>) -> Self

Construct a catalog with tracks and no root-level optional fields.

pub fn to_json(&self) -> Result<String, Error>

Serialize the MSF catalog to a JSON string.

pub fn from_str(s: &str) -> Result<Self, Error>

Deserialize an MSF catalog from a JSON string.

Trait Implementations

impl Clone for Catalog

fn clone(&self) -> Catalog

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Catalog

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

Formats the value using the given formatter.

impl Default for Catalog

fn default() -> Catalog

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Catalog

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl PartialEq for Catalog

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Catalog

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Catalog