DataTypeExpr
Namespace: Polars.FSharp
Sub-namespaces
| Sub-namespace | Page | Description |
|---|---|---|
.Array | DataTypeExpr.Array | Array operations on a DataTypeExpr. |
.List | DataTypeExpr.List | List operations on a DataTypeExpr. |
.Struct | DataTypeExpr.Struct | Struct operations on a DataTypeExpr. |
Instance Methods
Clone
Clone this DataTypeExpr.
fsharp
member Clone : unit -> DataTypeExprDefaultValue
Get a default value of a specific type.
fsharp
member DefaultValue(?n: int, ?numericToOne: bool, ?numListValues: int) : ExprParameters
| Name | Type | Description |
|---|---|---|
n | int (optional) | Number of types you want the value |
numericToOne | bool (optional) | Use 1 instead of 0 as the default value for numeric types |
numListValues | int (optional) | The amount of values a list contains |
Display
Get a formatted version of the output DataType.
fsharp
member Display : unit -> ExprInnerDataType
Get the inner DataType of a List or Array.
fsharp
member InnerDataType : unit -> DataTypeExprMatches
Get whether the output DataType matches a certain selector.
fsharp
member Matches(selector: Selector) : ExprParameters
| Name | Type | Description |
|---|---|---|
selector | Selector | - |
ToLiteral
Convert DataTypeExpr into a DataType literal. Returns None if the expression is not a literal.
fsharp
member ToLiteral : unit -> DataType optionToSignedInteger
Get the signed integer version of the same bitsize.
fsharp
member ToSignedInteger : unit -> DataTypeExprToUnsignedInteger
Get the unsigned integer version of the same bitsize.
fsharp
member ToUnsignedInteger : unit -> DataTypeExprWrapInArray
Get the DataType wrapped in an array.
fsharp
member WrapInArray(width: uint32) : DataTypeExprParameters
| Name | Type | Description |
|---|---|---|
width | uint32 | Array Width |
WrapInList
Get the DataType wrapped in a list.
fsharp
member WrapInList : unit -> DataTypeExpr