How typelevel/fs2 works
FS2 is a Scala library for effectful, compositional stream processing. Its primary workflow is that application code constructs a Stream, uses Pull for lower-level stream transformations, then compiles or runs the stream; internal scopes support resource safety. The repository also provides concurrency primitives, platform-specific I/O, compression and hashing, protocol codecs, and integrations with stream-processing APIs. The README establishes the product and supported platforms; the source index and excerpts support the cited internal relationships. Unsampled subsystems are represented without asserting unverified call paths.
Main entry points: Stream.scala Stream API · Socket.scala Socket API · TLSContext.scala TLS context · Files.scala File operations
Components 24
Stream core
- Stream API
core/shared/src/main/scala/fs2/Stream.scala - Pull operations
core/shared/src/main/scala/fs2/Pull.scala - Stream compiler
core/shared/src/main/scala/fs2/Compiler.scala - Resource scopes
core/shared/src/main/scala/fs2/internal/Scope.scala - Stream errors
core/shared/src/main/scala/fs2/Fallible.scala - Error capability
core/shared/src/main/scala/fs2/RaiseThrowable.scala
Concurrency
I/O
- File operations
io/shared/src/main/scala/fs2/io/file/Files.scala - File handles
io/shared/src/main/scala/fs2/io/file/FileHandle.scala - File watching
io/jvm-native/src/main/scala/fs2/io/file/Watcher.scala - Socket API
io/shared/src/main/scala/fs2/io/net/Socket.scala - TLS context
io/shared/src/main/scala/fs2/io/net/tls/TLSContext.scala - JVM TLS engine
io/jvm/src/main/scala/fs2/io/net/tls/TLSEngine.scala - JS TLS platform
io/js/src/main/scala/fs2/io/net/tls/TLSContextPlatform.scala
Data processing
- Compression
core/shared/src/main/scala/fs2/compression/Compression.scala - Hashing
core/shared/src/main/scala/fs2/hashing/Hashing.scala - Protocol codecs
protocols/shared/src/main/scala/fs2/protocols
Interoperability
- Java Flow interop
core/shared/src/main/scala/fs2/interop/flow/StreamPublisher.scala - Reactive Streams
reactive-streams/src/main/scala/fs2/interop/reactivestreams/StreamSubscriber.scala - scodec interop
scodec/shared/src/main/scala/fs2/interop/scodec/StreamDecoder.scala
Other components
- Application code
- External byte source
Connections 24
- Application code → Stream API: constructs streams
- Stream API → Pull operations: uses pulls
core/shared/src/main/scala/fs2/Stream.scala - Stream API → Stream compiler: compiles streams
core/shared/src/main/scala/fs2/Stream.scala - Pull operations → Resource scopes: manages scopes
core/shared/src/main/scala/fs2/Pull.scala - Stream API → Resource scopes: uses scopes
core/shared/src/main/scala/fs2/Stream.scala - Stream errors → Error capability: requires capability
core/shared/src/main/scala/fs2/Fallible.scala - Stream API → Channel: uses channel
core/shared/src/main/scala/fs2/Stream.scala - Stream API → Signal: uses signal
core/shared/src/main/scala/fs2/Stream.scala - Stream API → Topic: uses topic
core/shared/src/main/scala/fs2/Stream.scala - File operations → Stream API: returns streams
io/shared/src/main/scala/fs2/io/file/Files.scala - File operations → File handles: opens handles
io/shared/src/main/scala/fs2/io/file/Files.scala - File watching → File operations: uses file API
io/jvm-native/src/main/scala/fs2/io/DeprecatedWatcher.scala - Socket API → Stream API: exposes byte streams
io/shared/src/main/scala/fs2/io/net/Socket.scala - TLS context → Socket API: wraps sockets
io/shared/src/main/scala/fs2/io/net/tls/TLSContext.scala - TLS context → JVM TLS engine: platform implementation
- JS TLS platform → Socket API: builds TLS sockets
io/js/src/main/scala/fs2/io/net/tls/TLSContextPlatform.scala - TLS context → JS TLS platform: platform implementation
io/js/src/main/scala/fs2/io/net/tls/TLSContextPlatform.scala - Compression → Stream API: transforms streams
- Hashing → Stream API: hashes streams
- Protocol codecs → Stream API: processes stream data
- Java Flow interop → Stream API: publishes streams
core/shared/src/main/scala/fs2/Stream.scala - Reactive Streams → Stream API: adapts streams
reactive-streams/src/main/scala/fs2/interop/reactivestreams/StreamSubscriber.scala - scodec interop → Stream API: decodes streams
scodec/shared/src/main/scala/fs2/interop/scodec/StreamDecoder.scala - External byte source → Socket API: supplies bytes