servo/components/script_bindings/webidls/ReadableStream.webidl
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

60 lines
1.5 KiB
Text

/* 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/. */
// https://streams.spec.whatwg.org/#readablestream
[Exposed=*, Transferable]
interface _ReadableStream {
[Throws]
constructor(optional object underlyingSource, optional QueuingStrategy strategy = {});
// [Throws]
// static ReadableStream from(any asyncIterable);
readonly attribute boolean locked;
[NewObject]
Promise<undefined> cancel(optional any reason);
[Throws]
ReadableStreamReader getReader(optional ReadableStreamGetReaderOptions options = {});
[Throws]
ReadableStream pipeThrough(ReadableWritablePair transform, optional StreamPipeOptions options = {});
[NewObject]
Promise<undefined> pipeTo(WritableStream destination, optional StreamPipeOptions options = {});
[Throws]
sequence<ReadableStream> tee();
// [GenerateReturnMethod]
// async iterable<any>(optional ReadableStreamIteratorOptions options = {});
};
enum ReadableStreamType { "bytes" };
enum ReadableStreamReaderMode { "byob" };
dictionary ReadableStreamGetReaderOptions {
ReadableStreamReaderMode mode;
};
/*
dictionary ReadableStreamIteratorOptions {
boolean preventCancel = false;
};
*/
dictionary ReadableWritablePair {
required ReadableStream readable;
required WritableStream writable;
};
dictionary StreamPipeOptions {
boolean preventClose = false;
boolean preventAbort = false;
boolean preventCancel = false;
AbortSignal signal;
};