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
- Alphabetic
- By Inheritance
- GridFSDownloadStream
- Serializable
- Product
- Equals
- AsyncInputStream
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new GridFSDownloadStream(wrapped: com.mongodb.async.client.gridfs.GridFSDownloadStream)
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##(): Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- 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
- def clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- 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
- GridFSDownloadStream → AsyncInputStream
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- 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
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- 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
-1if there is no more data because the end of the stream has been reached.
- Definition Classes
- GridFSDownloadStream → AsyncInputStream
- 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
- GridFSDownloadStream → AsyncInputStream
- Since
2.6
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
This is the documentation for the MongoDB Scala driver.
Driver structure
The mongodb scala driver.
To get started you need a MongoClient instance, either from a connection string or via a org.mongodb.scala.MongoClientSettings.
Notable packages include: