Struct web_sys::UnderlyingSource
source · pub struct UnderlyingSource { /* private fields */ }
Expand description
The UnderlyingSource
dictionary.
This API requires the following crate features to be activated: UnderlyingSource
Implementations§
source§impl UnderlyingSource
impl UnderlyingSource
sourcepub fn get_auto_allocate_chunk_size(&self) -> Option<f64>
pub fn get_auto_allocate_chunk_size(&self) -> Option<f64>
Get the autoAllocateChunkSize
field of this object.
This API requires the following crate features to be activated: UnderlyingSource
source§impl UnderlyingSource
impl UnderlyingSource
sourcepub fn set_auto_allocate_chunk_size(&self, val: f64)
pub fn set_auto_allocate_chunk_size(&self, val: f64)
Change the autoAllocateChunkSize
field of this object.
This API requires the following crate features to be activated: UnderlyingSource
source§impl UnderlyingSource
impl UnderlyingSource
sourcepub fn get_cancel(&self) -> Option<Function>
pub fn get_cancel(&self) -> Option<Function>
Get the cancel
field of this object.
This API requires the following crate features to be activated: UnderlyingSource
source§impl UnderlyingSource
impl UnderlyingSource
sourcepub fn set_cancel(&self, val: &Function)
pub fn set_cancel(&self, val: &Function)
Change the cancel
field of this object.
This API requires the following crate features to be activated: UnderlyingSource
source§impl UnderlyingSource
impl UnderlyingSource
sourcepub fn get_type(&self) -> Option<ReadableStreamType>
pub fn get_type(&self) -> Option<ReadableStreamType>
Get the type
field of this object.
This API requires the following crate features to be activated: ReadableStreamType
, UnderlyingSource
source§impl UnderlyingSource
impl UnderlyingSource
sourcepub fn set_type(&self, val: ReadableStreamType)
pub fn set_type(&self, val: ReadableStreamType)
Change the type
field of this object.
This API requires the following crate features to be activated: ReadableStreamType
, UnderlyingSource
source§impl UnderlyingSource
impl UnderlyingSource
sourcepub fn new() -> Self
pub fn new() -> Self
Construct a new UnderlyingSource
.
This API requires the following crate features to be activated: UnderlyingSource
pub fn auto_allocate_chunk_size(&mut self, val: f64) -> &mut Self
set_auto_allocate_chunk_size()
instead.pub fn cancel(&mut self, val: &Function) -> &mut Self
set_cancel()
instead.pub fn pull(&mut self, val: &Function) -> &mut Self
set_pull()
instead.pub fn start(&mut self, val: &Function) -> &mut Self
set_start()
instead.pub fn type_(&mut self, val: ReadableStreamType) -> &mut Self
set_type()
instead.Methods from Deref<Target = Object>§
sourcepub fn constructor(&self) -> Function
pub fn constructor(&self) -> Function
The constructor property returns a reference to the Object
constructor
function that created the instance object.
sourcepub fn has_own_property(&self, property: &JsValue) -> bool
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).
sourcepub fn is_prototype_of(&self, value: &JsValue) -> bool
pub fn is_prototype_of(&self, value: &JsValue) -> bool
The isPrototypeOf()
method checks if an object exists in another
object’s prototype chain.
sourcepub fn property_is_enumerable(&self, property: &JsValue) -> bool
pub fn property_is_enumerable(&self, property: &JsValue) -> bool
The propertyIsEnumerable()
method returns a Boolean indicating
whether the specified property is enumerable.
sourcepub fn to_locale_string(&self) -> JsString
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.
sourcepub fn to_string(&self) -> JsString
pub fn to_string(&self) -> JsString
The toString()
method returns a string representing the object.
Methods from Deref<Target = JsValue>§
pub const NULL: JsValue = _
pub const UNDEFINED: JsValue = _
pub const TRUE: JsValue = _
pub const FALSE: JsValue = _
sourcepub fn as_f64(&self) -> Option<f64>
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
.
sourcepub fn as_string(&self) -> Option<String>
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.
sourcepub fn as_bool(&self) -> Option<bool>
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
.
sourcepub fn is_undefined(&self) -> bool
pub fn is_undefined(&self) -> bool
Tests whether this JS value is undefined
sourcepub fn is_function(&self) -> bool
pub fn is_function(&self) -> bool
Tests whether the type of this JS value is function
.
sourcepub fn js_in(&self, obj: &JsValue) -> bool
pub fn js_in(&self, obj: &JsValue) -> bool
Applies the binary in
JS operator on the two JsValue
s.
sourcepub fn loose_eq(&self, other: &JsValue) -> bool
pub fn loose_eq(&self, other: &JsValue) -> bool
Compare two JsValue
s for equality, using the ==
operator in JS.
sourcepub fn unsigned_shr(&self, rhs: &JsValue) -> u32
pub fn unsigned_shr(&self, rhs: &JsValue) -> u32
Applies the binary >>>
JS operator on the two JsValue
s.
sourcepub fn checked_div(&self, rhs: &JsValue) -> JsValue
pub fn checked_div(&self, rhs: &JsValue) -> JsValue
Applies the binary /
JS operator on two JsValue
s, catching and returning any RangeError
thrown.
sourcepub fn pow(&self, rhs: &JsValue) -> JsValue
pub fn pow(&self, rhs: &JsValue) -> JsValue
Applies the binary **
JS operator on the two JsValue
s.
sourcepub fn lt(&self, other: &JsValue) -> bool
pub fn lt(&self, other: &JsValue) -> bool
Applies the binary <
JS operator on the two JsValue
s.
sourcepub fn le(&self, other: &JsValue) -> bool
pub fn le(&self, other: &JsValue) -> bool
Applies the binary <=
JS operator on the two JsValue
s.
sourcepub fn ge(&self, other: &JsValue) -> bool
pub fn ge(&self, other: &JsValue) -> bool
Applies the binary >=
JS operator on the two JsValue
s.
sourcepub fn gt(&self, other: &JsValue) -> bool
pub fn gt(&self, other: &JsValue) -> bool
Applies the binary >
JS operator on the two JsValue
s.
sourcepub fn unchecked_into_f64(&self) -> f64
pub fn unchecked_into_f64(&self) -> f64
Applies the unary +
JS operator on a JsValue
. Can throw.
Trait Implementations§
source§impl AsRef<JsValue> for UnderlyingSource
impl AsRef<JsValue> for UnderlyingSource
source§impl AsRef<Object> for UnderlyingSource
impl AsRef<Object> for UnderlyingSource
source§impl AsRef<UnderlyingSource> for UnderlyingSource
impl AsRef<UnderlyingSource> for UnderlyingSource
source§fn as_ref(&self) -> &UnderlyingSource
fn as_ref(&self) -> &UnderlyingSource
source§impl Clone for UnderlyingSource
impl Clone for UnderlyingSource
source§fn clone(&self) -> UnderlyingSource
fn clone(&self) -> UnderlyingSource
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for UnderlyingSource
impl Debug for UnderlyingSource
source§impl Default for UnderlyingSource
impl Default for UnderlyingSource
source§impl Deref for UnderlyingSource
impl Deref for UnderlyingSource
source§impl From<JsValue> for UnderlyingSource
impl From<JsValue> for UnderlyingSource
source§fn from(obj: JsValue) -> UnderlyingSource
fn from(obj: JsValue) -> UnderlyingSource
source§impl From<UnderlyingSource> for JsValue
impl From<UnderlyingSource> for JsValue
source§fn from(obj: UnderlyingSource) -> JsValue
fn from(obj: UnderlyingSource) -> JsValue
source§impl From<UnderlyingSource> for Object
impl From<UnderlyingSource> for Object
source§fn from(obj: UnderlyingSource) -> Object
fn from(obj: UnderlyingSource) -> Object
source§impl FromWasmAbi for UnderlyingSource
impl FromWasmAbi for UnderlyingSource
source§impl<'a> IntoWasmAbi for &'a UnderlyingSource
impl<'a> IntoWasmAbi for &'a UnderlyingSource
source§impl IntoWasmAbi for UnderlyingSource
impl IntoWasmAbi for UnderlyingSource
source§impl JsCast for UnderlyingSource
impl JsCast for UnderlyingSource
source§fn instanceof(val: &JsValue) -> bool
fn instanceof(val: &JsValue) -> bool
instanceof
check to see whether the JsValue
provided is an instance of this type. Read moresource§fn unchecked_from_js(val: JsValue) -> Self
fn unchecked_from_js(val: JsValue) -> Self
source§fn unchecked_from_js_ref(val: &JsValue) -> &Self
fn unchecked_from_js_ref(val: &JsValue) -> &Self
source§fn has_type<T>(&self) -> boolwhere
T: JsCast,
fn has_type<T>(&self) -> boolwhere
T: JsCast,
T
. Read moresource§fn dyn_into<T>(self) -> Result<T, Self>where
T: JsCast,
fn dyn_into<T>(self) -> Result<T, Self>where
T: JsCast,
T
. Read moresource§fn dyn_ref<T>(&self) -> Option<&T>where
T: JsCast,
fn dyn_ref<T>(&self) -> Option<&T>where
T: JsCast,
T
. Read moresource§fn unchecked_into<T>(self) -> Twhere
T: JsCast,
fn unchecked_into<T>(self) -> Twhere
T: JsCast,
source§fn unchecked_ref<T>(&self) -> &Twhere
T: JsCast,
fn unchecked_ref<T>(&self) -> &Twhere
T: JsCast,
source§impl LongRefFromWasmAbi for UnderlyingSource
impl LongRefFromWasmAbi for UnderlyingSource
source§type Anchor = UnderlyingSource
type Anchor = UnderlyingSource
RefFromWasmAbi::Anchor
source§unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor
unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor
RefFromWasmAbi::ref_from_abi
source§impl OptionFromWasmAbi for UnderlyingSource
impl OptionFromWasmAbi for UnderlyingSource
source§impl<'a> OptionIntoWasmAbi for &'a UnderlyingSource
impl<'a> OptionIntoWasmAbi for &'a UnderlyingSource
source§impl OptionIntoWasmAbi for UnderlyingSource
impl OptionIntoWasmAbi for UnderlyingSource
source§impl PartialEq for UnderlyingSource
impl PartialEq for UnderlyingSource
source§impl RefFromWasmAbi for UnderlyingSource
impl RefFromWasmAbi for UnderlyingSource
source§type Abi = <JsValue as RefFromWasmAbi>::Abi
type Abi = <JsValue as RefFromWasmAbi>::Abi
Self
are recovered from.source§type Anchor = ManuallyDrop<UnderlyingSource>
type Anchor = ManuallyDrop<UnderlyingSource>
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.impl Eq for UnderlyingSource
impl StructuralPartialEq for UnderlyingSource
Auto Trait Implementations§
impl Freeze for UnderlyingSource
impl RefUnwindSafe for UnderlyingSource
impl !Send for UnderlyingSource
impl !Sync for UnderlyingSource
impl Unpin for UnderlyingSource
impl UnwindSafe for UnderlyingSource
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<T> ReturnWasmAbi for Twhere
T: IntoWasmAbi,
impl<T> ReturnWasmAbi for Twhere
T: IntoWasmAbi,
source§type Abi = <T as IntoWasmAbi>::Abi
type Abi = <T as IntoWasmAbi>::Abi
IntoWasmAbi::Abi
source§fn return_abi(self) -> <T as ReturnWasmAbi>::Abi
fn return_abi(self) -> <T as ReturnWasmAbi>::Abi
IntoWasmAbi::into_abi
, except that it may throw and never
return in the case of Err
.