Enum ProviderSource 

#[non_exhaustive]
pub enum ProviderSource {
    Svg,
    AnimatedImage,
    Lottie {
        animation: Option<String>,
    },
    ImageSequence {
        frames: Vec<Option<String>>,
        frame_rate: FrameRate,
        start_number: u64,
        missing: MissingFrames,
        primaries: Option<LinearPrimaries>,
    },
    Exr {
        primaries: Option<LinearPrimaries>,
    },
    Latex {
        latex: String,
        font_size: f32,
        color: Rgba,
        display: bool,
    },
    Pdf {
        page: u32,
        background: Rgba,
    },
}

A source whose media an extension provider supplies, not the host’s video and image decoders.

A host picks the provider by probing the bytes at import, never by file name, and records it here so every host opens the source the same way. The engine does not read it.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Svg

A static SVG document, rasterized at its shown size. The source’s kind is image.

AnimatedImage

A GIF, animated WebP, or APNG: one cycle of frames, each with its own duration. Repetition is the clip’s. The source’s kind is video.

Lottie

A Lottie animation (JSON file or dotLottie package), evaluated at its own frames. The source’s kind is video.

Fields

animation: Option<String>

The dotLottie animation shown, by ID. Absent means the package’s first; always absent for a Lottie JSON file.

ImageSequence

Still images played in order at a fixed rate. The source’s kind is video.

Fields

frames: Vec<Option<String>>

Each frame’s locator, in play order. null marks a missing number, allowed only when missing says how to show it.

frame_rate: FrameRate

The rate the frames play at.

start_number: u64

The number of the first frame, as its file was numbered.

missing: MissingFrames

How a missing frame is shown.

primaries: Option<LinearPrimaries>

The primaries of OpenEXR frames’ linear RGB, overriding the first frame’s chromaticities. Only for OpenEXR frames.

Exr

A still OpenEXR image: linear-light RGB(A), read at half precision. The source’s kind is image.

Fields

primaries: Option<LinearPrimaries>

The primaries of its linear RGB, overriding the file’s chromaticities (BT.709 when the file has none, as OpenEXR defines).

Latex

A LaTeX math formula typeset with the bundled STIX Two Math font. The source’s kind is image, and it has no locator or fingerprint since it reads no file. A formula that uses a character the font lacks, such as Hangul in \text, does not open.

Fields

latex: String

Math-mode LaTeX without $ delimiters. Non-empty, at most MAX_LATEX_BYTES bytes.

font_size: f32

Pixels per em, above 0 and at most MAX_LATEX_FONT_SIZE.

color: Rgba

The ink where the formula sets no \color of its own. White when absent.

display: bool

Display style, with large operators and limits above and below, or text style when false. Display when absent.

Pdf

One page of a PDF document. The source’s kind is image.

Fields

page: u32

The page shown, counted from 1, at most MAX_PDF_PAGES. The first when absent.

background: Rgba

Painted under the page, which is itself transparent. White paper when absent.

Implementations

impl ProviderSource

pub const fn kind(&self) -> MediaKind

The kind of source the provider’s media is.

pub const fn reads_file(&self) -> bool

Whether the provider reads a file of the source’s own. One that does not, such as LaTeX, holds its content in these settings, so its source has no locator or fingerprint.

pub fn is_valid(&self) -> bool

Whether the settings are coherent and within the limits each variant’s fields state.

Trait Implementations

impl Clone for ProviderSource

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProviderSource

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProviderSource

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ProviderSource

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ProviderSource

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ProviderSource