Struct web_sys::IdbIndex

#[repr(transparent)]
pub struct IdbIndex { /* private fields */ }

The IDBIndex object

MDN Documentation

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

Implementations

impl IdbIndex

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

The count() method

MDN Documentation

This API requires the following crate features to be activated: IdbIndex, IdbRequest

impl IdbIndex

pub fn count_with_key(&self, key: &JsValue) -> Result<IdbRequest, JsValue>

The count() method

MDN Documentation

This API requires the following crate features to be activated: IdbIndex, IdbRequest

impl IdbIndex

pub fn get(&self, key: &JsValue) -> Result<IdbRequest, JsValue>

The get() method

MDN Documentation

This API requires the following crate features to be activated: IdbIndex, IdbRequest

impl IdbIndex

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

The getAll() method

MDN Documentation

This API requires the following crate features to be activated: IdbIndex, IdbRequest

impl IdbIndex

pub fn get_all_with_key(&self, key: &JsValue) -> Result<IdbRequest, JsValue>

The getAll() method

MDN Documentation

This API requires the following crate features to be activated: IdbIndex, IdbRequest

impl IdbIndex

pub fn get_all_with_key_and_limit(
    &self,
    key: &JsValue,
    limit: u32
) -> Result<IdbRequest, JsValue>

The getAll() method

MDN Documentation

This API requires the following crate features to be activated: IdbIndex, IdbRequest

impl IdbIndex

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

The getAllKeys() method

MDN Documentation

This API requires the following crate features to be activated: IdbIndex, IdbRequest

impl IdbIndex

pub fn get_all_keys_with_key(&self, key: &JsValue) -> Result<IdbRequest, JsValue>

The getAllKeys() method

MDN Documentation

This API requires the following crate features to be activated: IdbIndex, IdbRequest

impl IdbIndex

pub fn get_all_keys_with_key_and_limit(
    &self,
    key: &JsValue,
    limit: u32
) -> Result<IdbRequest, JsValue>

The getAllKeys() method

MDN Documentation

This API requires the following crate features to be activated: IdbIndex, IdbRequest

impl IdbIndex

pub fn get_key(&self, key: &JsValue) -> Result<IdbRequest, JsValue>

The getKey() method

MDN Documentation

This API requires the following crate features to be activated: IdbIndex, IdbRequest

impl IdbIndex

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

The openCursor() method

MDN Documentation

This API requires the following crate features to be activated: IdbIndex, IdbRequest

impl IdbIndex

pub fn open_cursor_with_range(
    &self,
    range: &JsValue
) -> Result<IdbRequest, JsValue>

The openCursor() method

MDN Documentation

This API requires the following crate features to be activated: IdbIndex, IdbRequest

impl IdbIndex

pub fn open_cursor_with_range_and_direction(
    &self,
    range: &JsValue,
    direction: IdbCursorDirection
) -> Result<IdbRequest, JsValue>

The openCursor() method

MDN Documentation

This API requires the following crate features to be activated: IdbCursorDirection, IdbIndex, IdbRequest

impl IdbIndex

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

The openKeyCursor() method

MDN Documentation

This API requires the following crate features to be activated: IdbIndex, IdbRequest

impl IdbIndex

pub fn open_key_cursor_with_range(
    &self,
    range: &JsValue
) -> Result<IdbRequest, JsValue>

The openKeyCursor() method

MDN Documentation

This API requires the following crate features to be activated: IdbIndex, IdbRequest

impl IdbIndex

pub fn open_key_cursor_with_range_and_direction(
    &self,
    range: &JsValue,
    direction: IdbCursorDirection
) -> Result<IdbRequest, JsValue>

The openKeyCursor() method

MDN Documentation

This API requires the following crate features to be activated: IdbCursorDirection, IdbIndex, IdbRequest

impl IdbIndex

pub fn name(&self) -> String

The name getter

MDN Documentation

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

impl IdbIndex

pub fn set_name(&self, name: &str)

The name setter

MDN Documentation

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

impl IdbIndex

pub fn object_store(&self) -> IdbObjectStore

The objectStore getter

MDN Documentation

This API requires the following crate features to be activated: IdbIndex, IdbObjectStore

impl IdbIndex

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

The keyPath getter

MDN Documentation

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

impl IdbIndex

pub fn multi_entry(&self) -> bool

The multiEntry getter

MDN Documentation

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

impl IdbIndex

pub fn unique(&self) -> bool

The unique getter

MDN Documentation

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

impl IdbIndex

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

The locale getter

MDN Documentation

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

impl IdbIndex

pub fn is_auto_locale(&self) -> bool

The isAutoLocale getter

MDN Documentation

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

Methods from Deref<Target = Object>

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

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

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

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

MDN documentation

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

pub fn to_string(&self) -> JsString

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

MDN documentation

pub fn value_of(&self) -> Object

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

MDN documentation

Methods from Deref<Target = JsValue>

pub const NULL: JsValue = JsValue{ idx: JSIDX_NULL, _marker: marker::PhantomData,}

pub const UNDEFINED: JsValue = JsValue{ idx: JSIDX_UNDEFINED, _marker: marker::PhantomData,}

pub const TRUE: JsValue = JsValue{ idx: JSIDX_TRUE, _marker: marker::PhantomData,}

pub const FALSE: JsValue = JsValue{ idx: JSIDX_FALSE, _marker: marker::PhantomData,}

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.

pub fn is_string(&self) -> bool

Tests whether this JS value is a JS 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.

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.

pub fn is_null(&self) -> bool

Tests whether this JS value is null

pub fn is_undefined(&self) -> bool

Tests whether this JS value is undefined

pub fn is_symbol(&self) -> bool

Tests whether the type of this JS value is symbol

pub fn is_object(&self) -> bool

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

pub fn is_function(&self) -> bool

Tests whether the type of this JS value is function.

Trait Implementations

impl AsRef<JsValue> for IdbIndex

fn as_ref(&self) -> &JsValue

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

impl AsRef<Object> for IdbIndex

fn as_ref(&self) -> &Object

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

impl Clone for IdbIndex

fn clone(&self) -> IdbIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IdbIndex

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

Formats the value using the given formatter.

impl Deref for IdbIndex

type Target = Object

The resulting type after dereferencing.

fn deref(&self) -> &Object

Dereferences the value.

impl From<IdbIndex> for JsValue

fn from(obj: IdbIndex) -> JsValue

Converts to this type from the input type.

impl From<IdbIndex> for Object

fn from(obj: IdbIndex) -> Object

Converts to this type from the input type.

impl From<JsValue> for IdbIndex

fn from(obj: JsValue) -> IdbIndex

Converts to this type from the input type.

impl FromWasmAbi for IdbIndex

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<'a> IntoWasmAbi for &'a IdbIndex

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 IntoWasmAbi for IdbIndex

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 JsCast for IdbIndex

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 is_instance_of<T>(&self) -> boolwhere
    T: JsCast,

Test whether this JS value is an instance of the 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) -> Twhere
    T: JsCast,

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

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

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

impl OptionFromWasmAbi for IdbIndex

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<'a> OptionIntoWasmAbi for &'a IdbIndex

fn none() -> Self::Abi

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

impl OptionIntoWasmAbi for IdbIndex

fn none() -> Self::Abi

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

impl RefFromWasmAbi for IdbIndex

type Abi = <JsValue as RefFromWasmAbi>::Abi

The wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<IdbIndex>

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 IdbIndex

fn describe()