akasha

Class ReadableStream

java.lang.Object

akasha.ReadableStream

All Implemented Interfaces:

Transferable

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="ReadableStream")
public class ReadableStream
extends java.lang.Object
implements Transferable

The ReadableStream interface of the Streams API represents a readable stream of byte data. The Fetch API offers a concrete instance of a ReadableStream through the body property of a Response object.

See Also:

ReadableStream - MDN, ReadableStream - Streams

Constructor Summary

Constructors

Constructor and Description
ReadableStream() The ReadableStream() constructor creates and returns a readable stream object from the given handlers.
ReadableStream(java.lang.Object underlyingSource) The ReadableStream() constructor creates and returns a readable stream object from the given handlers.
ReadableStream(java.lang.Object underlyingSource, QueuingStrategy strategy) The ReadableStream() constructor creates and returns a readable stream object from the given handlers.

Method Summary

Modifier and Type	Method and Description
Promise<java.lang.Void>	cancel() The cancel() method of the ReadableStream interface cancels the associated stream.
Promise<java.lang.Void>	cancel(java.lang.Object reason) The cancel() method of the ReadableStream interface cancels the associated stream.
ReadableStreamReader	getReader() The getReader() method of the ReadableStream interface creates a reader and locks the stream to it.
ReadableStreamReader	getReader(ReadableStreamGetReaderOptions options) The getReader() method of the ReadableStream interface creates a reader and locks the stream to it.
boolean	locked() The locked read-only property of the ReadableStream interface returns whether or not the readable stream is locked to a reader.
ReadableStream	pipeThrough(ReadableWritablePair transform) The pipeThrough() method of the ReadableStream interface provides a chainable way of piping the current stream through a transform stream or any other writable/readable pair.
ReadableStream	pipeThrough(ReadableWritablePair transform, StreamPipeOptions options) The pipeThrough() method of the ReadableStream interface provides a chainable way of piping the current stream through a transform stream or any other writable/readable pair.
Promise<java.lang.Void>	pipeTo(WritableStream destination) The pipeTo() method of the ReadableStream interface pipes the current ReadableStream to a given WritableStream and returns a promise that fulfills when the piping process completes successfully, or rejects if any errors were encountered.
Promise<java.lang.Void>	pipeTo(WritableStream destination, StreamPipeOptions options) The pipeTo() method of the ReadableStream interface pipes the current ReadableStream to a given WritableStream and returns a promise that fulfills when the piping process completes successfully, or rejects if any errors were encountered.
JsArray<ReadableStream>	tee() The tee() method of the ReadableStream interface tees the current readable stream, returning a two-element array containing the two resulting branches as new ReadableStream instances.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReadableStream

public ReadableStream(@Nonnull
                      java.lang.Object underlyingSource,
                      @Nonnull
                      QueuingStrategy strategy)

The ReadableStream() constructor creates and returns a readable stream object from the given handlers.

See Also:

ReadableStream.ReadableStream - MDN, ReadableStream() - Streams

ReadableStream

public ReadableStream(@Nonnull
                      java.lang.Object underlyingSource)

The ReadableStream() constructor creates and returns a readable stream object from the given handlers.

See Also:

ReadableStream.ReadableStream - MDN, ReadableStream() - Streams

ReadableStream

public ReadableStream()

The ReadableStream() constructor creates and returns a readable stream object from the given handlers.

See Also:

ReadableStream.ReadableStream - MDN, ReadableStream() - Streams

Method Detail

locked

@JsProperty(name="locked")
public boolean locked()

The locked read-only property of the ReadableStream interface returns whether or not the readable stream is locked to a reader.

See Also:

ReadableStream.locked - MDN, locked - Streams

cancel

@Nonnull
public Promise<java.lang.Void> cancel(@Nullable
                                               java.lang.Object reason)

The cancel() method of the ReadableStream interface cancels the associated stream. The supplied reason parameter will be given to the underlying source, which may or may not use it.

See Also:

ReadableStream.cancel - MDN, cancel() - Streams

cancel

@Nonnull
public Promise<java.lang.Void> cancel()

The cancel() method of the ReadableStream interface cancels the associated stream. The supplied reason parameter will be given to the underlying source, which may or may not use it.

See Also:

ReadableStream.cancel - MDN, cancel() - Streams

getReader

@Nonnull
public ReadableStreamReader getReader(@Nonnull
                                               ReadableStreamGetReaderOptions options)

The getReader() method of the ReadableStream interface creates a reader and locks the stream to it. While the stream is locked, no other reader can be acquired until this one is released.

See Also:

ReadableStream.getReader - MDN, getReader() - Streams

getReader

@Nonnull
public ReadableStreamReader getReader()

The getReader() method of the ReadableStream interface creates a reader and locks the stream to it. While the stream is locked, no other reader can be acquired until this one is released.

See Also:

ReadableStream.getReader - MDN, getReader() - Streams

pipeThrough

@Nonnull
public ReadableStream pipeThrough(@Nonnull
                                           ReadableWritablePair transform,
                                           @Nonnull
                                           StreamPipeOptions options)

The pipeThrough() method of the ReadableStream interface provides a chainable way of piping the current stream through a transform stream or any other writable/readable pair.

See Also:

ReadableStream.pipeThrough - MDN, pipeThrough() - Streams

pipeThrough

@Nonnull
public ReadableStream pipeThrough(@Nonnull
                                           ReadableWritablePair transform)

The pipeThrough() method of the ReadableStream interface provides a chainable way of piping the current stream through a transform stream or any other writable/readable pair.

See Also:

ReadableStream.pipeThrough - MDN, pipeThrough() - Streams

pipeTo

@Nonnull
public Promise<java.lang.Void> pipeTo(@Nonnull
                                               WritableStream destination,
                                               @Nonnull
                                               StreamPipeOptions options)

The pipeTo() method of the ReadableStream interface pipes the current ReadableStream to a given WritableStream and returns a promise that fulfills when the piping process completes successfully, or rejects if any errors were encountered.

See Also:

ReadableStream.pipeTo - MDN, pipeTo() - Streams

pipeTo

@Nonnull
public Promise<java.lang.Void> pipeTo(@Nonnull
                                               WritableStream destination)

The pipeTo() method of the ReadableStream interface pipes the current ReadableStream to a given WritableStream and returns a promise that fulfills when the piping process completes successfully, or rejects if any errors were encountered.

See Also:

ReadableStream.pipeTo - MDN, pipeTo() - Streams

tee

@Nonnull
public JsArray<ReadableStream> tee()

The tee() method of the ReadableStream interface tees the current readable stream, returning a two-element array containing the two resulting branches as new ReadableStream instances.

See Also:

ReadableStream.tee - MDN, tee() - Streams