ladybird/Libraries/LibWeb/Streams/ReadableStreamBYOBReader.h
Shannon Booth f87041bf3a LibGC+Everywhere: Factor out a LibGC from LibJS
Resulting in a massive rename across almost everywhere! Alongside the
namespace change, we now have the following names:

 * JS::NonnullGCPtr -> GC::Ref
 * JS::GCPtr -> GC::Ptr
 * JS::HeapFunction -> GC::Function
 * JS::CellImpl -> GC::Cell
 * JS::Handle -> GC::Root
2024-11-15 14:49:20 +01:00

72 lines
2.4 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 <AK/Forward.h>
#include <AK/Function.h>
#include <LibJS/Forward.h>
#include <LibWeb/Bindings/PlatformObject.h>
#include <LibWeb/Forward.h>
#include <LibWeb/Streams/ReadableStreamGenericReader.h>
#include <LibWeb/WebIDL/Types.h>
namespace Web::Streams {
// https://streams.spec.whatwg.org/#dictdef-readablestreambyobreaderreadoptions
struct ReadableStreamBYOBReaderReadOptions {
WebIDL::UnsignedLongLong min = 1;
};
// https://streams.spec.whatwg.org/#read-into-request
class ReadIntoRequest : public JS::Cell {
GC_CELL(ReadIntoRequest, JS::Cell);
public:
virtual ~ReadIntoRequest() = default;
// An algorithm taking a chunk, called when a chunk is available for reading
virtual void on_chunk(JS::Value chunk) = 0;
// An algorithm taking a chunk or undefined, called when no chunks are available because the stream is closed
virtual void on_close(JS::Value chunk_or_undefined) = 0;
// An algorithm taking a JavaScript value, called when no chunks are available because the stream is errored
virtual void on_error(JS::Value error) = 0;
};
// https://streams.spec.whatwg.org/#readablestreambyobreader
class ReadableStreamBYOBReader final
: public Bindings::PlatformObject
, public ReadableStreamGenericReaderMixin {
WEB_PLATFORM_OBJECT(ReadableStreamBYOBReader, Bindings::PlatformObject);
GC_DECLARE_ALLOCATOR(ReadableStreamBYOBReader);
public:
static WebIDL::ExceptionOr<GC::Ref<ReadableStreamBYOBReader>> construct_impl(JS::Realm&, GC::Ref<ReadableStream>);
virtual ~ReadableStreamBYOBReader() override = default;
GC::Ref<WebIDL::Promise> read(GC::Root<WebIDL::ArrayBufferView>&, ReadableStreamBYOBReaderReadOptions options = {});
void release_lock();
Vector<GC::Ref<ReadIntoRequest>>& read_into_requests() { return m_read_into_requests; }
private:
explicit ReadableStreamBYOBReader(JS::Realm&);
virtual void initialize(JS::Realm&) override;
virtual void visit_edges(Cell::Visitor&) override;
// https://streams.spec.whatwg.org/#readablestreambyobreader-readintorequests
// A list of read-into requests, used when a consumer requests chunks sooner than they are available
Vector<GC::Ref<ReadIntoRequest>> m_read_into_requests;
};
}