wasm-streams 0.4.0

Bridging between web streams and Rust streams using WebAssembly
Documentation 
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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112

//! Raw bindings to JavaScript objects used
//! by a [`ReadableStream`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream).
//! These are re-exported from [web-sys](https://docs.rs/web-sys/0.3.64/web_sys/struct.ReadableStream.html).
use js_sys::{Array, Error, Object};
use wasm_bindgen::prelude::*;
use web_sys::AbortSignal;
pub use web_sys::ReadableByteStreamController;
// Re-export from web-sys
pub use web_sys::ReadableStream;
pub use web_sys::ReadableStreamByobReader as ReadableStreamBYOBReader;
pub use web_sys::ReadableStreamByobRequest as ReadableStreamBYOBRequest;
pub use web_sys::ReadableStreamDefaultController;
pub use web_sys::ReadableStreamDefaultReader;
pub use web_sys::ReadableStreamGetReaderOptions;
pub use web_sys::ReadableStreamReaderMode;
pub use web_sys::StreamPipeOptions as PipeOptions;

use crate::queuing_strategy::QueuingStrategy;
use crate::readable::into_underlying_byte_source::IntoUnderlyingByteSource;
use crate::readable::into_underlying_source::IntoUnderlyingSource;

#[wasm_bindgen]
extern "C" {
    /// Additional methods for [`ReadableStream`](web_sys::ReadableStream).
    #[wasm_bindgen(js_name = ReadableStream, typescript_type = "ReadableStream")]
    pub(crate) type ReadableStreamExt;

    #[wasm_bindgen(constructor, js_class = ReadableStream)]
    pub(crate) fn new_with_into_underlying_source(
        source: IntoUnderlyingSource,
        strategy: QueuingStrategy,
    ) -> ReadableStreamExt;

    #[wasm_bindgen(constructor, catch, js_class = ReadableStream)]
    pub(crate) fn new_with_into_underlying_byte_source(
        source: IntoUnderlyingByteSource,
    ) -> Result<ReadableStreamExt, Error>;

    #[wasm_bindgen(method, catch, js_class = ReadableStream, js_name = getReader)]
    pub(crate) fn try_get_reader(this: &ReadableStreamExt) -> Result<Object, Error>;

    #[wasm_bindgen(method, catch, js_class = ReadableStream, js_name = getReader)]
    pub(crate) fn try_get_reader_with_options(
        this: &ReadableStreamExt,
        options: &ReadableStreamGetReaderOptions,
    ) -> Result<Object, Error>;

    #[wasm_bindgen(method, catch, js_class = ReadableStream, js_name = tee)]
    pub(crate) fn try_tee(this: &ReadableStreamExt) -> Result<Array, Error>;

    #[wasm_bindgen(catch, static_method_of = ReadableStreamExt, js_class = ReadableStream, js_name = from)]
    pub(crate) fn from_async_iterable(async_iterable: &Object) -> Result<ReadableStreamExt, Error>;
}

#[wasm_bindgen]
extern "C" {
    /// Additional methods for [`ReadableStreamDefaultReader`](web_sys::ReadableStreamDefaultReader)
    /// and [`ReadableStreamByobReader`](web_sys::ReadableStreamByobReader).
    pub(crate) type ReadableStreamReaderExt;

    #[wasm_bindgen(method, catch, js_name = releaseLock)]
    pub(crate) fn try_release_lock(this: &ReadableStreamReaderExt) -> Result<(), Error>;
}

#[wasm_bindgen]
extern "C" {
    /// A result returned by [`ReadableStreamDefaultReader.read`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStreamDefaultReader/read)
    /// or [`ReadableStreamBYOBReader.read`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStreamBYOBReader/read).
    #[derive(Clone, Debug)]
    pub(crate) type ReadableStreamReadResult;

    #[wasm_bindgen(method, getter, js_name = done)]
    pub(crate) fn is_done(this: &ReadableStreamReadResult) -> bool;

    #[wasm_bindgen(method, getter, js_name = value)]
    pub(crate) fn value(this: &ReadableStreamReadResult) -> JsValue;
}

#[wasm_bindgen]
extern "C" {
    /// Additional methods for [`StreamPipeOptions`](web_sys::StreamPipeOptions).
    #[wasm_bindgen(extends = PipeOptions)]
    #[derive(Clone, Debug)]
    pub(crate) type StreamPipeOptionsExt;

    #[wasm_bindgen(constructor, js_class = Object)]
    pub(crate) fn new() -> StreamPipeOptionsExt;

    #[wasm_bindgen(method, getter, js_name = preventClose)]
    pub fn prevent_close(this: &StreamPipeOptionsExt) -> bool;

    #[wasm_bindgen(method, setter, js_name = preventClose)]
    pub fn set_prevent_close(this: &StreamPipeOptionsExt, value: bool);

    #[wasm_bindgen(method, getter, js_name = preventCancel)]
    pub fn prevent_cancel(this: &StreamPipeOptionsExt) -> bool;

    #[wasm_bindgen(method, setter, js_name = preventCancel)]
    pub fn set_prevent_cancel(this: &StreamPipeOptionsExt, value: bool);

    #[wasm_bindgen(method, getter, js_name = preventAbort)]
    pub fn prevent_abort(this: &StreamPipeOptionsExt) -> bool;

    #[wasm_bindgen(method, setter, js_name = preventAbort)]
    pub fn set_prevent_abort(this: &StreamPipeOptionsExt, value: bool);

    #[wasm_bindgen(method, getter, js_name = signal)]
    pub fn signal(this: &StreamPipeOptionsExt) -> Option<AbortSignal>;

    #[wasm_bindgen(method, setter, js_name = signal)]
    pub fn set_signal(this: &StreamPipeOptionsExt, value: Option<AbortSignal>);
}