FSharp.Control.AsyncSeq
Advanced tools
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
@@ -1,9 +0,7 @@ | ||
| <?xml version="1.0" encoding="utf-8" standalone="yes"?> | ||
| <?xml version="1.0" encoding="utf-8"?> | ||
| <Types xmlns="http://schemas.openxmlformats.org/package/2006/content-types"> | ||
| <Default Extension="xml" ContentType="application/octet" /> | ||
| <Default Extension="pdb" ContentType="application/octet" /> | ||
| <Default Extension="rels" ContentType="application/vnd.openxmlformats-package.relationships+xml" /> | ||
| <Default Extension="psmdcp" ContentType="application/vnd.openxmlformats-package.core-properties+xml" /> | ||
| <Default Extension="dll" ContentType="application/octet" /> | ||
| <Default Extension="nuspec" ContentType="application/octet" /> | ||
| <Default Extension="psmdcp" ContentType="application/vnd.openxmlformats-package.core-properties+xml" /> | ||
| <Default Extension="rels" ContentType="application/vnd.openxmlformats-package.relationships+xml" /> | ||
| </Types> |
@@ -1,8 +0,9 @@ | ||
| <?xml version="1.0" encoding="utf-8" standalone="yes"?> | ||
| <package xmlns="http://schemas.microsoft.com/packaging/2011/10/nuspec.xsd"> | ||
| <?xml version="1.0" encoding="utf-8"?> | ||
| <package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd"> | ||
| <metadata> | ||
| <id>FSharp.Control.AsyncSeq</id> | ||
| <version>1.13</version> | ||
| <authors>Tomasz Petricek, David Thomas, Ryan Riley, Steffen Forkmann</authors> | ||
| <owners>Tomasz Petricek, David Thomas, Ryan Riley, Steffen Forkmann</owners> | ||
| <version>1.0.0</version> | ||
| <authors>Tomas Petricek,Don Syme,Lev Gorodinski</authors> | ||
| <owners>Tomas Petricek,Don Syme,Lev Gorodinski</owners> | ||
| <requireLicenseAcceptance>false</requireLicenseAcceptance> | ||
| <licenseUrl>http://fsprojects.github.io/FSharp.Control.AsyncSeq/license.html</licenseUrl> | ||
@@ -12,9 +13,15 @@ <projectUrl>http://fsprojects.github.io/FSharp.Control.AsyncSeq/</projectUrl> | ||
| <description>Asynchronous sequences for F#</description> | ||
| <summary>Asynchronous sequences for F#</summary> | ||
| <releaseNotes>Renamed to FSharp.Control.AsyncSeq | ||
| Remove surface area | ||
| Hide Nil/Cons from representation of AsyncSeq</releaseNotes> | ||
| <copyright>Copyright 2015</copyright> | ||
| <tags>F# async fsharpx</tags> | ||
| <copyright>Copyright 2017</copyright> | ||
| <tags>F# async fsharp streaming</tags> | ||
| <repository url="https://github.com/fsprojects/FSharp.Control.AsyncSeq" /> | ||
| <dependencies> | ||
| <group targetFramework=".NETFramework4.5"> | ||
| <dependency id="System.ValueTuple" version="4.4.0" exclude="Build,Analyzers" /> | ||
| <dependency id="FSharp.Core" version="4.2.3" exclude="Build,Analyzers" /> | ||
| </group> | ||
| <group targetFramework=".NETStandard2.0"> | ||
| <dependency id="FSharp.Core" version="4.2.3" exclude="Build,Analyzers" /> | ||
| </group> | ||
| </dependencies> | ||
| </metadata> | ||
| </package> |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
| <?xml version="1.0" encoding="utf-8"?> | ||
| <doc> | ||
| <assembly><name>FSharp.Control.AsyncSeq</name></assembly> | ||
| <members> | ||
| <member name="T:FSharp.Control.Agent`1"> | ||
| <summary> | ||
| Type alias for F# mailbox processor type | ||
| </summary> | ||
| </member> | ||
| <member name=""> | ||
| </member> | ||
| <member name=""> | ||
| </member> | ||
| <member name="T:FSharp.Control.AsyncSeqInner`1"> | ||
| <summary> | ||
| The interanl type that represents a value returned as a result of | ||
| evaluating a step of an asynchronous sequence | ||
| </summary> | ||
| </member> | ||
| <member name="T:FSharp.Control.AsyncSeq`1"> | ||
| <summary> | ||
| An asynchronous sequence represents a delayed computation that can be | ||
| started to produce either Cons value consisting of the next element of the | ||
| sequence (head) together with the next asynchronous sequence (tail) or a | ||
| special value representing the end of the sequence (Nil) | ||
| </summary> | ||
| </member> | ||
| <member name=""> | ||
| </member> | ||
| <member name=""> | ||
| </member> | ||
| <member name="M:FSharp.Control.AutoCancelAgent`1.remove_Error(Microsoft.FSharp.Control.FSharpHandler{System.Exception})"> | ||
| <summary> | ||
| Occurs when the execution of the agent results in an exception. | ||
| </summary> | ||
| </member> | ||
| <member name="P:FSharp.Control.AutoCancelAgent`1.Error"> | ||
| <summary> | ||
| Occurs when the execution of the agent results in an exception. | ||
| </summary> | ||
| </member> | ||
| <member name="P:FSharp.Control.AutoCancelAgent`1.CurrentQueueLength"> | ||
| <summary> | ||
| Returns the number of unprocessed messages in the message queue of the agent. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AutoCancelAgent`1.add_Error(Microsoft.FSharp.Control.FSharpHandler{System.Exception})"> | ||
| <summary> | ||
| Occurs when the execution of the agent results in an exception. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AutoCancelAgent`1.TryScan``1(Microsoft.FSharp.Core.FSharpFunc{`0,Microsoft.FSharp.Core.FSharpOption{Microsoft.FSharp.Control.FSharpAsync{``0}}},Microsoft.FSharp.Core.FSharpOption{System.Int32})"> | ||
| <summary> | ||
| Scans for a message by looking through messages in arrival order until <c>scanner</c> | ||
| returns a Some value. Other messages remain in the queue. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AutoCancelAgent`1.TryReceive(Microsoft.FSharp.Core.FSharpOption{System.Int32})"> | ||
| <summary> | ||
| Waits for a message. This will consume the first message in arrival order. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AutoCancelAgent`1.TryPostAndReply``1(Microsoft.FSharp.Core.FSharpFunc{Microsoft.FSharp.Control.FSharpAsyncReplyChannel{``0},`0},Microsoft.FSharp.Core.FSharpOption{System.Int32})"> | ||
| <summary> | ||
| Like PostAndReply, but returns None if no reply within the timeout period. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AutoCancelAgent`1.Start(Microsoft.FSharp.Core.FSharpFunc{Microsoft.FSharp.Control.FSharpMailboxProcessor{`0},Microsoft.FSharp.Control.FSharpAsync{Microsoft.FSharp.Core.Unit}})"> | ||
| <summary> | ||
| Start a new disposable agent using the specified body function | ||
| (the method creates a new cancellation token for the agent) | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AutoCancelAgent`1.Scan``1(Microsoft.FSharp.Core.FSharpFunc{`0,Microsoft.FSharp.Core.FSharpOption{Microsoft.FSharp.Control.FSharpAsync{``0}}},Microsoft.FSharp.Core.FSharpOption{System.Int32})"> | ||
| <summary> | ||
| Scans for a message by looking through messages in arrival order until <c>scanner</c> | ||
| returns a Some value. Other messages remain in the queue. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AutoCancelAgent`1.Receive(Microsoft.FSharp.Core.FSharpOption{System.Int32})"> | ||
| <summary> | ||
| Waits for a message. This will consume the first message in arrival order. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AutoCancelAgent`1.PostAndTryAsyncReply``1(Microsoft.FSharp.Core.FSharpFunc{Microsoft.FSharp.Control.FSharpAsyncReplyChannel{``0},`0},Microsoft.FSharp.Core.FSharpOption{System.Int32})"> | ||
| <summary> | ||
| Like PostAndAsyncReply, but returns None if no reply within the timeout period. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AutoCancelAgent`1.PostAndReply``1(Microsoft.FSharp.Core.FSharpFunc{Microsoft.FSharp.Control.FSharpAsyncReplyChannel{``0},`0},Microsoft.FSharp.Core.FSharpOption{System.Int32})"> | ||
| <summary> | ||
| Posts a message to an agent and await a reply on the channel, synchronously. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AutoCancelAgent`1.PostAndAsyncReply``1(Microsoft.FSharp.Core.FSharpFunc{Microsoft.FSharp.Control.FSharpAsyncReplyChannel{``0},`0},Microsoft.FSharp.Core.FSharpOption{System.Int32})"> | ||
| <summary> | ||
| Posts a message to an agent and await a reply on the channel, asynchronously. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AutoCancelAgent`1.Post(`0)"> | ||
| <summary> | ||
| Posts a message to the message queue of the MailboxProcessor, asynchronously. | ||
| </summary> | ||
| </member> | ||
| <member name=""> | ||
| </member> | ||
| <member name=""> | ||
| </member> | ||
| <member name="T:FSharp.Control.AutoCancelAgent`1"> | ||
| <summary> | ||
| Wrapper for the standard F# agent (MailboxProcessor) that | ||
| supports stopping of the agent's body using the IDisposable | ||
| interface (the type automatically creates a cancellation token) | ||
| </summary> | ||
| </member> | ||
| <member name=""> | ||
| </member> | ||
| <member name=""> | ||
| </member> | ||
| <member name=""> | ||
| </member> | ||
| <member name=""> | ||
| </member> | ||
| <member name=""> | ||
| </member> | ||
| <member name=""> | ||
| </member> | ||
| <member name="P:FSharp.Control.BlockingQueueAgent`1.Count"> | ||
| <summary> | ||
| Gets the number of elements currently waiting in the queue. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.BlockingQueueAgent`1.Get(Microsoft.FSharp.Core.FSharpOption{System.Int32})"> | ||
| <summary> | ||
| Synchronously gets item from the queue. If there are no items | ||
| in the queue, the operation will block until items are added. | ||
| This method blocks until value is available! | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.BlockingQueueAgent`1.AsyncGet(Microsoft.FSharp.Core.FSharpOption{System.Int32})"> | ||
| <summary> | ||
| Asynchronously gets item from the queue. If there are no items | ||
| in the queue, the operation will block until items are added. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.BlockingQueueAgent`1.AsyncAdd(`0,Microsoft.FSharp.Core.FSharpOption{System.Int32})"> | ||
| <summary> | ||
| Asynchronously adds item to the queue. The operation ends when | ||
| there is a place for the item. If the queue is full, the operation | ||
| will block until some items are removed. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.BlockingQueueAgent`1.Add(`0)"> | ||
| <summary> | ||
| Asynchronously adds item to the queue. The operation ends when | ||
| there is a place for the item. If the queue is full, the operation | ||
| will block until some items are removed. This overload does not | ||
| signal the caller that the item has been added. | ||
| </summary> | ||
| </member> | ||
| <member name=""> | ||
| </member> | ||
| <member name="T:FSharp.Control.BlockingQueueAgent`1"> | ||
| <summary> | ||
| Agent that implements an asynchronous queue with blocking put | ||
| and blocking get operation (this implements the producer-consumer | ||
| concurrent programming pattern). The constructor takes the maximal | ||
| size of the buffer. | ||
| </summary> | ||
| </member> | ||
| <member name=""> | ||
| </member> | ||
| <member name=""> | ||
| </member> | ||
| <member name=""> | ||
| </member> | ||
| <member name="T:FSharp.Control.ObservableUpdate`1"> | ||
| <summary> | ||
| 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 'ObservableUpdate' as an argument. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncExtensions.Async.chooseBoth.Static``1(Microsoft.FSharp.Control.FSharpAsync{``0},Microsoft.FSharp.Control.FSharpAsync{``0})"> | ||
| <summary> | ||
| 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.AsyncExtensions.Async.bind.Static``2(Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Control.FSharpAsync{``1}},Microsoft.FSharp.Control.FSharpAsync{``0})"> | ||
| <summary> | ||
| 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.AsyncExtensions.Async.map.Static``2(Microsoft.FSharp.Core.FSharpFunc{``0,``1},Microsoft.FSharp.Control.FSharpAsync{``0})"> | ||
| <summary> | ||
| 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.AsyncExtensions.Async.Parallel.Static``2(Microsoft.FSharp.Control.FSharpAsync{``0},Microsoft.FSharp.Control.FSharpAsync{``1})"> | ||
| <summary> | ||
| Creates an async computations which runs the specified computations | ||
| in parallel and returns their results. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncExtensions.Async.StartDisposable.Static(Microsoft.FSharp.Control.FSharpAsync{Microsoft.FSharp.Core.Unit})"> | ||
| <summary> | ||
| 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="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> | ||
| 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> | ||
| Asynchronous for loop - for all elements from the input sequence, | ||
| generate all elements produced by the body (asynchronously). See | ||
| also the AsyncSeq.collect function. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.AsyncSeqBuilder.For``2(System.Collections.Generic.IEnumerable{``0},Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``1}}})"> | ||
| <summary> | ||
| For loop that iterates over a synchronous sequence (and generates | ||
| all elements generated by the asynchronous body) | ||
| </summary> | ||
| </member> | ||
| <member name=""> | ||
| </member> | ||
| <member name=""> | ||
| </member> | ||
| <member name=""> | ||
| </member> | ||
| <member name=""> | ||
| </member> | ||
| <member name="T:FSharp.Control.AsyncSeq.AsyncSeqBuilder"> | ||
| <summary> | ||
| Computation builder that allows creating of asynchronous | ||
| sequences using the 'asyncSeq { ... }' syntax | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.distinctUntilChanged``1(Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}})"> | ||
| <summary> | ||
| Returns an async sequence which contains no contiguous duplicate elements. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.distinctUntilChangedWith``1(Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Core.FSharpFunc{``0,System.Boolean}},Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}})"> | ||
| <summary> | ||
| Returns an async sequence which contains no contiguous duplicate elements based on the specified comparison function. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.distinctUntilChangedWithAsync``1(Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Control.FSharpAsync{System.Boolean}}},Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}})"> | ||
| <summary> | ||
| Returns an async sequence which contains no contiguous duplicate elements based on the specified comparison function. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.mergeAll``1(Microsoft.FSharp.Collections.FSharpList{Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}}})"> | ||
| <summary> | ||
| Merges all specified async sequences into an async sequence non-deterministically. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.merge``1(Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}},Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}})"> | ||
| <summary> | ||
| Merges two async sequences into an async sequence non-deterministically. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.bufferByCount``1(System.Int32,Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}})"> | ||
| <summary> | ||
| Buffer items from the async sequence into buffers of a specified size. | ||
| The last buffer returned may be less than the specified buffer size. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.interleave``2"> | ||
| <summary> | ||
| Interleaves two async sequences into a resulting sequence. The provided | ||
| sequences are consumed in lock-step. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.concatSeq``2(Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}})"> | ||
| <summary> | ||
| Flattens an AsyncSeq of sequences. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.toList``1(Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}})"> | ||
| <summary> | ||
| Creates an async computation which iterates the AsyncSeq and collects the output into a list. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.toArray``1(Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}})"> | ||
| <summary> | ||
| Creates an async computation which iterates the AsyncSeq and collects the output into an array. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.skip``1(System.Int32,Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}})"> | ||
| <summary> | ||
| Skips the first N elements of an asynchronous sequence and | ||
| then returns the rest of the sequence unmodified. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.take``1(System.Int32,Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}})"> | ||
| <summary> | ||
| Returns the first N elements of an asynchronous sequence | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.skipWhile``1(Microsoft.FSharp.Core.FSharpFunc{``0,System.Boolean},Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}})"> | ||
| <summary> | ||
| Skips elements from an asynchronous sequence while the specified | ||
| predicate holds and then returns the rest of the sequence. The | ||
| predicate is evaluated asynchronously. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.takeWhile``1(Microsoft.FSharp.Core.FSharpFunc{``0,System.Boolean},Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}})"> | ||
| <summary> | ||
| Returns elements from an asynchronous sequence while the specified | ||
| predicate holds. The predicate is evaluated synchronously. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.skipUntil``1(Microsoft.FSharp.Control.FSharpAsync{Microsoft.FSharp.Core.Unit},Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}})"> | ||
| <summary> | ||
| Skips elements from an async sequence until the specified signal completes. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.skipWhileAsync``1(Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Control.FSharpAsync{System.Boolean}},Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}})"> | ||
| <summary> | ||
| Skips elements from an asynchronous sequence while the specified | ||
| predicate holds and then returns the rest of the sequence. The | ||
| predicate is evaluated asynchronously. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.takeUntil``1(Microsoft.FSharp.Control.FSharpAsync{Microsoft.FSharp.Core.Unit},Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}})"> | ||
| <summary> | ||
| Returns elements from the argument async sequence until the specified signal completes or | ||
| the sequences completes. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.takeWhileAsync``1(Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Control.FSharpAsync{System.Boolean}},Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}})"> | ||
| <summary> | ||
| Returns elements from an asynchronous sequence while the specified | ||
| predicate holds. The predicate is evaluated asynchronously. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.traverseChoiceAsync``3(Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Control.FSharpAsync{Microsoft.FSharp.Core.FSharpChoice{``1,``2}}},Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}})"> | ||
| <summary> | ||
| Traverses an async sequence an applies to specified function such that if Choice2Of2 is returned the traversal short-circuits | ||
| and Choice2Of2 is returned as the result. Otherwise, the entire sequence is traversed and the result returned as Choice1Of2. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.traverseOptionAsync``2(Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Control.FSharpAsync{Microsoft.FSharp.Core.FSharpOption{``1}}},Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}})"> | ||
| <summary> | ||
| Traverses an async sequence an applies to specified function such that if None is returned the traversal short-circuits | ||
| and None is returned as the result. Otherwise, the entire sequence is traversed and the result returned as Some. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.zapp``2(Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{Microsoft.FSharp.Core.FSharpFunc{``0,``1}}},Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}})"> | ||
| <summary> | ||
| Feeds an async sequence of values into an async sequence of functions. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.zappAsync``2(Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Control.FSharpAsync{``1}}}},Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}})"> | ||
| <summary> | ||
| Feeds an async sequence of values into an async sequence of async functions. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.zipWithIndexAsync``2(Microsoft.FSharp.Core.FSharpFunc{System.Int32,Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Control.FSharpAsync{``1}}},Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}})"> | ||
| <summary> | ||
| Combines two asynchronous sequences using the specified function to which it also passes the index. | ||
| The values from sequences are retrieved in parallel. | ||
| The resulting sequence stops when either of the argument sequences stop. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.zipWith``3(Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Core.FSharpFunc{``1,``2}},Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}},Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``1}})"> | ||
| <summary> | ||
| Combines two asynchronous sequences using the specified function. | ||
| The values from sequences are retrieved in parallel. | ||
| The resulting sequence stops when either of the argument sequences stop. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.zipWithAsync``3(Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Core.FSharpFunc{``1,Microsoft.FSharp.Control.FSharpAsync{``2}}},Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}},Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``1}})"> | ||
| <summary> | ||
| Combines two asynchronous sequences using the specified function. | ||
| The values from sequences are retrieved in parallel. | ||
| The resulting sequence stops when either of the argument sequences stop. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.zip``2(Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}},Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``1}})"> | ||
| <summary> | ||
| Combines two asynchronous sequences into a sequence of pairs. | ||
| The values from sequences are retrieved in parallel. | ||
| The resulting sequence stops when either of the argument sequences stop. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.threadStateAsync``3(Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Core.FSharpFunc{``1,Microsoft.FSharp.Control.FSharpAsync{System.Tuple{``2,``0}}}},``0,Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``1}})"> | ||
| <summary> | ||
| Threads a state through the mapping over an async sequence using an async function. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.cache``1(Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}})"> | ||
| <summary> | ||
| Create a new asynchronous sequence that caches all elements of the | ||
| sequence specified as the input. When accessing the resulting sequence | ||
| multiple times, the input will still be evaluated only once | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.toBlockingSeq``1(Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}})"> | ||
| <summary> | ||
| Converts asynchronous sequence to a synchronous blocking sequence. | ||
| The elements of the asynchronous sequence are consumed lazily. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.toObservable``1(Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}})"> | ||
| <summary> | ||
| Converts asynchronous sequence to an IObservable<_>. When the client subscribes | ||
| to the observable, a new copy of asynchronous sequence is started and is | ||
| sequentially iterated over (at the maximal possible speed). Disposing of the | ||
| observer cancels the iteration over asynchronous sequence. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.ofObservable``1(System.IObservable{``0})"> | ||
| <summary> | ||
| Converts observable to an asynchronous sequence. Values that are produced | ||
| by the observable while the asynchronous sequence is blocked are discarded | ||
| (this function doesn't guarantee that asynchronou ssequence will return | ||
| all values produced by the observable) | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.ofObservableBuffered``1(System.IObservable{``0})"> | ||
| <summary> | ||
| Converts observable to an asynchronous sequence. Values that are produced | ||
| by the observable while the asynchronous sequence is blocked are stored to | ||
| an unbounded buffer and are returned as next elements of the async sequence. | ||
| </summary> | ||
| </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 'Get' message to the agent to get the next element. The observable | ||
| sends 'Put' message to the agent (as new inputs are generated). | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.ofSeq``1(System.Collections.Generic.IEnumerable{``0})"> | ||
| <summary> | ||
| Creates an asynchronous sequence that lazily takes element from an | ||
| input synchronous sequence and returns them one-by-one. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.filter``1(Microsoft.FSharp.Core.FSharpFunc{``0,System.Boolean},Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}})"> | ||
| <summary> | ||
| Same as AsyncSeq.filterAsync, but the specified predicate is synchronous | ||
| and processes the input element immediately. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.choose``2(Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Core.FSharpOption{``1}},Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}})"> | ||
| <summary> | ||
| Same as AsyncSeq.chooseAsync, but the specified function is synchronous | ||
| and processes the input element immediately. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.iter``1(Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Core.Unit},Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}})"> | ||
| <summary> | ||
| Same as AsyncSeq.iterAsync, but the specified function is synchronous | ||
| and performs the side-effect immediately. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.map``2(Microsoft.FSharp.Core.FSharpFunc{``0,``1},Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}})"> | ||
| <summary> | ||
| Same as AsyncSeq.mapAsync, but the specified function is synchronous | ||
| and returns the result of projection immediately. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.scan``2(Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Core.FSharpFunc{``1,``0}},``0,Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``1}})"> | ||
| <summary> | ||
| Same as AsyncSeq.scanAsync, but the specified function is synchronous | ||
| and returns the result of aggregation immediately. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.fold``2(Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Core.FSharpFunc{``1,``0}},``0,Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``1}})"> | ||
| <summary> | ||
| Same as AsyncSeq.foldAsync, but the specified function is synchronous | ||
| and returns the result of aggregation immediately. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.foldAsync``2(Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Core.FSharpFunc{``1,Microsoft.FSharp.Control.FSharpAsync{``0}}},``0,Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``1}})"> | ||
| <summary> | ||
| Aggregates the elements of the input asynchronous sequence using the | ||
| specified 'aggregation' function. The result is an asynchronous | ||
| workflow that returns the final result. | ||
| The aggregation function is asynchronous (and the input sequence will | ||
| be asked for the next element after the processing of an element completes). | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.pairwise``1(Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}})"> | ||
| <summary> | ||
| Returns an asynchronous sequence that returns pairs containing an element | ||
| from the input sequence and its predecessor. Empty sequence is returned for | ||
| singleton input sequence. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.iterAsync``1(Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Control.FSharpAsync{Microsoft.FSharp.Core.Unit}},Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}})"> | ||
| <summary> | ||
| Iterates over the input sequence and calls the specified function for | ||
| every value (to perform some side-effect asynchronously). | ||
| The specified function is asynchronous (and the input sequence will | ||
| be asked for the next element after the processing of an element completes). | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.scanAsync``2(Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Core.FSharpFunc{``1,Microsoft.FSharp.Control.FSharpAsync{``0}}},``0,Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``1}})"> | ||
| <summary> | ||
| Aggregates the elements of the input asynchronous sequence using the | ||
| specified 'aggregation' function. The result is an asynchronous | ||
| sequence of intermediate aggregation result. | ||
| The aggregation function is asynchronous (and the input sequence will | ||
| be asked for the next element after the processing of an element completes). | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.firstOrDefault``1(``0,Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}})"> | ||
| <summary> | ||
| Asynchronously returns the first element that was generated by the | ||
| given asynchronous sequence (or the specified default value). | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.lastOrDefault``1(``0,Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}})"> | ||
| <summary> | ||
| Asynchronously returns the last element that was generated by the | ||
| given asynchronous sequence (or the specified default value). | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.filterAsync``1(Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Control.FSharpAsync{System.Boolean}},Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}})"> | ||
| <summary> | ||
| Builds a new asynchronous sequence whose elements are those from the | ||
| input sequence for which the specified function returned true. | ||
| The specified function is asynchronous (and the input sequence will | ||
| be asked for the next element after the processing of an element completes). | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.chooseAsync``2(Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Control.FSharpAsync{Microsoft.FSharp.Core.FSharpOption{``1}}},Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}})"> | ||
| <summary> | ||
| Asynchronously iterates over the input sequence and generates 'x' for | ||
| every input element for which the specified asynchronous function | ||
| returned 'Some(x)' | ||
| The specified function is asynchronous (and the input sequence will | ||
| be asked for the next element after the processing of an element completes). | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.mapAsync``2(Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Control.FSharpAsync{``1}},Microsoft.FSharp.Control.FSharpAsync{FSharp.Control.AsyncSeqInner{``0}})"> | ||
| <summary> | ||
| Builds a new asynchronous sequence whose elements are generated by | ||
| applying the specified function to all elements of the input sequence. | ||
| The specified function is asynchronous (and the input sequence will | ||
| be asked for the next element after the processing of an element completes). | ||
| </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}})"> | ||
| <summary> | ||
| Creates an asynchronou sequence that iterates over the given input sequence. | ||
| For every input element, it calls the the specified function and iterates | ||
| over all elements generated by that asynchronous sequence. | ||
| This is the 'bind' operation of the computation expression (exposed using | ||
| the 'for' keyword in asyncSeq computation). | ||
| </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 'TryFinally' 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 'TryWith' 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}})"> | ||
| <summary> | ||
| Yields all elements of the first asynchronous sequence and then | ||
| all elements of the second asynchronous sequence. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.replicate``1(``0)"> | ||
| <summary> | ||
| Creates an async sequence which repeats the specified value indefinitely. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.unfoldAsync``2(Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Control.FSharpAsync{Microsoft.FSharp.Core.FSharpOption{System.Tuple{``1,``0}}}},``0)"> | ||
| <summary> | ||
| Generates an async sequence using the specified generator function. | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.singleton``1(``0)"> | ||
| <summary> | ||
| Creates an asynchronous sequence that generates a single element and then ends | ||
| </summary> | ||
| </member> | ||
| <member name="M:FSharp.Control.AsyncSeq.empty``1"> | ||
| <summary> | ||
| Creates an empty asynchronou sequence that immediately ends | ||
| </summary> | ||
| </member> | ||
| <member name="T:FSharp.Control.AsyncSeq"> | ||
| <summary> | ||
| Module with helper functions for working with asynchronous sequences | ||
| </summary> | ||
| </member> | ||
| <member name=""> | ||
| </member> | ||
| <member name="P:FSharp.Control.AsyncSeqExtensions.asyncSeq"> | ||
| <summary> | ||
| Builds an asynchronou sequence using the computation builder syntax | ||
| </summary> | ||
| </member> | ||
| <member name="T:FSharp.Control.AsyncSeqExtensions"> | ||
| </member> | ||
| <member name="M:FSharp.Control.Observable.asUpdates``1(System.IObservable{``0})"> | ||
| <summary> | ||
| 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}})"> | ||
| <summary> | ||
| Converts asynchronous sequence to a synchronous blocking sequence. | ||
| The elements of the asynchronous sequence are consumed lazily. | ||
| </summary> | ||
| </member> | ||
| <member name="T:FSharp.Control.Seq"> | ||
| </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> |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet