ladybird/Libraries/LibWeb/Streams/ReadableStreamBYOBRequest.h
Shannon Booth 97abc707c7 LibWeb/Bindings: Generate buffer typedefs as variants
Represent BufferSource and ArrayBufferView as ordinary IDL typedefs over
their underlying union types, instead of special casing in the IDL
generator. This allows the union conversion/return machinery handle
these types consistently with other typedefs, which removes buffer
specific paths from the IDL generator.

This necessitates changing the WebIDL::BufferSource and
WebIDL::ArrayBufferView classes as views over these variants. This
replaces the old GC backed BufferableObject wrapper structure and
provide convenience helpers to determine things such as the byte length,
byte offset, backing buffer, and typed-array APIs.
2026-05-30 11:22:08 +02:00

51 lines
1.7 KiB
C++

/*
* Copyright (c) 2023, Matthew Olsson <mattco@serenityos.org>
* Copyright (c) 2023, Shannon Booth <shannon@serenityos.org>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#pragma once
#include <LibWeb/Bindings/PlatformObject.h>
#include <LibWeb/Forward.h>
#include <LibWeb/Streams/ReadableByteStreamController.h>
#include <LibWeb/WebIDL/Buffers.h>
#include <LibWeb/WebIDL/Types.h>
namespace Web::Streams {
// https://streams.spec.whatwg.org/#readablestreambyobrequest
class ReadableStreamBYOBRequest : public Bindings::PlatformObject {
WEB_PLATFORM_OBJECT(ReadableStreamBYOBRequest, Bindings::PlatformObject);
GC_DECLARE_ALLOCATOR(ReadableStreamBYOBRequest);
public:
virtual ~ReadableStreamBYOBRequest() override = default;
WebIDL::NullableArrayBufferViewVariant view();
void set_controller(GC::Ptr<ReadableByteStreamController> value) { m_controller = value; }
void set_view(WebIDL::NullableArrayBufferViewVariant value) { m_view = value; }
WebIDL::ExceptionOr<void> respond(WebIDL::UnsignedLongLong bytes_written);
WebIDL::ExceptionOr<void> respond_with_new_view(WebIDL::ArrayBufferView view);
private:
explicit ReadableStreamBYOBRequest(JS::Realm&);
virtual void initialize(JS::Realm&) override;
virtual void visit_edges(Cell::Visitor&) override;
// https://streams.spec.whatwg.org/#readablestreambyobrequest-controller
// The parent ReadableByteStreamController instance
GC::Ptr<ReadableByteStreamController> m_controller;
// https://streams.spec.whatwg.org/#readablestreambyobrequest-view
// A typed array representing the destination region to which the controller can write generated data, or null after the BYOB request has been invalidated.
WebIDL::NullableArrayBufferViewVariant m_view;
};
}