git.iko.soy/Idris-dev
on aeb032a help sign in
Idris-dev/docs/effects/index.rst
40 lines 1.2 kB history raw
1.. _eff-tutorial-index:
3####################
4The Effects Tutorial
5####################
7A tutorial on the `Effects` package in `Idris`.
9.. topic:: Effects and the ``Control.ST`` module
11 There is a new module in the ``contrib`` package, ``Control.ST``, which
12 provides the resource tracking facilities of `Effects` but with
13 better support for creating and deleting resources, and implementing
14 resources in terms of other resources.
16 Unless you have a particular reason to use `Effects` you are strongly
17 recommended to use ``Control.ST`` instead. There is a tutorial available
18 on this site for ``Control.ST`` with several examples
19 (:ref:`st-tutorial-index`).
21.. note::
23 The documentation for Idris has been published under the Creative
24 Commons CC0 License. As such to the extent possible under law, *The
25 Idris Community* has waived all copyright and related or neighbouring
26 rights to Documentation for Idris.
28 More information concerning the CC0 can be found online at: http://creativecommons.org/publicdomain/zero/1.0/
30.. toctree::
31 :maxdepth: 1
33 introduction
34 state
35 simpleeff
36 depeff
37 impleff
38 hangman
39 conclusions
40 summary