Object built-in object

ObjectStream

Stream operation object, used for reading and writing binary data streams

Stream is the basic object used to define standard interfaces for stream processing and cannot be created independently.

inheritance relationship

%0 object object toString() toJSON() Stream Stream fd read() write() flush() close() copyTo() object->Stream BufferedStream BufferedStream Stream->BufferedStream SeekableStream SeekableStream Stream->SeekableStream Socket Socket Stream->Socket SslSocket SslSocket Stream->SslSocket TTYInputStream TTYInputStream Stream->TTYInputStream TTYOutputStream TTYOutputStream Stream->TTYOutputStream File File SeekableStream->File MemoryStream MemoryStream SeekableStream->MemoryStream RangeStream RangeStream SeekableStream->RangeStream

member properties

fd

Integer, query the file descriptor value corresponding to Stream, implemented by subclasses

1
readonly Integer Stream.fd;

member function

read

Read data of specified size from the stream

1
Buffer Stream.read(Integer bytes = -1) async;

Call parameters:

  • bytes: Integer, specifies the amount of data to be read. The default is to read data blocks of random size. The size of the data read depends on the device.

Return results:

  • Buffer, returns the data read from the stream. If there is no data to read or the connection is interrupted, null is returned.

write

Write the given data to the stream

1
Stream.write(Buffer data) async;

Call parameters:

  • data:Buffer, given the data to be written

flush

Write file buffer contents to physical device

1
Stream.flush() async;

close

Close the current stream object

1
Stream.close() async;

copyTo

Copy stream data to target stream

1 2
Long Stream.copyTo(Stream stm, Long bytes = -1) async;

Call parameters:

  • stm: Stream, target stream object
  • bytes: Long, number of bytes copied

Return results:

  • Long, returns the number of bytes copied

toString

Returns the string representation of the object. Generally, "[Native Object]" is returned. The object can be re-implemented according to its own characteristics.

1
String Stream.toString();

Return results:

  • String, returns the string representation of the object

toJSON

Returns a JSON format representation of the object, generally returning a collection of readable properties defined by the object.

1
Value Stream.toJSON(String key = "");

Call parameters:

  • key: String, not used

Return results:

  • Value, returns a value containing JSON serializable