Class/Object

org.gerweck.scala.util.io

StreamInverter

Related Docs: object StreamInverter | package io

Permalink

class StreamInverter extends AnyRef

A stream inverter lets you transform an InputStream to an OutputStream or vice versa.

It's often the case that you need to pass a particular kind of stream into an API. In some situations, especially if you're using something like Akka Streams, you may really want to have the opposite of what you need to pass in.

E.g., when receive a document upload, a legacy API may ask you to pass in an OutputStream to which it will push the bytes. In a streaming context, what you really want is for that API to give you an InputStream from which you will pull the bytes (or which you'll use to create a stream Source).

A StreamInverter provides exactly that conversion.

Warning: the jobs on each side of the inverter both need to be running on their own thread or you are likely to starve the buffer and lock the application. In the streaming context, this often means invoking the traditional API in a scala.concurrent.Future. IO jobs typically hold threads for a long time, so you probably want to have a dedicated scala.concurrent.ExecutionContext for those futures. A good option is org.gerweck.scala.util.io.ioExecutionContext, which is a premade context with good settings for dedicated IO threads.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StreamInverter
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  11. val input: InputStream

    Permalink
  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  14. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  16. val output: OutputStream

    Permalink
  17. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  18. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  19. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped