servo/components/script_bindings/lib.rs
Josh Matthews bd9bb77295
script_bindings: Assert that serializable/transferable types have accurate WebIDL annotations (#38615)
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>
2025-08-13 08:36:04 +00:00

97 lines
2.6 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/. */
#![cfg_attr(crown, feature(register_tool))]
// Register the linter `crown`, which is the Servo-specific linter for the script crate.
#![cfg_attr(crown, register_tool(crown))]
#[macro_use]
extern crate js;
#[macro_use]
extern crate jstraceable_derive;
#[macro_use]
extern crate log;
#[macro_use]
extern crate malloc_size_of_derive;
pub mod callback;
mod constant;
mod constructor;
pub mod conversions;
pub mod error;
mod finalize;
mod guard;
mod import;
pub mod inheritance;
pub mod interface;
pub mod interfaces;
pub mod iterable;
pub mod like;
mod lock;
mod mem;
mod namespace;
pub mod num;
pub mod principals;
pub mod proxyhandler;
pub mod realms;
pub mod record;
pub mod reflector;
pub mod root;
pub mod script_runtime;
pub mod settings_stack;
pub mod str;
pub mod structuredclone;
pub mod trace;
pub mod utils;
pub mod weakref;
#[allow(non_snake_case, unsafe_op_in_unsafe_fn)]
pub mod codegen {
pub mod Globals {
include!(concat!(env!("OUT_DIR"), "/Globals.rs"));
}
#[allow(dead_code, unused_imports, clippy::enum_variant_names)]
pub mod InheritTypes {
include!(concat!(env!("OUT_DIR"), "/InheritTypes.rs"));
}
#[allow(clippy::upper_case_acronyms)]
pub mod PrototypeList {
include!(concat!(env!("OUT_DIR"), "/PrototypeList.rs"));
}
pub(crate) mod DomTypes {
include!(concat!(env!("OUT_DIR"), "/DomTypes.rs"));
}
#[allow(
dead_code,
clippy::extra_unused_type_parameters,
clippy::missing_safety_doc,
clippy::result_unit_err
)]
pub mod GenericBindings {
include!(concat!(env!("OUT_DIR"), "/Bindings/mod.rs"));
}
#[allow(
non_camel_case_types,
unused_imports,
unused_variables,
clippy::large_enum_variant,
clippy::upper_case_acronyms,
clippy::enum_variant_names
)]
pub mod GenericUnionTypes {
include!(concat!(env!("OUT_DIR"), "/GenericUnionTypes.rs"));
}
pub mod RegisterBindings {
include!(concat!(env!("OUT_DIR"), "/RegisterBindings.rs"));
}
}
// These trait exports are public, because they are used in the DOM bindings.
// Since they are used in derive macros,
// it is useful that they are accessible at the root of the crate.
pub(crate) use js::gc::Traceable as JSTraceable;
pub use crate::codegen::DomTypes::DomTypes;
pub(crate) use crate::reflector::{DomObject, MutDomObject, Reflector};
pub(crate) use crate::trace::CustomTraceable;