Coverage Report

Created: 2025-08-28 06:26

/src/serenity/Userland/Libraries/LibWeb/Streams/TransformStream.h
Line
Count
Source (jump to first uncovered line)
1
/*
2
 * Copyright (c) 2023, Kenneth Myhra <kennethmyhra@serenityos.org>
3
 *
4
 * SPDX-License-Identifier: BSD-2-Clause
5
 */
6
7
#pragma once
8
9
#include <LibJS/Forward.h>
10
#include <LibWeb/Bindings/PlatformObject.h>
11
#include <LibWeb/Forward.h>
12
#include <LibWeb/Streams/QueuingStrategy.h>
13
#include <LibWeb/WebIDL/Promise.h>
14
15
namespace Web::Streams {
16
17
class TransformStream final : public Bindings::PlatformObject {
18
    WEB_PLATFORM_OBJECT(TransformStream, Bindings::PlatformObject);
19
    JS_DECLARE_ALLOCATOR(TransformStream);
20
21
public:
22
    virtual ~TransformStream() override;
23
24
    static WebIDL::ExceptionOr<JS::NonnullGCPtr<TransformStream>> construct_impl(JS::Realm&, Optional<JS::Handle<JS::Object>> transformer_object = {}, QueuingStrategy const& writable_strategy = {}, QueuingStrategy const& readable_strategy = {});
25
26
    // https://streams.spec.whatwg.org/#ts-readable
27
0
    JS::NonnullGCPtr<ReadableStream> readable() { return *m_readable; }
28
0
    void set_readable(ReadableStream& readable) { m_readable = readable; }
29
30
    // https://streams.spec.whatwg.org/#ts-writable
31
0
    JS::NonnullGCPtr<WritableStream> writable() { return *m_writable; }
32
0
    void set_writable(WritableStream& writable) { m_writable = writable; }
33
34
0
    Optional<bool> backpressure() const { return m_backpressure; }
35
0
    void set_backpressure(Optional<bool> value) { m_backpressure = move(value); }
36
37
0
    JS::GCPtr<WebIDL::Promise> backpressure_change_promise() const { return m_backpressure_change_promise; }
38
0
    void set_backpressure_change_promise(JS::GCPtr<WebIDL::Promise> value) { m_backpressure_change_promise = value; }
39
40
0
    JS::GCPtr<TransformStreamDefaultController> controller() const { return m_controller; }
41
0
    void set_controller(JS::GCPtr<TransformStreamDefaultController> value) { m_controller = value; }
42
43
private:
44
    explicit TransformStream(JS::Realm& realm);
45
46
    virtual void initialize(JS::Realm&) override;
47
48
    virtual void visit_edges(Cell::Visitor&) override;
49
50
    // https://streams.spec.whatwg.org/#transformstream-backpressure
51
    // Whether there was backpressure on [[readable]] the last time it was observed
52
    Optional<bool> m_backpressure { false };
53
54
    // https://streams.spec.whatwg.org/#transformstream-backpressurechangepromise
55
    // A promise which is fulfilled and replaced every time the value of [[backpressure]] changes
56
    JS::GCPtr<WebIDL::Promise> m_backpressure_change_promise;
57
58
    // https://streams.spec.whatwg.org/#transformstream-controller
59
    // A TransformStreamDefaultController created with the ability to control [[readable]] and [[writable]]
60
    JS::GCPtr<TransformStreamDefaultController> m_controller;
61
62
    // https://streams.spec.whatwg.org/#transformstream-detached
63
    // A boolean flag set to true when the stream is transferred
64
    bool m_detached { false };
65
66
    // https://streams.spec.whatwg.org/#transformstream-readable
67
    // The ReadableStream instance controlled by this object
68
    JS::GCPtr<ReadableStream> m_readable;
69
70
    // https://streams.spec.whatwg.org/#transformstream-writable
71
    // The WritableStream instance controlled by this object
72
    JS::GCPtr<WritableStream> m_writable;
73
};
74
75
}