streamly-examples: Examples for Streamly

This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.

[maintain] [Publish]

Warnings:

'ghc-options: -main-is' is not portable.
'ghc-options: -O2' is rarely needed. Check that it is giving a real benefit and not just imposing longer compile times on your users.

Practical examples to demonstrate the features and performance of Streamly. Includes examples about file IO, text processing, networking, concurrent programming, reactive programming and more.

These examples also serve as a beginner's guide to express practical programs using the dataflow programming (streaming) model. Please visit the Streamly homepage for more details and comprehensive documentation.

[Skip to Readme]

Properties

Versions	0.1.0, 0.1.1, 0.1.2, 0.1.2, 0.1.3
Change log	Changelog.md
Dependencies	base (>=4.9 && <4.17), containers (>=0.5 && <0.7), directory (>=1.2 && <1.4), exceptions (>=0.8 && <0.11), hashable (>=1.2 && <1.4), mtl (>=2.2 && <3), network (>=2.6 && <4), random (>=1.0.0 && <2), streamly (>=0.8.2 && <0.8.3), transformers (>=0.4 && <0.6), transformers-base (>=0.4 && <0.5), unordered-containers (>=0.2 && <0.3), vector (>=0.12 && <0.13) [details]
License	Apache-2.0
Copyright	Copyright (c) 2019 Composewell Technologies
Author	Composewell Technologies
Maintainer	streamly@composewell.com
Category	Streamly, Streaming, Concurrency, Text, Filesystem, Network, Reactivity
Home page	https://streamly.composewell.com
Bug tracker	http://github.com/composewell/streamly-examples/issues
Source repo	head: git clone git://github.com/composewell/streamly-examples.git
Uploaded	by adithyaov at 2022-03-06T18:59:18Z

Flags

Manual Flags

Name	Description	Default
fusion-plugin	Use fusion plugin for for best performance	Disabled
sdl2	Include graphics examples using SDL2	Disabled
interop	Include examples of inter-operation with other libraries	Disabled

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

streamly-examples-0.1.2.tar.gz [browse] (Cabal source package)
Package description (as included in the package)

Maintainer's Corner

Package maintainers

harendra, adithyaov, ranjeetra

For package maintainers and hackage trustees

edit package information

Readme for streamly-examples-0.1.2

[back to package description]

Streamly Examples

Practical examples to demonstrate the features and performance of Streamly. Includes examples about file IO, text processing, networking, concurrent programming, reactive programming and more.

Running The Examples

Executable names are the same as the filenames. To run an example:

$ cabal run AcidRain

For performance sensitive examples use fusion-plugin for best performance:

$ cabal run --flag fusion-plugin WordCount -- streamly-examples.cabal

To run SDL2 based examples, make sure that you have the OS package for the sdl2 library installed on your system and the headers are visible to cabal:

$ cabal run --flag sdl2 CirclingSquare

To run interop examples, use the interop build flag:

$ cabal run --flag interop Interop.Pipes

List of examples

General

Intro: Simple, introductory examples - loops, text processing, networking, concurrency.
MergeSort: Merge sorted streams concurrently.
Rate: Run an action at a given rate.

FileSystem

CoreUtils: Implement simplified coreutils like cat, cp, tee, grep using Streamly.FileSystem.File API.
CoreUtilsHandle: Implement simplified coreutils using Streamly.FileSystem.Handle API.
Split: Implement file splitting utility split.
FileSystemEvent: File watching/fsnotify API example.
ListDir: List a directory tree recursively and concurrently.

Text Processing

CamelCase: Convert a file to camel case.
WordCount: Simple word counting (wc) program.
WordCount.c: C equivalent for perf comparison.
WordCountModular: Modular version.
WordCountParallel: Concurrent version.
WordCountParallelUTF8: Concurrent version with full UTF8 handling.
WordFrequency: Count word frequency in a file and print top 25 words.
CSVParser: Process a CSV file

Networking

EchoServer: A concurrent TCP server that echoes everything that it receives.
MergeServer: Merges lines received from several client connections and writes them to a file.
FileSender: Send many files concurrently to a server over multiple connections. Can be used to test MergeServer.
CmdServer: Receive a stream of commands from many clients and respond to them using command handlers.
CmdClient: Run multiple concurrent clients sending streams of commands to a server and receiving responses. Can be used to test CmdServer.
WordServer: A word look up (dictionary) server, instead of performing a real DB query the server just adds a time delay to simulate the IO.

FRP/Games/Animation

AcidRain: A console game with deteriorating health that can be modified by typing "harm" and "potion" commands.
CirclingSquare: Use SDL2 to display a square that moves in a circle, and follows the mouse pointer.

Monad Transformers

ControlFlow: Combining control flow manipulating transformers (MaybeT, ExceptT, ContT) with streamly.

Interoperation

Interop.Streaming: Converting streamly stream type to and from streaming stream type.
Interop.Pipes: Converting streamly stream type to and from pipes stream type.
Interop.Conduit: Converting streamly stream type to and from conduit stream type.
Interop.Vector: Converting streamly stream type to and from vector stream type.

Licensing

Available under Apache-2.0 license.