Generalized API changes

[neoeinstein]

This issue is a work in progress, but below you will find a diff with general changes to the API to tidy up some things and make naming consistent.

Signature Changes

Presume that any obsolete API not mentioned below will be removed.

 module Job =
-  val result: 'x -> Job<'x>
-  val unit: unit -> Job<unit>
-  val abort: unit -> Job<'x>
-  val raises: exn -> Job<'x>
+  val always: 'x -> Job<'x>
+  val unit: Job<unit>
+  val never: Job<'x>
+  val fail: exn -> Job<'x>

-  val Ignore: Job<_> -> Job<unit>
+  val ignore: Job<_> -> Job<unit>

-  val catch: Job<'x> -> Job<Choice<'x, exn>>
+  val catch: Job<'x> -> Job<Result<'x, exn>>

+  val andThen: ('x   -> #Job<'y>) -> Job<'x> -> Job<'y>
+  val andMap: Job<'x> -> Job<'x -> 'y> -> Job<'y>

 module Alt =
   val always: 'x -> Alt<'x>
-  val unit: unit -> Alt<unit>
-  val never: unit -> Alt<'x>
-  val zero: unit -> Alt<unit>
-  val raises: exn -> Alt<'x>
+  val unit: Alt<unit>
+  val never: Alt<'x>
+  val fail: exn -> Alt<'x>

-  val Ignore: Alt<_> -> Alt<unit>
+  val ignore: Alt<_> -> Alt<unit>

 type Promise<'x> =
   inherit Alt<'x>
-  new: unit -> Promise<'x>
-  new: Job<'x> -> Promise<'x>
-  new: 'x -> Promise<'x>
-  new: exn -> Promise<'x>

 module Promise =
   module Now =
-    val inline delay: Job<'x> -> Promise<'x>
-    val inline withValue: 'x -> Promise<'x>
-    val inline withFailure: exn -> Promise<'x>
-    val never: unit -> Promise<'x>
+  val always: 'x -> Promise<'x>
+  val unit: Promise<unit>
+  val never: Promise<'x>
+  val fail: exn -> Promise<'x>

+  val memo: Job<'x> -> Promise<'x>
+  val memoFun: (unit -> 'x) -> Promise<'x>
+  val memoJob: (unit -> #Job<'x>) -> Promise<'x>

   val queue: Job<'x> -> Job<Promise<'x>>
+  val queueFun: (unit -> 'x) -> Job<Promise<'x>>
+  val queueJob: (unit -> #Job<'x>) -> Job<Promise<'x>>

   val start: Job<'x> -> Job<Promise<'x>>
+  val startFun: (unit -> 'x) -> Job<Promise<'x>>
+  val startJob: (unit -> #Job<'x>) -> Job<Promise<'x>>

   val read: Promise<'x> -> Alt<'x>

 type IVar<'x> =
   inherit Promise<'x>
   new: unit -> IVar<'x>
-  new: 'x -> IVar<'x>
-  new: exn -> IVar<'x>

 module IVar =
+  val unit: IVar<unit>
+  val createFull: 'x -> IVar<'x>
+  val createFail: exn -> IVar<'x>

 type MVar<'x> =
   inherit Alt<'x>
   new: unit -> MVar<'x>
-  new: 'x -> MVar<'x>

 module MVar =
+  val createFull: 'x -> MVar<'x>

[haf]

Also, please

module Hopac =
- val timeOut: TimeSpan -> Alt<unit>
+ val timeout: TimeSpan -> Alt<unit>
- val timeOutMillis: int -> Alt<unit>
+ val timeoutMillis: int -> Alt<unit>

To make the API use the compsci word

[haf]

Another wish: could we rename Hopac.Infixes to Hopac.Operators to match Chiron, Aether, Suave etc...?

[polytypic]

As much as possible it would of course be nice to follow any de facto standard naming/structuring conventions. But such changes also cause a lot of migration pain, which is why I never fixed the timeOut mistake, BTW. The name change from timeOut to timeout would only be cosmetic as the name timeOut is unlikely to confuse anyone on a semantic level. Still, if a lot of renamings are going to be done, then why not fix such mistakes as well.