RowsAsync
Namespace: Polars.FSharp
Module Functions
RowsAsync.filter
Filters the async stream, yielding only elements that satisfy the predicate.
RowsAsync.filter : predicate: ('T -> bool) -> stream: IAsyncEnumerable<'T> -> IAsyncEnumerable<'T>Parameters
| Name | Type | Description |
|---|---|---|
predicate | ('T -> bool) | - |
stream | IAsyncEnumerable<'T> | - |
RowsAsync.fold
Folds over the async stream, accumulating state on each element.
RowsAsync.fold : folder: ('State -> ('T -> 'State)) -> initial: 'State -> stream: IAsyncEnumerable<'T> -> Task<'State>Parameters
| Name | Type | Description |
|---|---|---|
folder | ('State -> ('T -> 'State)) | - |
initial | 'State | - |
stream | IAsyncEnumerable<'T> | - |
RowsAsync.head
Returns the first element of the async stream and halts engine computation immediately. Raises InvalidOperationException if the stream contains no elements.
RowsAsync.head : stream: IAsyncEnumerable<'T> -> Task<'T>Parameters
| Name | Type | Description |
|---|---|---|
stream | IAsyncEnumerable<'T> | - |
RowsAsync.iter
Iterates over the async stream, executing an action on each item.
RowsAsync.iter : action: ('T -> unit) -> stream: IAsyncEnumerable<'T> -> Task<unit>Parameters
| Name | Type | Description |
|---|---|---|
action | ('T -> unit) | - |
stream | IAsyncEnumerable<'T> | - |
RowsAsync.iteri
Iterates over the async stream with zero-based 64-bit row index, executing an action on each item.
RowsAsync.iteri : action: (int64 -> ('T -> unit)) -> stream: IAsyncEnumerable<'T> -> Task<unit>Parameters
| Name | Type | Description |
|---|---|---|
action | (int64 -> ('T -> unit)) | - |
stream | IAsyncEnumerable<'T> | - |
RowsAsync.length
Counts total number of rows in the async stream.
RowsAsync.length : stream: IAsyncEnumerable<'T> -> Task<int64>Parameters
| Name | Type | Description |
|---|---|---|
stream | IAsyncEnumerable<'T> | - |
RowsAsync.map
Projects each element of the async stream using the mapping function.
RowsAsync.map : mapping: ('T -> 'U) -> stream: IAsyncEnumerable<'T> -> IAsyncEnumerable<'U>Parameters
| Name | Type | Description |
|---|---|---|
mapping | ('T -> 'U) | - |
stream | IAsyncEnumerable<'T> | - |
RowsAsync.toArray
Materializes all items of the async stream into a strongly-typed array.
RowsAsync.toArray : stream: IAsyncEnumerable<'T> -> Task<'T[]>Parameters
| Name | Type | Description |
|---|---|---|
stream | IAsyncEnumerable<'T> | - |
RowsAsync.toDataFrame
Materializes all items of the async stream directly into a native Polars DataFrame.
RowsAsync.toDataFrame : stream: IAsyncEnumerable<'T> -> Task<DataFrame>Parameters
| Name | Type | Description |
|---|---|---|
stream | IAsyncEnumerable<'T> | - |
RowsAsync.toList
Materializes all items of the async stream into an F# immutable list.
RowsAsync.toList : stream: IAsyncEnumerable<'T> -> Task<'T list>Parameters
| Name | Type | Description |
|---|---|---|
stream | IAsyncEnumerable<'T> | - |
RowsAsync.toResizeArray
Materializes all items of the async stream into a ResizeArray.
RowsAsync.toResizeArray : stream: IAsyncEnumerable<'T> -> Task<List<'T>>Parameters
| Name | Type | Description |
|---|---|---|
stream | IAsyncEnumerable<'T> | - |
RowsAsync.tryHead
Returns the first element of the stream as an option and halts engine computation immediately.
RowsAsync.tryHead : stream: IAsyncEnumerable<'T> -> Task<'T option>Parameters
| Name | Type | Description |
|---|---|---|
stream | IAsyncEnumerable<'T> | - |
RowsAsync.tryHeadValue
Returns the first element of the stream as a ValueOption without heap allocation.
RowsAsync.tryHeadValue : stream: IAsyncEnumerable<'T> -> Task<'T voption>Parameters
| Name | Type | Description |
|---|---|---|
stream | IAsyncEnumerable<'T> | - |