Object built-in object

Object MemoryStream

Memory stream object

The MemoryStream object creates a memory-based stream object, the creation method:

1
var ms = new io.MemoryStream();

Inheritance

#lineWidth: 1.5 #font: Helvetica,sans-Serif #fontSize: 10 #leading: 1.6 #.this: fill=lightgray #.class: fill=white [<class>object|toString();toJSON()] [<class>Stream|fd|read();write();flush();close();copyTo()] [<class>SeekableStream|seek();tell();rewind();size();readAll();truncate();eof();stat()] [<this>MemoryStream|new MemoryStream()|setTime();clone();clear()] [object] <:- [Stream] [Stream] <:- [SeekableStream] [SeekableStream] <:- [MemoryStream] Stream fd read() write() flush() close() copyTo() MemoryStream new MemoryStream() setTime() clone() clear() object toString() toJSON() SeekableStream seek() tell() rewind() size() readAll() truncate() eof() stat()

Constructor

MemoryStream

MemoryStream constructor

1
new MemoryStream();

Member attributes

fd

Integer, query Stream The corresponding file descriptor value, implemented by the subclass

1
readonly Integer MemoryStream.fd;

Member function

setTime

Force the last update time of the memory stream object

1
MemoryStream.setTime(Date d);

Call parameters:

  • d: Date, specify the time to be set

clone

Create a read-only copy of the current memory stream

1
MemoryStream MemoryStream.clone();

Return result:

  • MemoryStream, Return a read-only memory stream object

clear

Clear memory file data, reset pointer

1
MemoryStream.clear();

seek

Move the current operating position of the file

1 2
MemoryStream.seek(Long offset, Integer whence = fs.SEEK_SET);

Call parameters:

  • offset: Long, specify a new location
  • whence: Integer, specify the position reference, the allowed values ​​are: SEEK_SET, SEEK_CUR, SEEK_END

tell

Query the current position of the stream

1
Long MemoryStream.tell();

Return result:

  • Long, Returns the current position of the stream

rewind

Move the current position to the beginning of the stream

1
MemoryStream.rewind();

size

Query stream size

1
Long MemoryStream.size();

Return result:

  • Long, Return stream size

readAll

Read all remaining data from the stream

1
Buffer MemoryStream.readAll() async;

Return result:

  • Buffer, Return the data read from the stream, if there is no data to read, or the connection is interrupted, then return null

truncate

Modify the file size, if the new size is smaller than the original size, the file is truncated

1
MemoryStream.truncate(Long bytes) async;

Call parameters:

  • bytes: Long, new file size

eof

Check if the file is to the end

1
Boolean MemoryStream.eof();

Return result:

  • Boolean, Return True to indicate the end

stat

Query the basic information of the current file

1
Stat MemoryStream.stat() async;

Return result:

  • Stat, return Stat Object description file information

read

Read data of the specified size from the stream

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

Call parameters:

  • bytes: Integer, specify the amount of data to be read, the default is to read a random size data block, the size of the data read depends on the device

Return result:

  • Buffer, Return the data read from the stream, if there is no data to read, or the connection is interrupted, then return null

write

Write the given data to the stream

1
MemoryStream.write(Buffer data) async;

Call parameters:

  • data: Buffer, Given the data to be written

flush

Write the contents of the file buffer to the physical device

1
MemoryStream.flush() async;

close

Close the current stream object

1
MemoryStream.close() async;

copyTo

Copy the stream data to the target stream

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

Call parameters:

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

Return result:

  • Long, Returns the number of bytes copied

toString

Returns the string representation of the object, generally returns "[Native Object]", the object can be re-implemented according to its own characteristics

1
String MemoryStream.toString();

Return result:

  • String, Returns the string representation of the object

toJSON

Returns the JSON format representation of the object, generally returns a collection of readable attributes defined by the object

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

Call parameters:

  • key: String, unused

Return result:

  • Value, Returns a value containing JSON serializable