diff options
Diffstat (limited to 'components/script/dom/bindings/serializable.rs')
-rw-r--r-- | components/script/dom/bindings/serializable.rs | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/components/script/dom/bindings/serializable.rs b/components/script/dom/bindings/serializable.rs new file mode 100644 index 00000000000..a2ca8f5a040 --- /dev/null +++ b/components/script/dom/bindings/serializable.rs @@ -0,0 +1,31 @@ +/* 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 http://mozilla.org/MPL/2.0/. */ + +//! Trait representing the concept of [serializable objects] +//! (https://html.spec.whatwg.org/multipage/#serializable-objects). + +use crate::dom::bindings::reflector::DomObject; +use crate::dom::bindings::structuredclone::StructuredDataHolder; +use crate::dom::globalscope::GlobalScope; + +/// The key corresponding to the storage location +/// of a serialized platform object stored in a StructuredDataHolder. +#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)] +pub struct StorageKey { + pub index: u32, + pub name_space: u32, +} + +/// Interface for serializable platform objects. +/// <https://html.spec.whatwg.org/multipage/#serializable> +pub trait Serializable: DomObject { + /// <https://html.spec.whatwg.org/multipage/#serialization-steps> + fn serialize(&self, sc_holder: &mut StructuredDataHolder) -> Result<StorageKey, ()>; + /// <https://html.spec.whatwg.org/multipage/#deserialization-steps> + fn deserialize( + owner: &GlobalScope, + sc_holder: &mut StructuredDataHolder, + extra_data: StorageKey, + ) -> Result<(), ()>; +} |