Modulegrapesy-1.1.1Haskell2010

Network.GRPC.Common.StreamElem

Positioned elements

Intended for qualified import.

import Network.GRPC.Common.StreamElem qualified as StreamElem

Network.GRPC.Common (intended for unqualified import) exports StreamElem(..), but none of the operations on StreamElem.

datadata StreamElem b a

An element positioned in a stream

StreamElem !a
Element in the stream
The final element in a stream may or may not be marked as final; if it is not, we will only discover after receiving the final element that it was in fact final. Moreover, we do not know ahead of time whether or not the final element will be marked.
When we receive an element and it is not marked final, this might therefore mean one of two things, without being able to tell which:
- We are dealing with a stream in which the final element is not marked.
In this case, the element may or may not be the final element; if it is, the next value will be NoMoreElems (but waiting for the next value might mean a blocking call).
- We are dealing with a stream in which the final element is marked.
In this case, this element is not final (and the final element, when we receive it, will be tagged as Final).
FinalElem !a !b
We received the final element
The final element is annotated with some additional information.
NoMoreElems !b
There are no more elements
This is used in two situations:
- The stream didn't contain any elements at all.
- The final element was not marked as final. See StreamElem for detailed additional discussion.

Instances8Bifoldable, Bifunctor, Bitraversable, Functor, Foldable, Traversable, …

Bifoldable StreamElemDefined in grapesy-1.1.1 · Network.GRPC.Common.StreamElem
Bifunctor StreamElemDefined in grapesy-1.1.1 · Network.GRPC.Common.StreamElem
Bitraversable StreamElemDefined in grapesy-1.1.1 · Network.GRPC.Common.StreamElem
Functor (StreamElem b)Defined in grapesy-1.1.1 · Network.GRPC.Common.StreamElem
Foldable (StreamElem b)Defined in grapesy-1.1.1 · Network.GRPC.Common.StreamElem
Traversable (StreamElem b)Defined in grapesy-1.1.1 · Network.GRPC.Common.StreamElem
(Eq a, Eq b) => Eq (StreamElem b a)Defined in grapesy-1.1.1 · Network.GRPC.Common.StreamElem
(Show a, Show b) => Show (StreamElem b a)Defined in grapesy-1.1.1 · Network.GRPC.Common.StreamElem

Conversion

1 declaration

valuevalue :: StreamElem b a -> Maybe a

Value of the element, if one is present

Returns Nothing in case of NoMoreElems

Using this function loses the information whether the item was the final item; this information can be recovered using whenDefinitelyFinal.

0 declarations

5 declarations

valuemapM_ :: Monad m => (StreamElem b a -> m ()) -> [a] -> b -> m ()

Invoke the callback for each element

The final element is marked using FinalElem; the callback is only invoked on NoMoreElems if the list is empty.

   mapM_ f ([1,2,3], b)
== do f (StreamElem 1)
      f (StreamElem 2)
      f (FinalElem 3 b)

   mapM_ f ([], b)
== do f (NoMoreElems b)

valueforM_ :: Monad m => [a] -> b -> (StreamElem b a -> m ()) -> m ()

Like mapM_, but with the arguments in opposite order

valuewhileNext_ :: Monad m => m (StreamElem b a) -> (a -> m ()) -> m b

Invoke a function on each NextElem, until FinalElem or NoMoreElems

valuecollect :: Monad m => m (StreamElem b a) -> m ([a], b)

Invoke the callback until FinalElem or NoMoreElems, collecting results

valuewhenDefinitelyFinal

Do we have evidence that this element is the final one?

The callback is not called on StreamElem; this does not mean that the element was not final; see StreamElem for detailed discussion.