package async_smtp

  1. Overview
  2. Docs
package async_smtp
Legend:
Library
Module
Module type
Parameter
Class
Class type
module Reject_or_error : sig ... end
type 'a t = ('a, Reject_or_error.t) Async.Deferred.Result.t
include Core.Monad.S with type 'a t := '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 : sig ... end
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 Stdlib.ignore. Some monads still do let ignore = ignore_m for historical reasons.

val all : 'a t list -> 'a list t
val all_unit : unit t list -> unit t

Like all, but ensures that every monadic value in the list produces a unit value, all of which are discarded rather than being collected into a list.

module Let_syntax : sig ... end

These are convenient to have in scope when programming with a monad:

val exn : ?reject:Smtp_reply.t -> here:Core.Source_code_position.t -> Core.Exn.t -> _ t
val error : ?reject:Smtp_reply.t -> here:Core.Source_code_position.t -> Core.Error.t -> _ t
val error_string : ?reject:Smtp_reply.t -> here:Core.Source_code_position.t -> string -> _ t
val errorf : ?reject:Smtp_reply.t -> here:Core.Source_code_position.t -> ('a, unit, string, _ t) Core.format4 -> 'a
val reject : here:Core.Source_code_position.t -> Smtp_reply.t -> _ t
val tag : tag:string -> ?here:Core.Source_code_position.t -> 'a t -> 'a t
val tag' : ?tag:string -> ?here:Core.Source_code_position.t -> 'a t -> 'a t
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 : ?tag:string -> here:Core.Source_code_position.t -> 'a Async.Deferred.Or_error.t -> 'a t
val to_or_error : 'a t -> 'a Async.Deferred.Or_error.t
val return_or_error : ?tag:string -> here:Core.Source_code_position.t -> 'a Core.Or_error.t -> 'a t
val try_with : ?tag:string -> here:Core.Source_code_position.t -> (unit -> 'a Async.Deferred.t) -> 'a t

Capture any raised exceptions as Errors.

val try_with_join : ?tag:string -> here:Core.Source_code_position.t -> (unit -> 'a t) -> 'a t
val try_with_or_error : ?tag:string -> here:Core.Source_code_position.t -> (unit -> 'a Async.Deferred.Or_error.t) -> 'a t
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct