summaryrefslogtreecommitdiffstats
path: root/js/src/builtin/streams/ReadableStreamInternals.h
blob: 3fe6400ec7d2d2700fb970b390592203d7b4e322 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*-
 * vim: set ts=8 sts=2 et sw=2 tw=80:
 * 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 http://mozilla.org/MPL/2.0/. */

/* The interface between readable streams and controllers. */

#ifndef builtin_streams_ReadableStreamInternals_h
#define builtin_streams_ReadableStreamInternals_h

#include "mozilla/Attributes.h"  // MOZ_MUST_USE

#include "jstypes.h"                               // JS_PUBLIC_API
#include "builtin/streams/ReadableStreamReader.h"  // js::ForAuthorCodeBool
#include "js/RootingAPI.h"                         // JS::Handle
#include "js/Value.h"                              // JS::Value

struct JS_PUBLIC_API JSContext;
class JS_PUBLIC_API JSObject;

namespace js {

class PlainObject;
class PromiseObject;
class ReadableStream;

extern MOZ_MUST_USE PromiseObject* ReadableStreamAddReadOrReadIntoRequest(
    JSContext* cx, JS::Handle<ReadableStream*> unwrappedStream);

extern MOZ_MUST_USE JSObject* ReadableStreamCancel(
    JSContext* cx, JS::Handle<ReadableStream*> unwrappedStream,
    JS::Handle<JS::Value> reason);

extern MOZ_MUST_USE bool ReadableStreamCloseInternal(
    JSContext* cx, JS::Handle<ReadableStream*> unwrappedStream);

extern MOZ_MUST_USE PlainObject* ReadableStreamCreateReadResult(
    JSContext* cx, JS::Handle<JS::Value> value, bool done,
    ForAuthorCodeBool forAuthorCode);

extern MOZ_MUST_USE bool ReadableStreamErrorInternal(
    JSContext* cx, JS::Handle<ReadableStream*> unwrappedStream,
    JS::Handle<JS::Value> e);

extern MOZ_MUST_USE bool ReadableStreamFulfillReadOrReadIntoRequest(
    JSContext* cx, JS::Handle<ReadableStream*> unwrappedStream,
    JS::Handle<JS::Value> chunk, bool done);

extern uint32_t ReadableStreamGetNumReadRequests(ReadableStream* stream);

extern MOZ_MUST_USE bool ReadableStreamHasDefaultReader(
    JSContext* cx, JS::Handle<ReadableStream*> unwrappedStream, bool* result);

}  // namespace js

#endif  // builtin_streams_ReadableStreamInternals_h