Module documentation for 0.0.0.2
An utility library to build multiple components (config, db, cache, logging, etc.) of an application in a traceable, reliable and efficient fashion
Table Of Contents
Make sure you include the following entry on your cabal file’s dependecies section.
library: build-depends: componentm
Or on your
dependencies: - componentm
This library is intended to be a high level API for the teardown library; it provides a high level monad interface that helps composition of resource allocation/teardown in a safe and reliable way.
Differences with ResourceT
The resourcet library provides a monad transformer that keeps track of allocated resources at runtime making sure that if an exception happens or the block of execution finishes, the resources allocated are cleaned up.
The componentm library on the other hand, does not run as a Monad transformer, but rather it gets called at the very beginning of your application, it builds the environment needed by your application environment to work (e.g. Layer 1), and provides helper bracket style functions that cleanup all allocated resources in the right order when your application terminates either normally or with an error.
This library is intended to be minimal, providing a few functions that work reliably among many different kind of projects. If you want to contribute, Pull Request are very welcome! Please try to follow these simple rules:
- Please create a topic branch for every separate change you make.
- Update the README.md file if necessary.
- Please do not change the version number on your Pull Request.
Open Commit Bit
This project has an open commit bit policy: Anyone with an accepted pull request gets added as a repository collaborator. Please try to follow these simple rules:
- Commit directly onto the master branch only for typos, improvements to the README and documentation.
- Create a feature branch and open a pull-request early for any new features to get feedback.
- Make sure you adhere to the general pull request rules above.
Copyright (c) 2017-2018 Roman Gonzalez
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED “AS IS” AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
- Improve upon pretty instances of types from this library
- Expose internal modules for flexibility
- Relax lower version bounds for
ComponentMtype, which supports
buildComponentto build components in IO with attached cleanup functions
buildComponent_to build components in IO without cleanup functions
withComponentMto run an application