nsIUnicharInputStream

Abstract unicode character input stream
@see nsIInputStream

Methods

read(aBuf, aCount)

Reads into a caller-provided character array.

@note To read more than 2^32 characters, call this method multiple times.

Returns

The number of characters that were successfully read. May be less than aCount, even if there is more data in the input stream. A return value of 0 means EOF.

readSegments(aWriter, aClosure, aCount)

Low-level read method that has access to the stream’s underlying buffer.
The writer function may be called multiple times for segmented buffers.
ReadSegments is expected to keep calling the writer until either there is
nothing left to read or the writer returns an error. ReadSegments should
not call the writer with zero characters to consume.

@throws NS_BASE_STREAM_WOULD_BLOCK if reading from the input stream would
block the calling thread (non-blocking mode only)
@throws on failure

NOTE: this function may be unimplemented if a stream has no underlying
buffer

Parameters

aWriter the "consumer" of the data to be read
aClosure opaque parameter passed to writer
aCount the maximum number of characters to be read

Returns

0 if reached end of file (or if aWriter refused to consume data)

readString(aCount, aString)

Read into a string object.

Parameters

aCount The number of characters that should be read

Returns

The number of characters that were read.

close()

Close the stream and free associated resources. This also closes the
underlying stream, if any.