OutputStream classes

FileOutputStream is for writing to a file; BufferOutputStream and FixedSizeBufferWriter write to buffers; MockOutputStream just reports back how many bytes it received, for testing purposes. You can create one and pass it to any of the table writers, for example.

Factory

The $create() factory methods instantiate the OutputStream object and take the following arguments, depending on the subclass:

• path For FileOutputStream, a character file name

• initial_capacity For BufferOutputStream, the size in bytes of the buffer.

• x For FixedSizeBufferWriter, a Buffer or an object that can be made into a buffer via buffer().

MockOutputStream$create() does not take any arguments.

Methods

• $tell(): return the position in the stream

• $close(): close the stream

• $write(x): send x to the stream

• $capacity(): for BufferOutputStream

• $getvalue(): for BufferOutputStream

• $GetExtentBytesWritten(): for MockOutputStream, report how many bytes were sent.

Super classes

arrow::Object -> arrow::Writable -> OutputStream

Methods

Public methods

• OutputStream$close()

• OutputStream$tell()

• OutputStream$clone()

Inherited methods

• arrow::Object$initialize()

• arrow::Object$pointer()

• arrow::Object$print()

• arrow::Object$set_pointer()

• arrow::Writable$write()

---

Method close()

Usage

OutputStream$close()

---

Method tell()

Usage

OutputStream$tell()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

OutputStream$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Super classes

arrow::Object -> arrow::Writable -> arrow::OutputStream -> FileOutputStream

Methods

Public methods

• FileOutputStream$clone()

Inherited methods

• arrow::Object$initialize()

• arrow::Object$pointer()

• arrow::Object$print()

• arrow::Object$set_pointer()

• arrow::Writable$write()

• arrow::OutputStream$close()

• arrow::OutputStream$tell()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

FileOutputStream$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Super classes

arrow::Object -> arrow::Writable -> arrow::OutputStream -> MockOutputStream

Methods

Public methods

• MockOutputStream$GetExtentBytesWritten()

• MockOutputStream$clone()

Inherited methods

• arrow::Object$initialize()

• arrow::Object$pointer()

• arrow::Object$print()

• arrow::Object$set_pointer()

• arrow::Writable$write()

• arrow::OutputStream$close()

• arrow::OutputStream$tell()

---

Method GetExtentBytesWritten()

Usage

MockOutputStream$GetExtentBytesWritten()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

MockOutputStream$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Super classes

arrow::Object -> arrow::Writable -> arrow::OutputStream -> BufferOutputStream

Methods

Public methods

• BufferOutputStream$capacity()

• BufferOutputStream$getvalue()

• BufferOutputStream$write()

• BufferOutputStream$tell()

• BufferOutputStream$clone()

Inherited methods

• arrow::Object$initialize()

• arrow::Object$pointer()

• arrow::Object$print()

• arrow::Object$set_pointer()

• arrow::OutputStream$close()

---

Method capacity()

Usage

BufferOutputStream$capacity()

---

Method getvalue()

Usage

BufferOutputStream$getvalue()

---

Method write()

Usage

BufferOutputStream$write(bytes)

---

Method tell()

Usage

BufferOutputStream$tell()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

BufferOutputStream$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Super classes

arrow::Object -> arrow::Writable -> arrow::OutputStream -> FixedSizeBufferWriter

Methods

Public methods

• FixedSizeBufferWriter$clone()

Inherited methods

• arrow::Object$initialize()

• arrow::Object$pointer()

• arrow::Object$print()

• arrow::Object$set_pointer()

• arrow::Writable$write()

• arrow::OutputStream$close()

• arrow::OutputStream$tell()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

FixedSizeBufferWriter$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.