Enum AnimatedIcon 

#[non_exhaustive]
pub enum AnimatedIcon {
    Frames {
        frames: Vec<IconData>,
        frame_duration_ms: u32,
    },
    Transform {
        icon: IconData,
        animation: TransformAnimation,
    },
}

An animated icon, either frame-based or transform-based.

Frames carries pre-rendered frames with uniform timing (loops infinitely). Transform carries a single icon and a description of the motion.

Examples

use native_theme::{AnimatedIcon, IconData, TransformAnimation};

// Frame-based animation (e.g., sprite sheet)
let frames_anim = AnimatedIcon::Frames {
    frames: vec![
        IconData::Svg(b"<svg>frame1</svg>".to_vec()),
        IconData::Svg(b"<svg>frame2</svg>".to_vec()),
    ],
    frame_duration_ms: 83,
};

// Transform-based animation (e.g., spinning icon)
let spin_anim = AnimatedIcon::Transform {
    icon: IconData::Svg(b"<svg>spinner</svg>".to_vec()),
    animation: TransformAnimation::Spin { duration_ms: 1000 },
};

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.

Frames

A sequence of pre-rendered frames played at a fixed interval (loops infinitely).

Fields

frames: Vec<IconData>

The individual frames, each a complete icon image.

frame_duration_ms: u32

Duration of each frame in milliseconds.

Transform

A single icon with a continuous transform animation.

Fields

icon: IconData

The icon to animate.

animation: TransformAnimation

The transform to apply.

Implementations

impl AnimatedIcon

pub fn first_frame(&self) -> Option<&IconData>

Return a reference to the first displayable frame.

For Frames, returns the first element (or None if empty). For Transform, returns the underlying icon.

Examples

use native_theme::{AnimatedIcon, IconData, TransformAnimation};

let frames = AnimatedIcon::Frames {
    frames: vec![IconData::Svg(b"<svg>f1</svg>".to_vec())],
    frame_duration_ms: 83,
};
assert!(frames.first_frame().is_some());

let transform = AnimatedIcon::Transform {
    icon: IconData::Svg(b"<svg>spinner</svg>".to_vec()),
    animation: TransformAnimation::Spin { duration_ms: 1000 },
};
assert!(transform.first_frame().is_some());

Trait Implementations

impl Clone for AnimatedIcon

fn clone(&self) -> AnimatedIcon

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AnimatedIcon

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

Formats the value using the given formatter.

impl PartialEq for AnimatedIcon

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for AnimatedIcon

impl StructuralPartialEq for AnimatedIcon