Struct web_sys::Animation

source ·
pub struct Animation { /* private fields */ }
Expand description

The Animation class.

MDN Documentation

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

Implementations§

source§

impl Animation

source

pub fn id(&self) -> String

Getter for the id field of this object.

MDN Documentation

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

source§

impl Animation

source

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

Setter for the id field of this object.

MDN Documentation

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

source§

impl Animation

source

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

Getter for the effect field of this object.

MDN Documentation

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

source§

impl Animation

source

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

Setter for the effect field of this object.

MDN Documentation

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

source§

impl Animation

source

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

Getter for the timeline field of this object.

MDN Documentation

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

source§

impl Animation

source

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

Setter for the timeline field of this object.

MDN Documentation

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

source§

impl Animation

source

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

Getter for the startTime field of this object.

MDN Documentation

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

source§

impl Animation

source

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

Setter for the startTime field of this object.

MDN Documentation

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

source§

impl Animation

source

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

Getter for the currentTime field of this object.

MDN Documentation

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

source§

impl Animation

source

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

Setter for the currentTime field of this object.

MDN Documentation

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

source§

impl Animation

source

pub fn playback_rate(&self) -> f64

Getter for the playbackRate field of this object.

MDN Documentation

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

source§

impl Animation

source

pub fn set_playback_rate(&self, value: f64)

Setter for the playbackRate field of this object.

MDN Documentation

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

source§

impl Animation

source

pub fn play_state(&self) -> AnimationPlayState

Getter for the playState field of this object.

MDN Documentation

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

source§

impl Animation

source

pub fn pending(&self) -> bool

Getter for the pending field of this object.

MDN Documentation

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

source§

impl Animation

source

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

Getter for the ready field of this object.

MDN Documentation

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

source§

impl Animation

source

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

Getter for the finished field of this object.

MDN Documentation

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

source§

impl Animation

source

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

Getter for the onfinish field of this object.

MDN Documentation

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

source§

impl Animation

source

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

Setter for the onfinish field of this object.

MDN Documentation

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

source§

impl Animation

source

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

Getter for the oncancel field of this object.

MDN Documentation

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

source§

impl Animation

source

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

Setter for the oncancel field of this object.

MDN Documentation

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

source§

impl Animation

source

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

source§

impl Animation

source

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

source§

impl Animation

source

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

source§

impl Animation

source

pub fn cancel(&self)

The cancel() method.

MDN Documentation

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

source§

impl Animation

source

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

The finish() method.

MDN Documentation

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

source§

impl Animation

source

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

The pause() method.

MDN Documentation

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

source§

impl Animation

source

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

The play() method.

MDN Documentation

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

source§

impl Animation

source

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

The reverse() method.

MDN Documentation

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

source§

impl Animation

source

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

Methods from Deref<Target = EventTarget>§

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

Methods from Deref<Target = Object>§

source

pub fn constructor(&self) -> Function

The constructor property returns a reference to the Object constructor function that created the instance object.

MDN documentation

source

pub fn has_own_property(&self, property: &JsValue) -> bool

The hasOwnProperty() method returns a boolean indicating whether the object has the specified property as its own property (as opposed to inheriting it).

MDN documentation

source

pub fn is_prototype_of(&self, value: &JsValue) -> bool

The isPrototypeOf() method checks if an object exists in another object’s prototype chain.

MDN documentation

source

pub fn property_is_enumerable(&self, property: &JsValue) -> bool

The propertyIsEnumerable() method returns a Boolean indicating whether the specified property is enumerable.

MDN documentation

source

pub fn to_locale_string(&self) -> JsString

The toLocaleString() method returns a string representing the object. This method is meant to be overridden by derived objects for locale-specific purposes.

MDN documentation

source

pub fn to_string(&self) -> JsString

The toString() method returns a string representing the object.

MDN documentation

source

pub fn value_of(&self) -> Object

The valueOf() method returns the primitive value of the specified object.

MDN documentation

Methods from Deref<Target = JsValue>§

source

pub const NULL: JsValue = _

source

pub const UNDEFINED: JsValue = _

source

pub const TRUE: JsValue = _

source

pub const FALSE: JsValue = _

source

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

Returns the f64 value of this JS value if it’s an instance of a number.

If this JS value is not an instance of a number then this returns None.

source

pub fn is_string(&self) -> bool

Tests whether this JS value is a JS string.

source

pub fn as_string(&self) -> Option<String>

If this JS value is a string value, this function copies the JS string value into wasm linear memory, encoded as UTF-8, and returns it as a Rust String.

To avoid the copying and re-encoding, consider the JsString::try_from() function from js-sys instead.

If this JS value is not an instance of a string or if it’s not valid utf-8 then this returns None.

UTF-16 vs UTF-8

JavaScript strings in general are encoded as UTF-16, but Rust strings are encoded as UTF-8. This can cause the Rust string to look a bit different than the JS string sometimes. For more details see the documentation about the str type which contains a few caveats about the encodings.

source

pub fn as_bool(&self) -> Option<bool>

Returns the bool value of this JS value if it’s an instance of a boolean.

If this JS value is not an instance of a boolean then this returns None.

source

pub fn is_null(&self) -> bool

Tests whether this JS value is null

source

pub fn is_undefined(&self) -> bool

Tests whether this JS value is undefined

source

pub fn is_symbol(&self) -> bool

Tests whether the type of this JS value is symbol

source

pub fn is_object(&self) -> bool

Tests whether typeof self == "object" && self !== null.

source

pub fn is_array(&self) -> bool

Tests whether this JS value is an instance of Array.

source

pub fn is_function(&self) -> bool

Tests whether the type of this JS value is function.

source

pub fn is_bigint(&self) -> bool

Tests whether the type of this JS value is bigint.

source

pub fn js_typeof(&self) -> JsValue

Applies the unary typeof JS operator on a JsValue.

MDN documentation

source

pub fn js_in(&self, obj: &JsValue) -> bool

Applies the binary in JS operator on the two JsValues.

MDN documentation

source

pub fn is_truthy(&self) -> bool

Tests whether the value is “truthy”.

source

pub fn is_falsy(&self) -> bool

Tests whether the value is “falsy”.

source

pub fn loose_eq(&self, other: &JsValue) -> bool

Compare two JsValues for equality, using the == operator in JS.

MDN documentation

source

pub fn bit_not(&self) -> JsValue

Applies the unary ~ JS operator on a JsValue.

MDN documentation

source

pub fn unsigned_shr(&self, rhs: &JsValue) -> u32

Applies the binary >>> JS operator on the two JsValues.

MDN documentation

source

pub fn checked_div(&self, rhs: &JsValue) -> JsValue

Applies the binary / JS operator on two JsValues, catching and returning any RangeError thrown.

MDN documentation

source

pub fn pow(&self, rhs: &JsValue) -> JsValue

Applies the binary ** JS operator on the two JsValues.

MDN documentation

source

pub fn lt(&self, other: &JsValue) -> bool

Applies the binary < JS operator on the two JsValues.

MDN documentation

source

pub fn le(&self, other: &JsValue) -> bool

Applies the binary <= JS operator on the two JsValues.

MDN documentation

source

pub fn ge(&self, other: &JsValue) -> bool

Applies the binary >= JS operator on the two JsValues.

MDN documentation

source

pub fn gt(&self, other: &JsValue) -> bool

Applies the binary > JS operator on the two JsValues.

MDN documentation

source

pub fn unchecked_into_f64(&self) -> f64

Applies the unary + JS operator on a JsValue. Can throw.

MDN documentation

Trait Implementations§

source§

impl AsRef<Animation> for Animation

source§

fn as_ref(&self) -> &Animation

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl AsRef<Animation> for CssAnimation

source§

fn as_ref(&self) -> &Animation

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl AsRef<Animation> for CssTransition

source§

fn as_ref(&self) -> &Animation

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl AsRef<EventTarget> for Animation

source§

fn as_ref(&self) -> &EventTarget

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl AsRef<JsValue> for Animation

source§

fn as_ref(&self) -> &JsValue

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl AsRef<Object> for Animation

source§

fn as_ref(&self) -> &Object

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl Clone for Animation

source§

fn clone(&self) -> Animation

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Animation

source§

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

Formats the value using the given formatter. Read more
source§

impl Deref for Animation

§

type Target = EventTarget

The resulting type after dereferencing.
source§

fn deref(&self) -> &EventTarget

Dereferences the value.
source§

impl From<Animation> for EventTarget

source§

fn from(obj: Animation) -> EventTarget

Converts to this type from the input type.
source§

impl From<Animation> for JsValue

source§

fn from(obj: Animation) -> JsValue

Converts to this type from the input type.
source§

impl From<Animation> for Object

source§

fn from(obj: Animation) -> Object

Converts to this type from the input type.
source§

impl From<CssAnimation> for Animation

source§

fn from(obj: CssAnimation) -> Animation

Converts to this type from the input type.
source§

impl From<CssTransition> for Animation

source§

fn from(obj: CssTransition) -> Animation

Converts to this type from the input type.
source§

impl From<JsValue> for Animation

source§

fn from(obj: JsValue) -> Animation

Converts to this type from the input type.
source§

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.
source§

unsafe fn from_abi(js: Self::Abi) -> Self

Recover a Self from Self::Abi. Read more
source§

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.
source§

fn into_abi(self) -> Self::Abi

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

impl IntoWasmAbi for Animation

§

type Abi = <JsValue as IntoWasmAbi>::Abi

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

fn into_abi(self) -> Self::Abi

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

impl JsCast for Animation

source§

fn instanceof(val: &JsValue) -> bool

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

fn unchecked_from_js(val: JsValue) -> Self

Performs a zero-cost unchecked conversion from a JsValue into an instance of Self Read more
source§

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

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

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

Test whether this JS value has a type T. Read more
source§

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. Read more
source§

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. Read more
source§

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

Performs a zero-cost unchecked cast into the specified type. Read more
source§

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

Performs a zero-cost unchecked cast into a reference to the specified type. Read more
source§

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

Test whether this JS value is an instance of the type T. Read more
source§

fn is_type_of(val: &JsValue) -> bool

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

impl LongRefFromWasmAbi for Animation

§

type Abi = <JsValue as LongRefFromWasmAbi>::Abi

Same as RefFromWasmAbi::Abi
§

type Anchor = Animation

Same as RefFromWasmAbi::Anchor
source§

unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi
source§

impl OptionFromWasmAbi for Animation

source§

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.
source§

impl<'a> OptionIntoWasmAbi for &'a Animation

source§

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option. Read more
source§

impl OptionIntoWasmAbi for Animation

source§

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option. Read more
source§

impl PartialEq for Animation

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

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.
source§

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi. Read more
source§

impl WasmDescribe for Animation

source§

impl Eq for Animation

source§

impl StructuralEq for Animation

source§

impl StructuralPartialEq for Animation

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ReturnWasmAbi for Twhere T: IntoWasmAbi,

§

type Abi = <T as IntoWasmAbi>::Abi

Same as IntoWasmAbi::Abi
source§

fn return_abi(self) -> <T as ReturnWasmAbi>::Abi

Same as IntoWasmAbi::into_abi, except that it may throw and never return in the case of Err.
source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> VectorFromWasmAbi for Twhere T: JsObject,

source§

impl<T> VectorIntoWasmAbi for Twhere T: JsObject,