fsharp.control.asyncseq - nuget Package Compare versions

Comparing version 1.14.0 to 1.13.0

FSharp.Control.AsyncSeq.nuspec

@@ -5,3 +5,3 @@ <?xml version="1.0" encoding="utf-8" standalone="yes"?>
     <id>FSharp.Control.AsyncSeq</id>
-    <version>1.14</version>
+    <version>1.13</version>
     <authors>Tomasz Petricek, David Thomas, Ryan Riley, Steffen Forkmann</authors>
@@ -14,5 +14,5 @@ <owners>Tomasz Petricek, David Thomas, Ryan Riley, Steffen Forkmann</owners>
     <summary>Asynchronous sequences for F#</summary>
-    <releaseNotes>Cancellable AsyncSeq.toBlockingSeq
-Fix AsyncSeq.scanAsync to also return first state
-Add a signature file</releaseNotes>
+    <releaseNotes>Renamed to FSharp.Control.AsyncSeq
+Remove surface area
+Hide Nil/Cons from representation of AsyncSeq</releaseNotes>
     <copyright>Copyright 2015</copyright>
@@ -19,0 +19,0 @@ <tags>F# async fsharpx</tags>

lib/net40/FSharp.Control.AsyncSeq.xml

@@ -5,2 +5,7 @@ <?xml version="1.0" encoding="utf-8"?>
 <members>
+<member name="T:FSharp.Control.Agent`1">
+<summary>
+ Type alias for F# mailbox processor type
+</summary>
+</member>
 <member name="">
@@ -180,46 +185,101 @@
 </member>
-<member name="M:FSharp.Control.AsyncSeq.AsyncSeqBuilder.Zero``1">
-<summary>
- Implements empty for the asyncSeq computation builder.
-</summary>
+<member name="">
+
 </member>
-<member name="M:FSharp.Control.AsyncSeq.AsyncSeqBuilder.YieldFrom``1(``0)">
+<member name="">
+
+</member>
+<member name="">
+
+</member>
+<member name="T:FSharp.Control.ObservableUpdate`1">
 <summary>
- Implements &quot;yield!&quot; for the asyncSeq computation builder.
+ Union type that represents different messages that can be sent to the
+ IObserver interface. The IObserver type is equivalent to a type that has
+ just OnNext method that gets &apos;ObservableUpdate&apos; as an argument.
 </summary>
 </member>
-<member name="M:FSharp.Control.AsyncSeq.AsyncSeqBuilder.Yield``1(``0)">
+<member name="M:FSharp.Control.AsyncExtensions.Async.chooseBoth.Static``1(Microsoft.FSharp.Control.FSharpAsync{``0},Microsoft.FSharp.Control.FSharpAsync{``0})">
 <summary>
- Implements &quot;yield&quot; for the asyncSeq computation builder.
+ Creates a computation which produces a tuple consiting of the value produces by the first
+ argument computation to complete and a handle to the other computation. The second computation
+ to complete is memoized.
 </summary>
 </member>
-<member name="M:FSharp.Control.AsyncSeq.AsyncSeqBuilder.While``1(Microsoft.FSharp.Core.FSharpFunc{Microsoft.FSharp.Core.Unit,System.Boolean},Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}})">
+<member name="M:FSharp.Control.AsyncExtensions.Async.bind.Static``2(Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Control.FSharpAsync{``1}},Microsoft.FSharp.Control.FSharpAsync{``0})">
 <summary>
- Implements &quot;while&quot; for the asyncSeq computation builder.
+ Creates an async computation which binds the result of the specified 
+ async computation to the specified function. The computation produced 
+ by the specified function is returned.
 </summary>
 </member>
-<member name="M:FSharp.Control.AsyncSeq.AsyncSeqBuilder.Using``2(``0,Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``1}}})">
+<member name="M:FSharp.Control.AsyncExtensions.Async.map.Static``2(Microsoft.FSharp.Core.FSharpFunc{``0,``1},Microsoft.FSharp.Control.FSharpAsync{``0})">
 <summary>
- Implements &quot;use&quot; for the asyncSeq computation builder.
+ Creates an async computation which maps a function f over the 
+ value produced by the specified asynchronous computation.
 </summary>
 </member>
-<member name="M:FSharp.Control.AsyncSeq.AsyncSeqBuilder.TryWith``1(Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}},Microsoft.FSharp.Core.FSharpFunc{System.Exception,Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}}})">
+<member name="M:FSharp.Control.AsyncExtensions.Async.Parallel.Static``2(Microsoft.FSharp.Control.FSharpAsync{``0},Microsoft.FSharp.Control.FSharpAsync{``1})">
 <summary>
- Implements &quot;try-with&quot; for the asyncSeq computation builder.
+ Creates an async computations which runs the specified computations
+ in parallel and returns their results.
 </summary>
 </member>
-<member name="M:FSharp.Control.AsyncSeq.AsyncSeqBuilder.TryFinally``1(Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}},Microsoft.FSharp.Core.FSharpFunc{Microsoft.FSharp.Core.Unit,Microsoft.FSharp.Core.Unit})">
+<member name="M:FSharp.Control.AsyncExtensions.Async.StartDisposable.Static(Microsoft.FSharp.Control.FSharpAsync{Microsoft.FSharp.Core.Unit})">
 <summary>
- Implements &quot;try-finally&quot; for the asyncSeq computation builder.
+ Starts the specified operation using a new CancellationToken and returns
+ IDisposable object that cancels the computation. This method can be used
+ when implementing the Subscribe method of IObservable interface.
 </summary>
 </member>
-<member name="M:FSharp.Control.AsyncSeq.AsyncSeqBuilder.Return``2(``0)">
+<member name="T:FSharp.Control.AsyncExtensions">
+
+</member>
+<member name="">
+
+</member>
+<member name="">
+
+</member>
+<member name="T:FSharp.Control.AsyncOps">
+
+</member>
+<member name="">
+
+</member>
+<member name="">
+
+</member>
+<member name="T:FSharp.Control.AsyncSeq.BufferMessage`1">
 <summary>
- Implements &quot;return&quot; for the asyncSeq computation builder.
+ A helper type for implementation of buffering when converting 
+ observable to an asynchronous sequence
 </summary>
 </member>
+<member name="">
+
+</member>
+<member name="">
+
+</member>
+<member name="">
+
+</member>
+<member name="">
+
+</member>
+<member name="">
+
+</member>
+<member name="">
+
+</member>
+<member name="">
+
+</member>
+<member name="">
+
+</member>
 <member name="M:FSharp.Control.AsyncSeq.AsyncSeqBuilder.For``2(Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}},Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``1}}})">
 <summary>
- Implements &quot;for&quot; loops for the asyncSeq computation builder.
-
  Asynchronous for loop - for all elements from the input sequence,
@@ -236,21 +296,13 @@ generate all elements produced by the body (asynchronously). See
 </member>
-<member name="M:FSharp.Control.AsyncSeq.AsyncSeqBuilder.Delay``1(Microsoft.FSharp.Core.FSharpFunc{Microsoft.FSharp.Core.Unit,Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}}})">
-<summary>
- Implements delay for the asyncSeq computation builder.
-</summary>
+<member name="">
+
 </member>
-<member name="M:FSharp.Control.AsyncSeq.AsyncSeqBuilder.Combine``1(Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}},Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}})">
-<summary>
- Implements sequential composition for the asyncSeq computation builder.
-</summary>
+<member name="">
+
 </member>
-<member name="M:FSharp.Control.AsyncSeq.AsyncSeqBuilder.Bind``2(Microsoft.FSharp.Control.FSharpAsync{``0},Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``1}}})">
-<summary>
- Implements binding for the asyncSeq computation builder.
-</summary>
+<member name="">
+
 </member>
-<member name="M:FSharp.Control.AsyncSeq.AsyncSeqBuilder.#ctor">
-<summary>
- Internal use only
-</summary>
+<member name="">
+
 </member>
@@ -294,3 +346,3 @@ <member name="T:FSharp.Control.AsyncSeq.AsyncSeqBuilder">
 </member>
-<member name="M:FSharp.Control.AsyncSeq.interleave``2(Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}},Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``1}})">
+<member name="M:FSharp.Control.AsyncSeq.interleave``2">
 <summary>
@@ -455,2 +507,10 @@ Interleaves two async sequences into a resulting sequence. The provided
 </member>
+<member name="M:FSharp.Control.AsyncSeq.ofObservableUsingAgent``1(System.IObservable{``0},Microsoft.FSharp.Core.FSharpFunc{Microsoft.FSharp.Control.FSharpMailboxProcessor{FSharp.Control.AsyncSeq.BufferMessage{FSharp.Control.ObservableUpdate{``0}}},Microsoft.FSharp.Control.FSharpAsync{Microsoft.FSharp.Core.Unit}})">
+<summary>
+ Converts observable to an asynchronous sequence using an agent with
+ a body specified as the argument. The returnd async sequence repeatedly 
+ sends &apos;Get&apos; message to the agent to get the next element. The observable
+ sends &apos;Put&apos; message to the agent (as new inputs are generated).
+</summary>
+</member>
 <member name="M:FSharp.Control.AsyncSeq.ofSeq``1(System.Collections.Generic.IEnumerable{``0})">
@@ -574,2 +634,5 @@ <summary>
 </member>
+<member name="">
+
+</member>
 <member name="M:FSharp.Control.AsyncSeq.collect``2(Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``1}}},Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}})">
@@ -584,2 +647,23 @@ <summary>
 </member>
+<member name="M:FSharp.Control.AsyncSeq.tryFinally``1(Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}},Microsoft.FSharp.Core.FSharpFunc{Microsoft.FSharp.Core.Unit,Microsoft.FSharp.Core.Unit})">
+<summary>
+ Implements the &apos;TryFinally&apos; functionality for computation builder
+</summary>
+</member>
+<member name="M:FSharp.Control.AsyncSeq.tryWith``1(Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}},Microsoft.FSharp.Core.FSharpFunc{System.Exception,Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}}})">
+<summary>
+ Implements the &apos;TryWith&apos; functionality for computation builder
+</summary>
+</member>
+<member name="M:FSharp.Control.AsyncSeq.tryNext``1(Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}})">
+<summary>
+ Tries to get the next element of an asynchronous sequence
+ and returns either the value or an exception
+</summary>
+</member>
+<member name="P:FSharp.Control.AsyncSeq.asyncSeq">
+<summary>
+ Builds an asynchronou sequence using the computation builder syntax
+</summary>
+</member>
 <member name="M:FSharp.Control.AsyncSeq.append``1(Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}},Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}})">
@@ -612,3 +696,5 @@ <summary>
 <member name="T:FSharp.Control.AsyncSeq">
-
+<summary>
+ Module with helper functions for working with asynchronous sequences
+</summary>
 </member>
@@ -624,6 +710,14 @@ <member name="">
 <member name="T:FSharp.Control.AsyncSeqExtensions">
+
+</member>
+<member name="M:FSharp.Control.Observable.asUpdates``1(System.IObservable{``0})">
 <summary>
- An automatically-opened module tht contains the `asyncSeq` builder and an extension method 
+ Turns observable into an observable that only calls OnNext method of the
+ observer, but gives it a discriminated union that represents different
+ kinds of events (error, next, completed)
 </summary>
 </member>
+<member name="T:FSharp.Control.Observable">
+
+</member>
 <member name="M:FSharp.Control.Seq.ofAsyncSeq``1(Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}})">
@@ -638,3 +732,19 @@ <summary>
 </member>
+<member name="M:FSharp.Control.Utils.Choice.mapr``3(Microsoft.FSharp.Core.FSharpFunc{``0,``1},Microsoft.FSharp.Core.FSharpChoice{``2,``0})">
+<summary>
+ Maps over the right result type.
+</summary>
+</member>
+<member name="M:FSharp.Control.Utils.Choice.mapl``3(Microsoft.FSharp.Core.FSharpFunc{``0,``1},Microsoft.FSharp.Core.FSharpChoice{``0,``2})">
+<summary>
+ Maps over the left result type.
+</summary>
+</member>
+<member name="T:FSharp.Control.Utils.Choice">
+
+</member>
+<member name="T:FSharp.Control.Utils">
+
+</member>
 </members>
 </doc>

No alert changes

No metric changes