servo/components/script/dom/idbcursorwithvalue.rs
Kingsley Yung 250c4cda00
indexeddb: Implement openCursor and openKeyCursor for object store (#39080)
Continue on implementing indexeddb's cursor.

This patch focuses on implementing the `openCursor` [1] and
`openKeyCursor` [2] methods of the `IDBObjectStore` interface, which
create and initialize cursors by running the iterate-a-cursor algorithm
[3].

It also adds struct `IndexedDBRecord` to
`components/shared/net/indexeddb_thread.rs`. This struct can later be
used to implement the new `IDBRecord` interface [4].

[1] https://www.w3.org/TR/IndexedDB-2/#dom-idbobjectstore-opencursor
[2] https://www.w3.org/TR/IndexedDB-2/#dom-idbobjectstore-openkeycursor
[3] https://www.w3.org/TR/IndexedDB-2/#iterate-a-cursor
[4] https://w3c.github.io/IndexedDB/#record-interface

Testing: Pass WPT tests that were expected to fail.
Fixes: Part of #38111

---------

Signed-off-by: Kingsley Yung <kingsley@kkoyung.dev>
2025-09-12 16:54:07 +00:00

77 lines
2.4 KiB
Rust

/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at https://mozilla.org/MPL/2.0/. */
use dom_struct::dom_struct;
use js::rust::MutableHandleValue;
use net_traits::indexeddb_thread::IndexedDBKeyRange;
use crate::dom::bindings::codegen::Bindings::IDBCursorBinding::IDBCursorDirection;
use crate::dom::bindings::codegen::Bindings::IDBCursorWithValueBinding::IDBCursorWithValueMethods;
use crate::dom::bindings::reflector::reflect_dom_object;
use crate::dom::bindings::root::DomRoot;
use crate::dom::globalscope::GlobalScope;
use crate::dom::idbcursor::{IDBCursor, ObjectStoreOrIndex};
use crate::dom::idbtransaction::IDBTransaction;
use crate::script_runtime::{CanGc, JSContext as SafeJSContext};
#[dom_struct]
pub(crate) struct IDBCursorWithValue {
cursor: IDBCursor,
}
impl IDBCursorWithValue {
#[cfg_attr(crown, allow(crown::unrooted_must_root))]
fn new_inherited(
transaction: &IDBTransaction,
direction: IDBCursorDirection,
got_value: bool,
source: ObjectStoreOrIndex,
range: IndexedDBKeyRange,
key_only: bool,
) -> IDBCursorWithValue {
IDBCursorWithValue {
cursor: IDBCursor::new_inherited(
transaction,
direction,
got_value,
source,
range,
key_only,
),
}
}
#[cfg_attr(crown, allow(crown::unrooted_must_root))]
#[allow(clippy::too_many_arguments)]
pub(crate) fn new(
global: &GlobalScope,
transaction: &IDBTransaction,
direction: IDBCursorDirection,
got_value: bool,
source: ObjectStoreOrIndex,
range: IndexedDBKeyRange,
key_only: bool,
can_gc: CanGc,
) -> DomRoot<IDBCursorWithValue> {
reflect_dom_object(
Box::new(IDBCursorWithValue::new_inherited(
transaction,
direction,
got_value,
source,
range,
key_only,
)),
global,
can_gc,
)
}
}
impl IDBCursorWithValueMethods<crate::DomTypeHolder> for IDBCursorWithValue {
/// <https://www.w3.org/TR/IndexedDB-2/#dom-idbcursorwithvalue-value>
fn Value(&self, _cx: SafeJSContext, value: MutableHandleValue) {
self.cursor.value(value);
}
}