Struct web_sys::Animation

#[repr(transparent)]
pub struct Animation { /* fields omitted */ }

The Animation object

MDN Documentation

This API requires the following crate features to be activated: Animation

Methods

impl Animation

pub fn new() -> Result<Animation, JsValue>

The new Animation(..) constructor, creating a new instance of Animation

MDN Documentation

This API requires the following crate features to be activated: Animation

impl Animation

pub fn new_with_effect(
    effect: Option<&AnimationEffect>
) -> Result<Animation, JsValue>

The new Animation(..) constructor, creating a new instance of Animation

MDN Documentation

This API requires the following crate features to be activated: Animation, AnimationEffect

impl Animation

pub fn new_with_effect_and_timeline(
    effect: Option<&AnimationEffect>,
    timeline: Option<&AnimationTimeline>
) -> Result<Animation, JsValue>

The new Animation(..) constructor, creating a new instance of Animation

MDN Documentation

This API requires the following crate features to be activated: Animation, AnimationEffect, AnimationTimeline

impl Animation

pub fn cancel(&self)

The cancel() method

MDN Documentation

This API requires the following crate features to be activated: Animation

impl Animation

pub fn finish(&self) -> Result<(), JsValue>

The finish() method

MDN Documentation

This API requires the following crate features to be activated: Animation

impl Animation

pub fn pause(&self) -> Result<(), JsValue>

The pause() method

MDN Documentation

This API requires the following crate features to be activated: Animation

impl Animation

pub fn play(&self) -> Result<(), JsValue>

The play() method

MDN Documentation

This API requires the following crate features to be activated: Animation

impl Animation

pub fn reverse(&self) -> Result<(), JsValue>

The reverse() method

MDN Documentation

This API requires the following crate features to be activated: Animation

impl Animation

pub fn update_playback_rate(&self, playback_rate: f64)

The updatePlaybackRate() method

MDN Documentation

This API requires the following crate features to be activated: Animation

impl Animation

pub fn id(&self) -> String

The id getter

MDN Documentation

This API requires the following crate features to be activated: Animation

impl Animation

pub fn set_id(&self, id: &str)

The id setter

MDN Documentation

This API requires the following crate features to be activated: Animation

impl Animation

pub fn effect(&self) -> Option<AnimationEffect>

The effect getter

MDN Documentation

This API requires the following crate features to be activated: Animation, AnimationEffect

impl Animation

pub fn set_effect(&self, effect: Option<&AnimationEffect>)

The effect setter

MDN Documentation

This API requires the following crate features to be activated: Animation, AnimationEffect

impl Animation

pub fn timeline(&self) -> Option<AnimationTimeline>

The timeline getter

MDN Documentation

This API requires the following crate features to be activated: Animation, AnimationTimeline

impl Animation

pub fn set_timeline(&self, timeline: Option<&AnimationTimeline>)

The timeline setter

MDN Documentation

This API requires the following crate features to be activated: Animation, AnimationTimeline

impl Animation

pub fn start_time(&self) -> Option<f64>

The startTime getter

MDN Documentation

This API requires the following crate features to be activated: Animation

impl Animation

pub fn set_start_time(&self, start_time: Option<f64>)

The startTime setter

MDN Documentation

This API requires the following crate features to be activated: Animation

impl Animation

pub fn current_time(&self) -> Option<f64>

The currentTime getter

MDN Documentation

This API requires the following crate features to be activated: Animation

impl Animation

pub fn set_current_time(&self, current_time: Option<f64>)

The currentTime setter

MDN Documentation

This API requires the following crate features to be activated: Animation

impl Animation

pub fn playback_rate(&self) -> f64

The playbackRate getter

MDN Documentation

This API requires the following crate features to be activated: Animation

impl Animation

pub fn set_playback_rate(&self, playback_rate: f64)

The playbackRate setter

MDN Documentation

This API requires the following crate features to be activated: Animation

impl Animation

pub fn play_state(&self) -> AnimationPlayState

The playState getter

MDN Documentation

This API requires the following crate features to be activated: Animation, AnimationPlayState

impl Animation

pub fn pending(&self) -> bool

The pending getter

MDN Documentation

This API requires the following crate features to be activated: Animation

impl Animation

pub fn ready(&self) -> Result<Promise, JsValue>

The ready getter

MDN Documentation

This API requires the following crate features to be activated: Animation

impl Animation

pub fn finished(&self) -> Result<Promise, JsValue>

The finished getter

MDN Documentation

This API requires the following crate features to be activated: Animation

impl Animation

pub fn onfinish(&self) -> Option<Function>

The onfinish getter

MDN Documentation

This API requires the following crate features to be activated: Animation

impl Animation

pub fn set_onfinish(&self, onfinish: Option<&Function>)

The onfinish setter

MDN Documentation

This API requires the following crate features to be activated: Animation

impl Animation

pub fn oncancel(&self) -> Option<Function>

The oncancel getter

MDN Documentation

This API requires the following crate features to be activated: Animation

impl Animation

pub fn set_oncancel(&self, oncancel: Option<&Function>)

The oncancel setter

MDN Documentation

This API requires the following crate features to be activated: Animation

Methods from Deref<Target = EventTarget>

pub fn add_event_listener_with_callback(
    &self,
    type_: &str,
    listener: &Function
) -> Result<(), JsValue>

The addEventListener() method

MDN Documentation

This API requires the following crate features to be activated: EventTarget

pub fn add_event_listener_with_event_listener(
    &self,
    type_: &str,
    listener: &EventListener
) -> Result<(), JsValue>

The addEventListener() method

MDN Documentation

This API requires the following crate features to be activated: EventListener, EventTarget

pub fn add_event_listener_with_callback_and_add_event_listener_options(
    &self,
    type_: &str,
    listener: &Function,
    options: &AddEventListenerOptions
) -> Result<(), JsValue>

The addEventListener() method

MDN Documentation

This API requires the following crate features to be activated: AddEventListenerOptions, EventTarget

pub fn add_event_listener_with_event_listener_and_add_event_listener_options(
    &self,
    type_: &str,
    listener: &EventListener,
    options: &AddEventListenerOptions
) -> Result<(), JsValue>

The addEventListener() method

MDN Documentation

This API requires the following crate features to be activated: AddEventListenerOptions, EventListener, EventTarget

pub fn add_event_listener_with_callback_and_bool(
    &self,
    type_: &str,
    listener: &Function,
    options: bool
) -> Result<(), JsValue>

The addEventListener() method

MDN Documentation

This API requires the following crate features to be activated: EventTarget

pub fn add_event_listener_with_event_listener_and_bool(
    &self,
    type_: &str,
    listener: &EventListener,
    options: bool
) -> Result<(), JsValue>

The addEventListener() method

MDN Documentation

This API requires the following crate features to be activated: EventListener, EventTarget

pub fn add_event_listener_with_callback_and_add_event_listener_options_and_wants_untrusted(
    &self,
    type_: &str,
    listener: &Function,
    options: &AddEventListenerOptions,
    wants_untrusted: Option<bool>
) -> Result<(), JsValue>

The addEventListener() method

MDN Documentation

This API requires the following crate features to be activated: AddEventListenerOptions, EventTarget

pub fn add_event_listener_with_event_listener_and_add_event_listener_options_and_wants_untrusted(
    &self,
    type_: &str,
    listener: &EventListener,
    options: &AddEventListenerOptions,
    wants_untrusted: Option<bool>
) -> Result<(), JsValue>

The addEventListener() method

MDN Documentation

This API requires the following crate features to be activated: AddEventListenerOptions, EventListener, EventTarget

pub fn add_event_listener_with_callback_and_bool_and_wants_untrusted(
    &self,
    type_: &str,
    listener: &Function,
    options: bool,
    wants_untrusted: Option<bool>
) -> Result<(), JsValue>

The addEventListener() method

MDN Documentation

This API requires the following crate features to be activated: EventTarget

pub fn add_event_listener_with_event_listener_and_bool_and_wants_untrusted(
    &self,
    type_: &str,
    listener: &EventListener,
    options: bool,
    wants_untrusted: Option<bool>
) -> Result<(), JsValue>

The addEventListener() method

MDN Documentation

This API requires the following crate features to be activated: EventListener, EventTarget

pub fn dispatch_event(&self, event: &Event) -> Result<bool, JsValue>

The dispatchEvent() method

MDN Documentation

This API requires the following crate features to be activated: Event, EventTarget

pub fn remove_event_listener_with_callback(
    &self,
    type_: &str,
    listener: &Function
) -> Result<(), JsValue>

The removeEventListener() method

MDN Documentation

This API requires the following crate features to be activated: EventTarget

pub fn remove_event_listener_with_event_listener(
    &self,
    type_: &str,
    listener: &EventListener
) -> Result<(), JsValue>

The removeEventListener() method

MDN Documentation

This API requires the following crate features to be activated: EventListener, EventTarget

pub fn remove_event_listener_with_callback_and_event_listener_options(
    &self,
    type_: &str,
    listener: &Function,
    options: &EventListenerOptions
) -> Result<(), JsValue>

The removeEventListener() method

MDN Documentation

This API requires the following crate features to be activated: EventListenerOptions, EventTarget

pub fn remove_event_listener_with_event_listener_and_event_listener_options(
    &self,
    type_: &str,
    listener: &EventListener,
    options: &EventListenerOptions
) -> Result<(), JsValue>

The removeEventListener() method

MDN Documentation

This API requires the following crate features to be activated: EventListener, EventListenerOptions, EventTarget

pub fn remove_event_listener_with_callback_and_bool(
    &self,
    type_: &str,
    listener: &Function,
    options: bool
) -> Result<(), JsValue>

The removeEventListener() method

MDN Documentation

This API requires the following crate features to be activated: EventTarget

pub fn remove_event_listener_with_event_listener_and_bool(
    &self,
    type_: &str,
    listener: &EventListener,
    options: bool
) -> Result<(), JsValue>

The removeEventListener() method

MDN Documentation

This API requires the following crate features to be activated: EventListener, EventTarget

Trait Implementations

impl Clone for Animation

fn clone(&self) -> Animation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl AsRef<JsValue> for Animation

fn as_ref(&self) -> &JsValue

Performs the conversion.

impl AsRef<Animation> for Animation

fn as_ref(&self) -> &Animation

Performs the conversion.

impl AsRef<EventTarget> for Animation

fn as_ref(&self) -> &EventTarget

Performs the conversion.

impl AsRef<Object> for Animation

fn as_ref(&self) -> &Object

Performs the conversion.

impl AsRef<Animation> for CssAnimation

fn as_ref(&self) -> &Animation

Performs the conversion.

impl AsRef<Animation> for CssTransition

fn as_ref(&self) -> &Animation

Performs the conversion.

impl From<JsValue> for Animation

fn from(obj: JsValue) -> Animation

Performs the conversion.

impl From<Animation> for JsValue

fn from(obj: Animation) -> JsValue

Performs the conversion.

impl From<Animation> for EventTarget

fn from(obj: Animation) -> EventTarget

Performs the conversion.

impl From<Animation> for Object

fn from(obj: Animation) -> Object

Performs the conversion.

impl From<CssAnimation> for Animation

fn from(obj: CssAnimation) -> Animation

Performs the conversion.

impl From<CssTransition> for Animation

fn from(obj: CssTransition) -> Animation

Performs the conversion.

impl Deref for Animation

type Target = EventTarget

The resulting type after dereferencing.

fn deref(&self) -> &EventTarget

Dereferences the value.

impl Debug for Animation

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

Formats the value using the given formatter.

impl JsCast for Animation

fn instanceof(val: &JsValue) -> bool

Performs a dynamic instanceof check to see whether the JsValue provided is an instance of this type.

fn unchecked_from_js(val: JsValue) -> Self

Performs a zero-cost unchecked conversion from a JsValue into an instance of Self

fn unchecked_from_js_ref(val: &JsValue) -> &Self

Performs a zero-cost unchecked conversion from a &JsValue into an instance of &Self.

fn has_type<T>(&self) -> bool where
    T: JsCast, 

Test whether this JS value has a type T.

fn dyn_into<T>(self) -> Result<T, Self> where
    T: JsCast, 

Performs a dynamic cast (checked at runtime) of this value into the target type T.

fn dyn_ref<T>(&self) -> Option<&T> where
    T: JsCast, 

Performs a dynamic cast (checked at runtime) of this value into the target type T.

fn unchecked_into<T>(self) -> T where
    T: JsCast, 

Performs a zero-cost unchecked cast into the specified type.

fn unchecked_ref<T>(&self) -> &T where
    T: JsCast, 

Performs a zero-cost unchecked cast into a reference to the specified type.

fn is_instance_of<T>(&self) -> bool where
    T: JsCast, 

Test whether this JS value is an instance of the type T.

fn is_type_of(val: &JsValue) -> bool

Performs a dynamic check to see whether the JsValue provided is a value of this type.

impl IntoWasmAbi for Animation

type Abi = <JsValue as IntoWasmAbi>::Abi

The wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self, extra: &mut dyn Stack) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl<'a> IntoWasmAbi for &'a Animation

type Abi = <&'a JsValue as IntoWasmAbi>::Abi

The wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self, extra: &mut dyn Stack) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl RefFromWasmAbi for Animation

type Abi = <JsValue as RefFromWasmAbi>::Abi

The wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<Animation>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don't persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi, extra: &mut dyn Stack) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl WasmDescribe for Animation

fn describe()

impl FromWasmAbi for Animation

type Abi = <JsValue as FromWasmAbi>::Abi

The wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: Self::Abi, extra: &mut dyn Stack) -> Self

Recover a Self from Self::Abi.

impl OptionFromWasmAbi for Animation

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a "none" instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for Animation

fn none() -> Self::Abi

Returns an ABI instance indicating "none", which JS will interpret as the None branch of this option.

impl<'a> OptionIntoWasmAbi for &'a Animation

fn none() -> Self::Abi

Returns an ABI instance indicating "none", which JS will interpret as the None branch of this option.