ByteArrayOutputStream

This class implements an output stream in which the data is written into a byte array. The buffer automatically grows as data is written to it. The data can be retrieved using <code>toByteArray()</code> and <code>toString()</code>. Closing a <tt>ByteArrayOutputStream</tt> has no effect. The methods in this class can be called after the stream has been closed without generating an <tt>IOException</tt>.

class ByteArrayOutputStream : OutputStream {

protected

alias write = OutputStream.write;

void write(int b);

void write(byte[] b, int off, int len);

void writeTo(OutputStream o);

void reset();

byte[] toByteArray(bool canCopy);

byte[] getBuffer();

int size();

string toString();

string toString(string charsetName);

}

Constructors

this this(): Creates a new byte array output stream. The buffer capacity is initially 32 bytes, though its size increases if necessary.
this this(size_t size): Creates a new byte array output stream, with a buffer capacity of the specified size, in bytes.

Members

Aliases

write alias write = OutputStream.write: Undocumented in source.

Functions

getBuffer byte[] getBuffer(): Undocumented in source. Be warned that the author may not have intended to support it.
reset void reset(): Resets the <code>count</code> field of this byte array output stream to zero, so that all currently accumulated output in the output stream is discarded. The output stream can be used again, reusing the already allocated buffer space.
size int size(): Returns the current size of the buffer.
toByteArray byte[] toByteArray(bool canCopy): Creates a newly allocated byte array. Its size is the current size of this output stream and the valid contents of the buffer have been copied into it.
toString string toString(): Converts the buffer's contents into a string decoding bytes using the platform's default character set. The length of the new <tt>string</tt> is a function of the character set, and hence may not be equal to the size of the buffer.
toString string toString(string charsetName): Converts the buffer's contents into a string by decoding the bytes using the named {@link java.nio.charset.Charset charset}. The length of the new <tt>string</tt> is a function of the charset, and hence may not be equal to the length of the byte array.
write void write(int b): Writes the specified byte to this byte array output stream.
write void write(byte[] b, int off, int len): Writes <code>len</code> bytes from the specified byte array starting at offset <code>off</code> to this byte array output stream.
writeTo void writeTo(OutputStream o): Writes the complete contents of this byte array output stream to the specified output stream argument, as if by calling the output stream's write method using <code>out.write(buf, 0, count)</code>.

Variables

buf byte[] buf;: The buffer where data is stored.
count int count;: The number of valid bytes in the buffer.

Inherited Members

From OutputStream

write void write(int b): Writes the specified byte to this output stream. The general contract for <code>write</code> is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument <code>b</code>. The 24 high-order bits of <code>b</code> are ignored. Subclasses of <code>OutputStream</code> must provide an implementation for this method.
write void write(string b): Undocumented in source. Be warned that the author may not have intended to support it.
write void write(byte[] b): Writes <code>b.length</code> bytes from the specified byte array to this output stream. The general contract for <code>write(b)</code> is that it should have exactly the same effect as the call <code>write(b, 0, b.length)</code>.
write void write(byte[] b, int off, int len): Writes <code>len</code> bytes from the specified byte array starting at offset <code>off</code> to this output stream. The general contract for <code>write(b, off, len)</code> is that some of the bytes in the array <code>b</code> are written to the output stream in order; element <code>boff</code> is the first byte written and <code>b[off+len-1]</code> is the last byte written by this operation. The <code>write</code> method of <code>OutputStream</code> calls the write method of one argument on each of the bytes to be written out. Subclasses are encouraged to override this method and provide a more efficient implementation. If <code>b</code> is <code>null</code>, a <code>NullPointerException</code> is thrown. If <code>off</code> is negative, or <code>len</code> is negative, or <code>off+len</code> is greater than the length of the array <code>b</code>, then an <tt>IndexOutOfBoundsException</tt> is thrown.
flush void flush(): Flushes this output stream and forces any buffered output bytes to be written out. The general contract of <code>flush</code> is that calling it is an indication that, if any bytes previously written have been buffered by the implementation of the output stream, such bytes should immediately be written to their intended destination. If the intended destination of this stream is an abstraction provided by the underlying operating system, for example a file, then flushing the stream guarantees only that bytes previously written to the stream are passed to the operating system for writing; it does not guarantee that they are actually written to a physical device such as a disk drive. The <code>flush</code> method of <code>OutputStream</code> does nothing.
close void close(): Closes this output stream and releases any system resources associated with this stream. The general contract of <code>close</code> is that it closes the output stream. A closed stream cannot perform output operations and cannot be reopened. The <code>close</code> method of <code>OutputStream</code> does nothing.