Packages

c

org.mongodb.scala.gridfs

GridFSDownloadStream

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

A GridFS InputStream for downloading data from GridFS

Provides the GridFSFile for the file to being downloaded as well as the read methods of a AsyncInputStream

Since

1.2

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

Instance Constructors

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

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def batchSize(batchSize: Int): GridFSDownloadStream

    Sets the number of chunks to return per batch.

    Sets the number of chunks to return per batch.

    Can be used to control the memory consumption of this InputStream. The smaller the batchSize the lower the memory consumption and higher latency.

    batchSize

    the batch size

    returns

    this

    See also

    Batch Size

  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  7. def close(): Observable[Completed]

    Closes the input stream

    Closes the input stream

    returns

    a Observable with a single element indicating when the operation has completed

    Definition Classes
    GridFSDownloadStreamAsyncInputStream
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def gridFSFile(): Observable[GridFSFile]

    Gets the corresponding GridFSFile for the file being downloaded

    Gets the corresponding GridFSFile for the file being downloaded

    returns

    a Observable with a single element containing the corresponding GridFSFile for the file being downloaded

  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. def read(dst: ByteBuffer): Observable[Int]

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

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

    dst

    the destination buffer

    returns

    an Observable with a single element indicating total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.

    Definition Classes
    GridFSDownloadStreamAsyncInputStream
  17. def skip(bytesToSkip: Long): Observable[Long]

    Skips over and discards n bytes of data from this input stream.

    Skips over and discards n bytes of data from this input stream.

    bytesToSkip

    the number of bytes to skip

    returns

    an Observable with a single element indicating the total number of bytes skipped

    Definition Classes
    GridFSDownloadStreamAsyncInputStream
    Since

    2.6

  18. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AsyncInputStream

Inherited from AnyRef

Inherited from Any

Ungrouped