package tezos-lwt-result-stdlib
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=296bb5674bc6050afe6330326fbdd0dfc2255d414bfd6b79cc7666ac6b39316d
sha512=c061cd300a9410300851158d77bf8e56ca3c568b0b1161b38305e5b2efdcd9c746d391f832fdb2826f9a1d6babce10a9b764a4b04f5df42699f7314b9863123a
doc/bare_structs/Bare_structs/Seq_s/index.html
Module Bare_structs.Seq_sSource
include Bare_sigs.Seq_s.S
This is similar to S.t but the suspended node is a promise.
return_s p is a sequence with the value the promise p resolves to as its single element.
cons x s is the sequence containing x followed by s. It is a whole sequence if s is.
cons_s p s is the sequence containing the value the promise p resolves to, followed by s.
append s1 s2 is a sequence s containing the elements of s1 followed by the elements of s2.
first s resolves to None if s is empty (and its suspended node resolves), it resolves to Some x where x is the first element of s, it does not resolve if the promised node of s doesn't.
Note that first forces the first element of the sequence, which can have side-effects or be computationally expensive. Consider, e.g., the case where s = filter (fun …) s': first s can force multiple of the values from s'.
Similar to fold_left but applies to Lwt-suspended sequences. Because the nodes are suspended in promises, traversing may yield and, consequently, the function fold_left returns a promise.
val fold_left_e :
('a -> 'b -> ('a, 'trace) Stdlib.result) ->
'a ->
'b t ->
('a, 'trace) Stdlib.result Lwt.tSimilar to fold_left but wraps the traversal in result. The traversal is interrupted if one of the step returns an Error _.
Similar to fold_left but the folder is within Lwt.
val fold_left_es :
('a -> 'b -> ('a, 'trace) Stdlib.result Lwt.t) ->
'a ->
'b t ->
('a, 'trace) Stdlib.result Lwt.tSimilar to fold_left but the folder is within result-Lwt. Traversal is interrupted if one of the step resolves to an Error _.
val iter_e :
('a -> (unit, 'trace) Stdlib.result) ->
'a t ->
(unit, 'trace) Stdlib.result Lwt.tSimilar to iter but wraps the iteration in result. The iteration is interrupted if one of the steps returns an Error _.
Similar to iter but wraps the iteration in Lwt. Each step of the iteration is started after the previous one is resolved.
val iter_es :
('a -> (unit, 'trace) Stdlib.result Lwt.t) ->
'a t ->
(unit, 'trace) Stdlib.result Lwt.tSimilar to iter but wraps the iteration in result Lwt.t. Each step of the iteration is started after the previous one resolved. The iteration is interrupted if one of the promise is rejected of fulfilled with an Error _.
val iter_ep :
('a -> (unit, 'trace) Stdlib.result Lwt.t) ->
'a t ->
(unit, 'trace list) Stdlib.result Lwt.tSimilar to iter but wraps the iteration in result Lwt.t. The steps of the iteration are started concurrently: one iteration starts as soon as a node becomes resolved. The promise iter_ep resolves once all the promises of the traversal resolve. At this point it either:
- is rejected if at least one of the promises is, otherwise
- is fulfilled with
Error _if at least one of the promises is, otherwise - is fulfilled with
Ok ()if all the promises are.
Similar to iter but wraps the iteration in Lwt. The steps of the iteration are started concurrently: one iteration is started as soon as the node becomes resolved. The promise iter_p f s is resolved only once all the promises of the iteration are. At this point it is either fulfilled if all promises are, or rejected if at least one of them is.
Similar to filter but wraps the transformation in Lwt.t. Each test of the predicate is done sequentially, only starting once the previous one has resolved.
Similar to filter_map but within Lwt.t. Not lazy and not tail-recursive.