Struct Overlay 

#[non_exhaustive]
pub struct Overlay {
    pub image: Option<Image>,
    pub animations: Vec<Animation>,
    /* private fields */
}

Overlay configuration.

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.

image: Option<Image>

Image overlay.

animations: Vec<Animation>

List of animations. The list should be chronological, without any time overlap.

Implementations

impl Overlay

pub fn new() -> Self

pub fn set_image<T>(self, v: T) -> Self

where T: Into<Image>,

Sets the value of image.

pub fn set_or_clear_image<T>(self, v: Option<T>) -> Self

where T: Into<Image>,

Sets or clears the value of image.

pub fn set_animations<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<Animation>,

Sets the value of animations.

Trait Implementations

impl Clone for Overlay

fn clone(&self) -> Overlay

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Overlay

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

Formats the value using the given formatter.

impl Default for Overlay

fn default() -> Overlay

Returns the “default value” for a type.

impl Message for Overlay

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Overlay

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