ZipStream

Provider of streams that take in zip entries and produces zipped data as output.

This offers a number of methods that will create Akka Streams stages that can be used to write zip archives. To write to your zip, you will send in a stream of ZipStream.Entry objects, which are an abstraction of a single entry in a zip archive.

The structure of a zip archive requires that a single entry is written to completion once it is started, so you may wish to organize the incoming stream so that it does not emit an Entry until its data is available.

For example, if the contents of a file are generated by a database query, you may wish to have the completion of the query produce the Entry object rather than immediately producing an entry that then executes a query to fetch the required data.

Source: ZipStream.scala

Linear Supertypes

AnyRef, Any

Type Members

final class Entry extends AnyRef

An entry to be written into the zip file.
An entry to be written into the zip file.

Note
These are NOT serializable, as they contain a stream Source.
sealed trait ExistingFile extends AnyRef

Describes what to do if a target path already exists

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
object ExistingFile

Contains options for handling existing files.
def asFlow(buffer: Option[Int] = defaultFlowBuffer)(implicit ec: ExecutionContext): Flow[Entry, ByteString, Future[IOResult]]

A zip compressor that takes in entries and flows out bytes.
A zip compressor that takes in entries and flows out bytes.
buffer
the size (in bytes) of an optional buffer that will hold the zipped data before it is converted into ByteString objects. Using a buffer can substantially improve performance, as otherwise you may have many stream elements with just a few bytes in them.
ec
the execution context to use for any callback operations. This context will not be used for any long-running or blocking operations.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val defaultFileBuffer: Option[Int]

The default buffer size when writing zipped data to a file.
val defaultFlowBuffer: Option[Int]

The default buffer size when outputting zipped data as a stream.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

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

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toFile(path: Path, existingFile: ExistingFile = ExistingFile.Fail, buffer: Option[Int] = defaultFileBuffer)(implicit ec: ExecutionContext): Sink[Entry, Future[IOResult]]

A zip compressor that takes in entries and writes them to a file.
A zip compressor that takes in entries and writes them to a file.
path
the location of the file to be written.
existingFile
what to do if there is already a file at the provided path.
buffer
the size (in bytes) of an optional buffer that will hold the zipped data before it is written to the file. The OS probably offers output buffering, but this can potentially reduce the number of OS-level writes that need to be made.
ec
the execution context to use for any callback operations. This context will not be used for any long-running or blocking operations.
def toString(): String

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

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package stream

object ZipStream

Type Members

final class Entry extends AnyRef

sealed trait ExistingFile extends AnyRef

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

object ExistingFile

def asFlow(buffer: Option[Int] = defaultFlowBuffer)(implicit ec: ExecutionContext): Flow[Entry, ByteString, Future[IOResult]]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val defaultFileBuffer: Option[Int]

val defaultFlowBuffer: Option[Int]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toFile(path: Path, existingFile: ExistingFile = ExistingFile.Fail, buffer: Option[Int] = defaultFileBuffer)(implicit ec: ExecutionContext): Sink[Entry, Future[IOResult]]

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped