ladybird/Userland/Libraries/LibWeb/Streams/ReadableStreamBYOBReader.h
Kenneth Myhra 907dc84c1e LibWeb: Implement min option for ReadableStreamBYOBReader.read()
When the min option is given the read will only be fulfilled when there
are min or more elements available in the readable byte stream.

When the min option is not given the default value for min is 1.
2024-07-11 11:55:15 +02: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 {
JS_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);
JS_DECLARE_ALLOCATOR(ReadableStreamBYOBReader);
public:
static WebIDL::ExceptionOr<JS::NonnullGCPtr<ReadableStreamBYOBReader>> construct_impl(JS::Realm&, JS::NonnullGCPtr<ReadableStream>);
virtual ~ReadableStreamBYOBReader() override = default;
JS::NonnullGCPtr<JS::Promise> read(JS::Handle<WebIDL::ArrayBufferView>&, ReadableStreamBYOBReaderReadOptions options = {});
void release_lock();
Vector<JS::NonnullGCPtr<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<JS::NonnullGCPtr<ReadIntoRequest>> m_read_into_requests;
};
}