package biocaml

You can search for identifiers within the package.

in-package search v0.2.0

The OCaml Bioinformatics Library

Install

Dune Dependency

biocaml.org Readme Edit opam file Versions (5)

Authors

Maintainers

B

biocaml@googlegroups.com

Sources

v0.11.1.tar.gz

md5=e292efa2f61fec33dad63ec897106f59

sha512=35519bf3b1e67a9191ef9bb74eba0dae941e0d05bad89076a36f507dc5c2d105a03c1c917d5a3f7ed9d1da4acbf3199582f78c308aa2a5a22c21f743945c852b

doc/biocaml.unix/Biocaml_unix/Biocaml_result/index.html

Module `Biocaml_unix.Biocaml_result`Source

Extension of Core's Result. Internal use only.

include module type of Core_kernel.Result

Sourcetype ('a, 'b) t = ('a, 'b) Base.Result.t =

| Ok of 'a
| Error of 'b

include Bin_prot.Binable.S2 with type ('a, 'b) t := ('a, 'b) t

Sourceval bin_shape_t : Bin_prot.Shape.t -> Bin_prot.Shape.t -> Bin_prot.Shape.t

Sourceval bin_size_t : ('a, 'b, ('a, 'b) t) Bin_prot.Size.sizer2

Sourceval bin_write_t : ('a, 'b, ('a, 'b) t) Bin_prot.Write.writer2

Sourceval bin_read_t : ('a, 'b, ('a, 'b) t) Bin_prot.Read.reader2

Sourceval __bin_read_t__ : ('a, 'b, int -> ('a, 'b) t) Bin_prot.Read.reader2

Sourceval bin_writer_t : ('a, 'b, ('a, 'b) t) Bin_prot.Type_class.S2.writer

Sourceval bin_reader_t : ('a, 'b, ('a, 'b) t) Bin_prot.Type_class.S2.reader

Sourceval bin_t : ('a, 'b, ('a, 'b) t) Bin_prot.Type_class.S2.t

include Ppx_sexp_conv_lib.Sexpable.S2 with type ('a, 'b) t := ('a, 'b) t

include module type of Base.Result with type ('a, 'b) t := ('a, 'b) t

Source

val t_of_sexp : 
  (Sexplib0__.Sexp.t -> 'a) ->
  (Sexplib0__.Sexp.t -> 'b) ->
  Sexplib0__.Sexp.t ->
  ('a, 'b) t

Source

val sexp_of_t : 
  ('a -> Sexplib0__.Sexp.t) ->
  ('b -> Sexplib0__.Sexp.t) ->
  ('a, 'b) t ->
  Sexplib0__.Sexp.t

Source

val compare : 
  ('ok -> 'ok -> int) ->
  ('err -> 'err -> int) ->
  ('ok, 'err) t ->
  ('ok, 'err) t ->
  int

Source

val equal : 
  ('ok -> 'ok -> bool) ->
  ('err -> 'err -> bool) ->
  ('ok, 'err) t ->
  ('ok, 'err) t ->
  bool

Source

val hash_fold_t : 
  (Base.Hash.state -> 'ok -> Base.Hash.state) ->
  (Base.Hash.state -> 'err -> Base.Hash.state) ->
  Base.Hash.state ->
  ('ok, 'err) t ->
  Base.Hash.state

include Base.Monad.S2 with type ('a, 'err) t := ('a, 'err) t

Sourceval (>>=) : ('a, 'e) t -> ('a -> ('b, 'e) t) -> ('b, 'e) t

Sourceval (>>|) : ('a, 'e) t -> ('a -> 'b) -> ('b, 'e) t

Sourcemodule Let_syntax = Base.Result.Let_syntax

Sourcemodule Monad_infix = Base.Result.Monad_infix

Sourceval bind : ('a, 'e) t -> f:('a -> ('b, 'e) t) -> ('b, 'e) t

Sourceval return : 'a -> ('a, _) t

Sourceval join : (('a, 'e) t, 'e) t -> ('a, 'e) t

Sourceval ignore_m : (_, 'e) t -> (unit, 'e) t

Sourceval all : ('a, 'e) t list -> ('a list, 'e) t

Sourceval all_unit : (unit, 'e) t list -> (unit, 'e) t

Sourceval invariant : ('a -> unit) -> ('b -> unit) -> ('a, 'b) t -> unit

Sourceval fail : 'err -> (_, 'err) t

Sourceval failf : ('a, unit, string, (_, string) t) format4 -> 'a

e.g., failf "Couldn't find bloogle %s" (Bloogle.to_string b).

Sourceval is_ok : (_, _) t -> bool

Sourceval is_error : (_, _) t -> bool

Sourceval ok : ('ok, _) t -> 'ok option

Sourceval ok_exn : ('ok, exn) t -> 'ok

Sourceval ok_or_failwith : ('ok, string) t -> 'ok

Sourceval error : (_, 'err) t -> 'err option

Sourceval of_option : 'ok option -> error:'err -> ('ok, 'err) t

Sourceval iter : ('ok, _) t -> f:('ok -> unit) -> unit

Sourceval iter_error : (_, 'err) t -> f:('err -> unit) -> unit

Sourceval map : ('ok, 'err) t -> f:('ok -> 'c) -> ('c, 'err) t

Sourceval map_error : ('ok, 'err) t -> f:('err -> 'c) -> ('ok, 'c) t

Source

val combine : 
  ('ok1, 'err) t ->
  ('ok2, 'err) t ->
  ok:('ok1 -> 'ok2 -> 'ok3) ->
  err:('err -> 'err -> 'err) ->
  ('ok3, 'err) t

Returns Ok if both are Ok and Error otherwise.

Sourceval combine_errors : ('ok, 'err) t list -> ('ok list, 'err list) t

combine_errors ts returns Ok if every element in ts is Ok, else it returns Error with all the errors in ts.

This is similar to all from Monad.S2, with the difference that all only returns the first error.

Sourceval combine_errors_unit : (unit, 'err) t list -> (unit, 'err list) t

combine_errors_unit returns Ok if every element in ts is Ok (), else it returns Error with all the errors in ts, like combine_errors.

Sourceval to_either : ('ok, 'err) t -> ('ok, 'err) Base__.Either0.t

to_either is useful with List.partition_map. For example:

  let ints, exns =
    List.partition_map ["1"; "two"; "three"; "4"] ~f:(fun string ->
      Result.to_either (Result.try_with (fun () -> Int.of_string string)))

Sourceval of_either : ('ok, 'err) Base__.Either0.t -> ('ok, 'err) t

Sourceval ok_fst : ('ok, 'err) t -> ('ok, 'err) Base__.Either0.t

deprecated [since 2020-01] Use [to_either] instead.

Sourceval ok_if_true : bool -> error:'err -> (unit, 'err) t

ok_if_true returns Ok () if bool is true, and Error error if it is false.

Sourceval try_with : (unit -> 'a) -> ('a, exn) t

Sourcemodule Export = Base.Result.Export

Sourcemodule Stable = Core_kernel.Result.Stable

Sourcemodule List : sig ... end

package biocaml

Install

Dune Dependency

Authors

Maintainers

Sources

doc/biocaml.unix/Biocaml_unix/Biocaml_result/index.html

Module Biocaml_unix.Biocaml_resultSource

Module `Biocaml_unix.Biocaml_result`Source