Module Async_smtp.Smtp_monad

type 'a t = ('a, Async_smtp__.Reject_or_error.t) Async.Deferred.Result.t
include Core.Monad.S with type a t := a t
type 'a t
include Base__.Monad_intf.S_without_syntax with type a t := a t
type 'a t

A monad is an abstraction of the concept of sequencing of computations. A value of type 'a monad represents a computation that returns a value of type 'a.

include Base__.Monad_intf.Infix with type a t := a t
type 'a t
val (>>=) : 'a t ‑> ('a ‑> 'b t) ‑> 'b t

t >>= f returns a computation that sequences the computations represented by two monad elements. The resulting computation first does t to yield a value v, and then runs the computation returned by f v.

val (>>|) : 'a t ‑> ('a ‑> 'b) ‑> 'b t

t >>| f is t >>= (fun a -> return (f a)).

module Monad_infix : Base__.Monad_intf.Infix with type a t := a t
val bind : 'a t ‑> f:('a ‑> 'b t) ‑> 'b t

bind t ~f = t >>= f

val return : 'a ‑> 'a t

return v returns the (trivial) computation that returns v.

val map : 'a t ‑> f:('a ‑> 'b) ‑> 'b t

map t ~f is t >>| f.

val join : 'a t t ‑> 'a t

join t is t >>= (fun t' -> t').

val ignore_m : 'a t ‑> unit t

ignore_m t is map t ~f:(fun _ -> ()). ignore_m used to be called ignore, but we decided that was a bad name, because it shadowed the widely used Pervasives.ignore. Some monads still do let ignore = ignore_m for historical reasons.

val all : 'a t list ‑> 'a list t
val all_ignore : unit t list ‑> unit t
include Base__.Monad_intf.Syntax with type a t := a t
type 'a t
module Let_syntax : sig ... end
val exn : (Core.Exn.t ‑> _ t) Async_smtp__.With_info.with_reject
val error : (Core.Error.t ‑> _ t) Async_smtp__.With_info.with_reject
val error_string : (string ‑> _ t) Async_smtp__.With_info.with_reject
val errorf : (('a, unit, string, _ t) Core.format4 ‑> 'a) Async_smtp__.With_info.with_reject
val reject : (Smtp_reply.t ‑> _ t) Async_smtp__.With_info.with_here
val tag : tag:string ‑> ('a t ‑> 'a t) Async_smtp__.With_info.with_maybe_here
val tag' : ?⁠tag:string ‑> ('a t ‑> 'a t) Async_smtp__.With_info.with_maybe_here
val ok : 'a Async.Deferred.t ‑> 'a t

Helpers to convert to an 'a t. Unlike try_with* below, these will not capture raised exceptions.

val of_or_error : ('a Async.Deferred.Or_error.t ‑> 'a t) Async_smtp__.With_info.with_tag
val return_or_error : ('a Core.Or_error.t ‑> 'a t) Async_smtp__.With_info.with_tag
val try_with : ((unit ‑> 'a Async.Deferred.t) ‑> 'a t) Async_smtp__.With_info.with_tag

Capture any raised exceptions as Errors.

val try_with_join : ((unit ‑> 'a t) ‑> 'a t) Async_smtp__.With_info.with_tag
val try_with_or_error : ((unit ‑> 'a Async.Deferred.Or_error.t) ‑> 'a t) Async_smtp__.With_info.with_tag