LanguageExt.Core ► Effects ► Pipes ► Effect
Contents
- Effect <M, A>
- Value
- Effect (Proxy<Void, Unit, Unit, Void, M, A> value)
- ToProxy ()
- Bind <S> ( Func<A, Proxy<Void, Unit, Unit, Void, M, S>> f)
- Bind <S> (Func<A, Effect<M, S>> f)
- Bind <B> (Func<A, K<M, B>> f)
- Map <B> (Func<A, B> f)
- MapM <B> (Func<K<M, A>, K<M, B>> f)
- For <C1, C> (Func<Void, Proxy<Void, Unit, C1, C, M, Unit>> body)
- Action <S> (Proxy<Void, Unit, Unit, Void, M, S> r)
- PairEachRequestWithRespond <UOutA, AUInA> ( Func<Void, Proxy<UOutA, AUInA, Void, Unit, M, A>> lhs)
- ReplaceRequest <UOutA, AUInA> ( Func<Void, Proxy<UOutA, AUInA, Unit, Void, M, Unit>> lhs)
- PairEachRespondWithRequest <DInC, DOutC> ( Func<Void, Proxy<Unit, Void, DInC, DOutC, M, A>> rhs)
- ReplaceRespond <DInC, DOutC> ( Func<Void, Proxy<Void, Unit, DInC, DOutC, M, Unit>> rhs)
- Reflect ()
- Observe ()
- Deconstruct (out Proxy<Void, Unit, Unit, Void, M, A> value)
- SelectMany <B, C> (Func<A, Effect<M, B>> f, Func<A, B, C> project)
- SelectMany <B, C> (Func<A, IO<B>> f, Func<A, B, C> project)
- SelectMany <B, C> (Func<A, K<M, B>> bind, Func<A, B, C> project)
- & ( Effect<M, A> lhs, Effect<M, A> rhs)
- ToString ()
- Effect
Effects represent a 'fused' set of producer, pipes, and consumer into one type.
It neither can neither yield nor be awaiting, it represents an entirely closed effect system.
Upstream | Downstream
+---------+
| |
Void <== <== Unit
| |
Unit ==> ==> Void
| | |
+----|----+
|
A
Constructors
Methods
method Proxy<Void, Unit, Unit, Void, M, A> ToProxy () Source #
Calling this will effectively cast the sub-type to the base.
This type wraps up a Proxy for convenience, and so it's a Proxy proxy. So calling this method
isn't exactly the same as a cast operation, as it unwraps the Proxy from within. It has the same effect
however, and removes a level of indirection
Parameters
| returns | A general | |
method Proxy<Void, Unit, Unit, Void, M, S> Bind <S> ( Func<A, Proxy<Void, Unit, Unit, Void, M, S>> f) Source #
Monadic bind operation, for chaining Proxy computations together.
Parameters
| type | B | The mapped bound value type |
| param | f | The bind function |
| returns | A new | |
method Effect<M, S> Bind <S> (Func<A, Effect<M, S>> f) Source #
Monadic bind operation, for chaining Proxy computations together.
Parameters
| type | B | The mapped bound value type |
| param | f | The bind function |
| returns | A new | |
method Effect<M, B> Bind <B> (Func<A, K<M, B>> f) Source #
Monadic bind operation, for chaining Proxy computations together.
Parameters
| type | B | The mapped bound value type |
| param | f | The bind function |
| returns | A new | |
method Proxy<Void, Unit, Unit, Void, M, B> Map <B> (Func<A, B> f) Source #
Lifts a pure function into the Proxy domain, causing it to map the bound value within
Parameters
| type | B | The mapped bound value type |
| param | f | The map function |
| returns | A new | |
method Proxy<Void, Unit, Unit, Void, M, B> MapM <B> (Func<K<M, A>, K<M, B>> f) Source #
Map the lifted monad
Parameters
| type | B | The mapped bound value type |
| param | f | The map function |
| returns | A new | |
method Proxy<Void, Unit, C1, C, M, A> For <C1, C> (Func<Void, Proxy<Void, Unit, C1, C, M, Unit>> body) Source #
For(body) loops over the Proxy p replacing each yield with body
Parameters
| param | body | Any |
| returns | A new | |
method Proxy<Void, Unit, Unit, Void, M, S> Action <S> (Proxy<Void, Unit, Unit, Void, M, S> r) Source #
Applicative action
Invokes this Proxy, then the Proxy r
Parameters
| param | r |
|
method Proxy<UOutA, AUInA, Unit, Void, M, A> PairEachRequestWithRespond <UOutA, AUInA> ( Func<Void, Proxy<UOutA, AUInA, Void, Unit, M, A>> lhs) Source #
Used by the various composition functions and when composing proxies with the | operator. You usually
wouldn't need to call this directly, instead either pipe them using | or call Proxy.compose(lhs, rhs)
(f +>> p) pairs each 'request' in this with a 'respond' in lhs.
method Proxy<UOutA, AUInA, Unit, Void, M, A> ReplaceRequest <UOutA, AUInA> ( Func<Void, Proxy<UOutA, AUInA, Unit, Void, M, Unit>> lhs) Source #
Used by the various composition functions and when composing proxies with the | operator. You usually
wouldn't need to call this directly, instead either pipe them using | or call Proxy.compose(lhs, rhs)
method Proxy<Void, Unit, DInC, DOutC, M, A> PairEachRespondWithRequest <DInC, DOutC> ( Func<Void, Proxy<Unit, Void, DInC, DOutC, M, A>> rhs) Source #
Used by the various composition functions and when composing proxies with the | operator. You usually
wouldn't need to call this directly, instead either pipe them using | or call Proxy.compose(lhs, rhs)
method Proxy<Void, Unit, DInC, DOutC, M, A> ReplaceRespond <DInC, DOutC> ( Func<Void, Proxy<Void, Unit, DInC, DOutC, M, Unit>> rhs) Source #
Used by the various composition functions and when composing proxies with the | operator. You usually
wouldn't need to call this directly, instead either pipe them using | or call Proxy.compose(lhs, rhs)
method Proxy<Void, Unit, Unit, Void, M, A> Reflect () Source #
Reverse the arrows of the Proxy to find its dual.
Parameters
| returns | The dual of | |
method Proxy<Void, Unit, Unit, Void, M, A> Observe () Source #
Observe(lift (Pure(r))) = Observe(Pure(r))
Observe(lift (m.Bind(f))) = Observe(lift(m.Bind(x => lift(f(x)))))
This correctness comes at a small cost to performance, so use this function sparingly. This function is a convenience for low-level pipes implementers. You do not need to use observe if you stick to the safe API.
method void Deconstruct (out Proxy<Void, Unit, Unit, Void, M, A> value) Source #
method Effect<M, C> SelectMany <B, C> (Func<A, Effect<M, B>> f, Func<A, B, C> project) Source #
Monadic bind operation, for chaining Proxy computations together.
Parameters
| type | B | The mapped bound value type |
| param | f | The bind function |
| returns | A new | |
method Effect<M, C> SelectMany <B, C> (Func<A, IO<B>> f, Func<A, B, C> project) Source #
Monadic bind operation, for chaining Proxy computations together.
Parameters
| type | B | The mapped bound value type |
| param | f | The bind function |
| returns | A new | |
method K<M, C> SelectMany <B, C> (Func<A, K<M, B>> bind, Func<A, B, C> project) Source #
Monadic bind operation, for chaining Effect computations together.
Parameters
| type | B | The mapped bound value type |
| param | f | The bind function |
| returns | A new | |
Effects represent a 'fused' set of producer, pipes, and consumer into one type.
It neither can neither yield nor be awaiting, it represents an entirely closed effect system.
Upstream | Downstream
+---------+
| |
Void <== <== Unit
| |
Unit ==> ==> Void
| | |
+----|----+
|
A