LanguageExt.Core

LanguageExt.Core Effects Pipes Consumer

Contents

class Consumer Source #

Consumers both can only be awaiting

  Upstream | Downstream
      +---------+
      |         |
Unit <==       <== Unit
      |         |
 IN  ==>       ==> Void
      |    |    |
      +----|----+
           |
           A

Methods

method Consumer<RT, A, R> Pure <RT, A, R> (R value) Source #

where RT : struct, HasCancel<RT>

Monad return / pure

method Consumer<RT, A, A> awaiting <RT, A> () Source #

where RT : struct, HasCancel<RT>

Wait for a value from upstream (whilst in a consumer)

This is the simpler version (fewer generic arguments required) of await that works for consumers. In pipes, use Pipe.await

method Consumer<RT, A, R> lift <RT, A, R> (Aff<R> ma) Source #

where RT : struct, HasCancel<RT>

Lift the IO monad into the Consumer monad transformer (a specialism of the Proxy monad transformer)

method Consumer<RT, A, R> lift <RT, A, R> (Eff<R> ma) Source #

where RT : struct, HasCancel<RT>

Lift the IO monad into the Consumer monad transformer (a specialism of the Proxy monad transformer)

method Consumer<RT, A, R> lift <RT, A, R> (Aff<RT, R> ma) Source #

where RT : struct, HasCancel<RT>

Lift the IO monad into the Consumer monad transformer (a specialism of the Proxy monad transformer)

method Consumer<RT, A, R> lift <RT, A, R> (Eff<RT, R> ma) Source #

where RT : struct, HasCancel<RT>

Lift the IO monad into the Consumer monad transformer (a specialism of the Proxy monad transformer)

method Consumer<RT, A, Unit> lift <RT, A> (Aff<RT, Unit> ma) Source #

where RT : struct, HasCancel<RT>

Lift the IO monad into the Consumer monad transformer (a specialism of the Proxy monad transformer)

method Consumer<RT, A, Unit> lift <RT, A> (Eff<RT, Unit> ma) Source #

where RT : struct, HasCancel<RT>

Lift the IO monad into the Consumer monad transformer (a specialism of the Proxy monad transformer)

method Consumer<RT, IN, R> use <RT, IN, R> (Aff<R> ma) Source #

where RT : struct, HasCancel<RT>
where R : IDisposable

Lift am IO monad into the Proxy monad transformer

method Consumer<RT, IN, R> use <RT, IN, R> (Eff<R> ma) Source #

where RT : struct, HasCancel<RT>
where R : IDisposable

Lift am IO monad into the Proxy monad transformer

method Consumer<RT, IN, R> use <RT, IN, R> (Aff<RT, R> ma) Source #

where RT : struct, HasCancel<RT>
where R : IDisposable

Lift am IO monad into the Proxy monad transformer

method Consumer<RT, IN, R> use <RT, IN, R> (Eff<RT, R> ma) Source #

where RT : struct, HasCancel<RT>
where R : IDisposable

Lift am IO monad into the Proxy monad transformer

method Consumer<RT, IN, R> use <RT, IN, R> (Aff<R> ma, Func<R, Unit> dispose) Source #

where RT : struct, HasCancel<RT>

Lift am IO monad into the Proxy monad transformer

method Consumer<RT, IN, R> use <RT, IN, R> (Eff<R> ma, Func<R, Unit> dispose) Source #

where RT : struct, HasCancel<RT>

Lift am IO monad into the Proxy monad transformer

method Consumer<RT, IN, R> use <RT, IN, R> (Aff<RT, R> ma, Func<R, Unit> dispose) Source #

where RT : struct, HasCancel<RT>

Lift am IO monad into the Proxy monad transformer

method Consumer<RT, IN, R> use <RT, IN, R> (Eff<RT, R> ma, Func<R, Unit> dispose) Source #

where RT : struct, HasCancel<RT>

Lift am IO monad into the Proxy monad transformer

method Consumer<RT, IN, Unit> release <RT, IN, R> (R dispose) Source #

where RT : struct, HasCancel<RT>

Release a previously used resource

method Consumer<RT, A, R> mapM <RT, A, R> (Func<A, Aff<RT, Unit>> f) Source #

where RT : struct, HasCancel<RT>

Consume all values using a monadic function

method Consumer<RT, A, Unit> mapM <RT, A> (Func<A, Aff<RT, Unit>> f) Source #

where RT : struct, HasCancel<RT>

Consume all values using a monadic function

method Consumer<RT, A, R> mapM <RT, A, R> (Func<A, Eff<RT, Unit>> f) Source #

where RT : struct, HasCancel<RT>

Consume all values using a monadic function

method Consumer<RT, A, Unit> mapM <RT, A> (Func<A, Eff<RT, Unit>> f) Source #

where RT : struct, HasCancel<RT>

Consume all values using a monadic function

method Consumer<RT, A, R> mapM <RT, A, R> (Func<A, Aff<Unit>> f) Source #

where RT : struct, HasCancel<RT>

Consume all values using a monadic function

method Consumer<RT, A, Unit> mapM <RT, A> (Func<A, Aff<Unit>> f) Source #

where RT : struct, HasCancel<RT>

Consume all values using a monadic function

method Consumer<RT, A, R> mapM <RT, A, R> (Func<A, Eff<Unit>> f) Source #

where RT : struct, HasCancel<RT>

Consume all values using a monadic function

method Consumer<RT, A, Unit> mapM <RT, A> (Func<A, Eff<Unit>> f) Source #

where RT : struct, HasCancel<RT>

Consume all values using a monadic function

class Consumer <RT, IN, A> Source #

where RT : struct, HasCancel<RT>

Consumers both can only be awaiting

  Upstream | Downstream
      +---------+
      |         |
Unit <==       <== Unit
      |         |
 IN  ==>       ==> Void
      |    |    |
      +----|----+
           |
           A

Fields

field Proxy<RT, Unit, IN, Unit, Void, A> Value Source #

Constructors

constructor Consumer (Proxy<RT, Unit, IN, Unit, Void, A> value) Source #

Constructor

Parameters

param value

Correctly shaped Proxy that represents a Consumer

Methods

method Proxy<RT, Unit, IN, Unit, Void, 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 Proxy type from a more specialised type

method Proxy<RT, Unit, IN, Unit, Void, S> Bind <S> (Func<A, Proxy<RT, Unit, IN, Unit, Void, 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 Proxy that represents the composition of this Proxy and the result of the bind operation

method Consumer<RT, IN, B> Bind <B> (Func<A, Consumer<RT, IN, 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 Proxy that represents the composition of this Proxy and the result of the bind operation

method Proxy<RT, Unit, IN, Unit, Void, S> Map <S> (Func<A, S> 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 Proxy that represents the composition of this Proxy and the result of the map operation

method Consumer<RT, IN, B> SelectMany <B> (Func<A, Consumer<RT, IN, 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 Proxy that represents the composition of this Proxy and the result of the bind operation

method Consumer<RT, IN, C> SelectMany <B, C> (Func<A, Consumer<RT, IN, 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 Proxy that represents the composition of this Proxy and the result of the bind operation

method Consumer<RT, IN, B> Select <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 Proxy that represents the composition of this Proxy and the result of the map operation

method Proxy<RT, Unit, IN, C1, C, A> For <C1, C> (Func<Void, Proxy<RT, Unit, IN, C1, C, Unit>> body) Source #

For(body) loops over the Proxy p replacing each yield with body

Parameters

param body

Any yield found in the Proxy will be replaced with this function. It will be composed so that the value yielded will be passed to the argument of the function. That returns a Proxy to continue the processing of the computation

returns

A new Proxy that represents the composition of this Proxy and the function provided

method Proxy<RT, Unit, IN, Unit, Void, S> Action <S> (Proxy<RT, Unit, IN, Unit, Void, S> r) Source #

Applicative action

Invokes this Proxy, then the Proxy r

Parameters

param r

Proxy to run after this one

method Proxy<RT, UOutA, AUInA, Unit, Void, A> PairEachRequestWithRespond <UOutA, AUInA> ( Func<Unit, Proxy<RT, UOutA, AUInA, Unit, IN, 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<RT, UOutA, AUInA, Unit, Void, A> ReplaceRequest <UOutA, AUInA> ( Func<Unit, Proxy<RT, UOutA, AUInA, Unit, Void, IN>> 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<RT, Unit, IN, DInC, DOutC, A> PairEachRespondWithRequest <DInC, DOutC> ( Func<Void, Proxy<RT, Unit, Void, DInC, DOutC, 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<RT, Unit, IN, DInC, DOutC, A> ReplaceRespond <DInC, DOutC> ( Func<Void, Proxy<RT, Unit, IN, DInC, DOutC, 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<RT, Void, Unit, IN, Unit, A> Reflect () Source #

Reverse the arrows of the Proxy to find its dual.

Parameters

returns

The dual of this

method Proxy<RT, Unit, IN, Unit, Void, 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<RT, Unit, IN, Unit, Void, A> value) Source #

method Consumer<RT, IN, B> SelectMany <B> (Func<A, Release<B>> bind) Source #

Monadic bind operation, for chaining Proxy computations together.

Parameters

type B

The mapped bound value type

param bind

The bind function

returns

A new Proxy that represents the composition of this Proxy and the result of the bind operation

method Consumer<RT, IN, C> SelectMany <B, C> (Func<A, Release<B>> bind, Func<A, B, C> project) Source #

Monadic bind operation, for chaining Proxy computations together.

Parameters

type B

The mapped bound value type

param bind

The bind function

returns

A new Proxy that represents the composition of this Proxy and the result of the bind operation

method Consumer<RT, IN, B> SelectMany <B> (Func<A, Consumer<IN, B>> bind) 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 Proxy that represents the composition of this Proxy and the result of the bind operation

method Consumer<RT, IN, C> SelectMany <B, C> (Func<A, Consumer<IN, B>> bind, 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 Proxy that represents the composition of this Proxy and the result of the bind operation

method Consumer<RT, IN, B> SelectMany <B> (Func<A, ConsumerLift<RT, IN, B>> bind) 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 Proxy that represents the composition of this Proxy and the result of the bind operation

method Consumer<RT, IN, C> SelectMany <B, C> (Func<A, ConsumerLift<RT, IN, B>> bind, 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 Proxy that represents the composition of this Proxy and the result of the bind operation

Operators

operator | (IN p1, Consumer<RT, IN, A> p2) Source #

Compose an IN and a Consumer together into an Effect. This effectively creates a singleton Producer from the IN value, and composes it with the Consumer into an Effect that can be run.

Parameters

param p1

Single input value

param p2

Consumer

returns

Effect

operator & ( Consumer<RT, IN, A> lhs, Consumer<RT, IN, A> rhs) Source #

Chain one consumer's set of awaits after another