Skip to content

DataTypeExpr ​

Namespace: Polars.FSharp

Sub-namespaces ​

Sub-namespacePageDescription
.ArrayDataTypeExpr.ArrayArray operations on a DataTypeExpr.
.ListDataTypeExpr.ListList operations on a DataTypeExpr.
.StructDataTypeExpr.StructStruct operations on a DataTypeExpr.

Instance Methods ​

Clone ​

Clone this DataTypeExpr.

fsharp
member Clone : unit -> DataTypeExpr

DefaultValue ​

Get a default value of a specific type.

fsharp
member DefaultValue(?n: int, ?numericToOne: bool, ?numListValues: int) : Expr

Parameters

NameTypeDescription
nint (optional)Number of types you want the value
numericToOnebool (optional)Use 1 instead of 0 as the default value for numeric types
numListValuesint (optional)The amount of values a list contains

Display ​

Get a formatted version of the output DataType.

fsharp
member Display : unit -> Expr

InnerDataType ​

Get the inner DataType of a List or Array.

fsharp
member InnerDataType : unit -> DataTypeExpr

Matches ​

Get whether the output DataType matches a certain selector.

fsharp
member Matches(selector: Selector) : Expr

Parameters

NameTypeDescription
selectorSelector-

ToLiteral ​

Convert DataTypeExpr into a DataType literal. Returns None if the expression is not a literal.

fsharp
member ToLiteral : unit -> DataType option

ToSignedInteger ​

Get the signed integer version of the same bitsize.

fsharp
member ToSignedInteger : unit -> DataTypeExpr

ToUnsignedInteger ​

Get the unsigned integer version of the same bitsize.

fsharp
member ToUnsignedInteger : unit -> DataTypeExpr

WrapInArray ​

Get the DataType wrapped in an array.

fsharp
member WrapInArray(width: uint32) : DataTypeExpr

Parameters

NameTypeDescription
widthuint32Array Width

WrapInList ​

Get the DataType wrapped in a list.

fsharp
member WrapInList : unit -> DataTypeExpr

Released under the MIT License. Powered by the Polars Rust core & Apache Arrow.