-
Notifications
You must be signed in to change notification settings - Fork 595
/
Compression.scala
79 lines (71 loc) · 3.54 KB
/
Compression.scala
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
/*
* Copyright (c) 2013 Functional Streams for Scala
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of
* this software and associated documentation files (the "Software"), to deal in
* the Software without restriction, including without limitation the rights to
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
* the Software, and to permit persons to whom the Software is furnished to do so,
* subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package fs2
package compression
/** Provides the capability to compress/decompress using deflate and gzip.
* On JVM an instance is available given a `Sync[F]`.
* On Node.js an instance is available for `Async[F]` by importing `fs2.io.compression._`.
*/
sealed trait Compression[F[_]] extends CompressionPlatform[F] {
def deflate(deflateParams: DeflateParams): Pipe[F, Byte, Byte]
def inflate(inflateParams: InflateParams): Pipe[F, Byte, Byte]
/** Returns a pipe that incrementally decompresses input according to the GZIP
* format as defined by RFC 1952 at https://www.ietf.org/rfc/rfc1952.txt. Any
* errors in decompression will be sequenced as exceptions into the output
* stream. Decompression is handled in a streaming and async fashion without
* any thread blockage.
*
* The chunk size here is actually really important. Matching the input stream
* largest chunk size, or roughly 8 KB (whichever is larger) is a good rule of
* thumb.
*
* @param bufferSize The bounding size of the input buffer. This should roughly
* match the size of the largest chunk in the input stream.
* This will also be the chunk size in the output stream.
* Default size is 32 KB.
* @return See [[compression.GunzipResult]]
*/
def gunzip(bufferSize: Int = 1024 * 32): Stream[F, Byte] => Stream[F, GunzipResult[F]] =
gunzip(
InflateParams(
bufferSize = bufferSize,
header = ZLibParams.Header.GZIP
)
)
/** Returns a pipe that incrementally decompresses input according to the GZIP
* format as defined by RFC 1952 at https://www.ietf.org/rfc/rfc1952.txt. Any
* errors in decompression will be sequenced as exceptions into the output
* stream. Decompression is handled in a streaming and async fashion without
* any thread blockage.
*
* The chunk size here is actually really important. Matching the input stream
* largest chunk size, or roughly 8 KB (whichever is larger) is a good rule of
* thumb.
*
* @param inflateParams See [[compression.InflateParams]]
* @return See [[compression.GunzipResult]]
*/
def gunzip(inflateParams: InflateParams): Stream[F, Byte] => Stream[F, GunzipResult[F]]
}
object Compression extends CompressionCompanionPlatform {
private[fs2] trait UnsealedCompression[F[_]] extends Compression[F]
def apply[F[_]](implicit F: Compression[F]): Compression[F] = F
}