package preface

  1. Overview
  2. Docs
package preface
Legend:
Library
Module
Module type
Parameter
Class
Class type

Parameters

module Operation : Preface_specs.Alt.OPERATION with type 'a t = 'a Core.t
module Infix : Preface_specs.Alt.INFIX with type 'a t = 'a Operation.t

Signature

Type

type 'a t = 'a Infix.t

The type held by the Alt.

Functions

val combine : 'a t -> 'a t -> 'a t

Combine two values of 'a t into one.

val map : ('a -> 'b) -> 'a t -> 'b t

Mapping over from 'a to 'b over 'a t to 'b t.

val times_nel : int -> 'a t -> 'a t option

times_nel n x apply combine on x n times. If n is lower than 1 the function will returns None.

val reduce_nel : 'a t Preface_core.Nonempty_list.t -> 'a t

Reduce a Nonempty_list.t using combine.

val replace : 'a -> 'b t -> 'a t

Create a new 'a t, replacing all values in the 'b t by given a value of 'a.

val void : 'a t -> unit t

Create a new unit t, replacing all values in the 'a t by unit.

Infix operators

module Infix : Preface_specs.Alt.INFIX with type 'a t = 'a t
val (<|>) : 'a t -> 'a t -> 'a t

Infix version of CORE.combine

val (<$>) : ('a -> 'b) -> 'a t -> 'b t

Infix version of Preface_specs.Functor.CORE.map.

val (<&>) : 'a t -> ('a -> 'b) -> 'b t

Flipped and infix version of Preface_specs.Functor.CORE.map.

val (<$) : 'a -> 'b t -> 'a t

Infix version of Preface_specs.Functor.OPERATION.replace.

val ($>) : 'a t -> 'b -> 'b t

Flipped and infix version of Preface_specs.Functor.OPERATION.replace.

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