Mirrors/servo
1
0
Fork 0
mirror of https://github.com/servo/servo.git synced 2025-09-30 00:29:14 +01:00
Code Issues Projects Releases Packages Wiki Activity

script_bindings: Assert that serializable/transferable types have accurate WebIDL annotations (#38615)

Browse source 
These changes add compile-time assertions that:
* any type that implements the Serializable/Transferable trait has a
`[Serializable]` or `[Transferable]` annotation in the interface WebIDL
* any WebIDL interface with the `[Serializable]` or `[Transferable]`
annotation implements the corresponding trait

This is useful because it means that WebIDL definitions will be less
confusing if you're trying to figure out whether Servo supports
serializing/transferring a particular interface type. It also makes
fixing #21715 in the future a little bit easier, because the annotations
will remain up to date.

Testing: compile-time only; no point in writing tests for this since it
involves webidl codegen.

---------

Signed-off-by: Josh Matthews <josh@joshmatthews.net>
This commit is contained in:
Josh Matthews 2025-08-13 04:36:04 -04:00 • committed by GitHub
parent 0d6d434e59
commit bd9bb77295
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
18 changed files with 84 additions and 27 deletions
Download patch file Download diff file Expand all files Collapse all files

5
components/script/dom/bindings/serializable.rs
View file

@ -8,6 +8,7 @@
use std::collections::HashMap;
use base::id::{Index, NamespaceIndex, PipelineNamespaceId};
use script_bindings::structuredclone::MarkedAsSerializableInIdl;
use crate::dom::bindings::reflector::DomObject;
use crate::dom::bindings::root::DomRoot;
@ -45,7 +46,7 @@ impl<T> From<StorageKey> for NamespaceIndex<T> {
/// Interface for serializable platform objects.
/// <https://html.spec.whatwg.org/multipage/#serializable>
pub(crate) trait Serializable: DomObject
pub(crate) trait Serializable: DomObject + MarkedAsSerializableInIdl
where
Self: Sized,
{
@ -69,3 +70,5 @@ where
data: StructuredData<'a, '_>,
) -> &'a mut Option<HashMap<NamespaceIndex<Self::Index>, Self::Data>>;
}
pub(crate) fn assert_serializable<T: Serializable>() {}

5
components/script/dom/bindings/transferable.rs
View file

@ -9,6 +9,7 @@ use std::collections::HashMap;
use std::hash::Hash;
use base::id::NamespaceIndex;
use script_bindings::structuredclone::MarkedAsTransferableInIdl;
use crate::dom::bindings::error::Fallible;
use crate::dom::bindings::reflector::DomObject;
@ -16,7 +17,7 @@ use crate::dom::bindings::root::DomRoot;
use crate::dom::bindings::structuredclone::StructuredData;
use crate::dom::globalscope::GlobalScope;
pub(crate) trait Transferable: DomObject
pub(crate) trait Transferable: DomObject + MarkedAsTransferableInIdl
where
Self: Sized,
{
@ -41,3 +42,5 @@ where
data: StructuredData<'a, '_>,
) -> &'a mut Option<HashMap<NamespaceIndex<Self::Index>, Self::Data>>;
}
pub(crate) fn assert_transferable<T: Transferable>() {}