Packages

c

org.mongodb.scala.gridfs

GridFSUploadStream

case class GridFSUploadStream(wrapped: com.mongodb.async.client.gridfs.GridFSUploadStream) extends AsyncOutputStream with Product with Serializable

A GridFS OutputStream for uploading data into GridFS

Provides the id for the file to be uploaded as well as the write methods of a AsyncOutputStream

Since

1.2

Linear Supertypes
Serializable, Serializable, Product, Equals, AsyncOutputStream, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GridFSUploadStream
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AsyncOutputStream
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new GridFSUploadStream(wrapped: com.mongodb.async.client.gridfs.GridFSUploadStream)

Value Members

  1. def abort(): Observable[Completed]

    Aborts the upload and deletes any data.

    Aborts the upload and deletes any data.

    returns

    an Observable identifying when the abort and cleanup has finished

  2. def close(): Observable[Completed]

    Closes the output stream

    Closes the output stream

    returns

    an Observable identifying when the AsyncOutptStream has been closed

    Definition Classes
    GridFSUploadStream → AsyncOutputStream
  3. lazy val id: BsonValue

    The BsonValue id for this file.

    The BsonValue id for this file.

    returns

    the id for this file

  4. lazy val objectId: ObjectId

    Gets the ObjectId for the file to be uploaded

    Gets the ObjectId for the file to be uploaded

    returns

    the ObjectId for the file to be uploaded

    Exceptions thrown

    MongoGridFSException if the file id is not an ObjectId.

  5. def write(src: ByteBuffer): Observable[Int]

    Writes a sequence of bytes from the given buffer into this stream.

    Writes a sequence of bytes from the given buffer into this stream.

    src

    the source buffer containing the data to be written.

    returns

    a Observable returning a single element containing the number of bytes written.

    Definition Classes
    GridFSUploadStream → AsyncOutputStream