nuget
The R# data pipeline
this model object is a kind of wrapper of the .net clr IEnumerable interface
pipeline
01 Syntax
SMRUCC.Rsharp.Runtime.Internal.Object.pipeline
02 Methods
| Name | Overloads | Summary |
|---|---|---|
| getError | 1 | Gets the R# error message data |
| createVector | 1 | Only suite for small set of data |
| populates | 1 | populate the data element from the pipeline stream |
| CreateFromPopulator | 2 | Create CLR object iterator from the given upstream data |
| TryCreatePipeline | 1 | try create populator with specific type constraint |
| getData | 1 | |
| Stream | 1 | |
| populates | 1 | |
| ToString | 1 | |
| CreateFromPopulator | 1 | |
| fromVector | 1 | |
| TryCreatePipeline | 1 | |
| op_Implicit | 1 |
03 Properties
| Name | Overloads | Summary |
|---|---|---|
| pipeFinalize | 1 | The action will be called after finish loop on the sequence. |
| isError | 1 | contains an error message in the pipeline populator or the pipeline data is an error message. |
| isMessage | 1 | current data pipeline is a data message? |
04 Fields
| Name | Overloads | Summary |
|---|---|---|
| populatorFirstErr | 1 | 在抛出数据的时候所遇到的第一个错误消息 |
05 Members
getError
Gets the R# error message data
createVector(Environment)
Only suite for small set of data
Remarks
If the data in current pipeline is super large, then the program will be crashed.
Parameters
| Name | Type | Description |
|---|---|---|
env | Environment | - |
populates``1(Environment)
populate the data element from the pipeline stream
Type Parameters
| Name | Description |
|---|---|
T | the .net clr generic type constraint |
Parameters
| Name | Type | Description |
|---|---|---|
env | Environment | - |
Returns
direct cast
CreateFromPopulator``1(
IEnumerable(Of ``0), Action)Create CLR object iterator from the given upstream data
Remarks
just a simple wrapper to the pipeline.pipeline object constructor function.
Type Parameters
| Name | Description |
|---|---|
T |
Parameters
| Name | Type | Description |
|---|---|---|
upstream | IEnumerable(Of ``0) | the upstream data |
finalize | Action | - |
CreateFromPopulator``1(
Func(Of IEnumerable(Of ``0)), Action)Create CLR object iterator from the given upstream data
Type Parameters
| Name | Description |
|---|---|
T |
Parameters
| Name | Type | Description |
|---|---|---|
pull | Func(Of IEnumerable(Of ``0)) | - |
finalize | Action | - |
try create populator with specific type constraint
Remarks
this function also will returns a null reference error message if the given upstream data is Nothing and also the parameter nullPipe is set to false by default.
Type Parameters
| Name | Description |
|---|---|
T |
Parameters
| Name | Type | Description |
|---|---|---|
upstream | Object | - |
env | Environment | - |
suppress | Boolean | - |
nullPipe | Boolean | make this function returns nothing when the given upstream data is nothing instead of the default behaviour throw the runtime error |
callerFrameName | String | debug used only |
Returns
the required data sequence or an error message if the upstream element type is not matched of the required target type.
pipeFinalize
The action will be called after finish loop on the sequence. Null value of this property will be ignored
isError
contains an error message in the pipeline populator or the pipeline data is an error message. You can get the error message via function pipeline.getError() when this property value is TRUE
isMessage
current data pipeline is a data message?
populatorFirstErr
在抛出数据的时候所遇到的第一个错误消息
getData(Environment)
populates(Environment)
ToString()
CreateFromPopulator(
IEnumerable(Of T), Action)op_Implicit(Message)