Expr.Bin (BinaryOps)

Namespace: Polars.FSharp

Instance Methods

Contains

Check if binaries in Series contain a binary substring.

member Contains(literal: Expr) : Expr

Parameters

Name	Type	Description
literal	Expr	The binary substring to look for

Returns: Expression/Series of data type Boolean.

---

Decode

Decode values using the provided encoding.

member Decode(encoding: TransferEncoding, ?strict: bool) : Expr

Parameters

Name	Type	Description
encoding	TransferEncoding	The encoding to use.
strict	bool (optional)	Raise an error if the underlying value cannot be decoded, otherwise mask out with a null value.

Returns: Expression/Series of data type Binary.

---

Encode

Encode a value using the provided encoding.

member Encode(encoding: TransferEncoding) : Expr

Parameters

Name	Type	Description
encoding	TransferEncoding	The encoding to use.

Returns: Expression/Series of data type Binary.

---

EndsWith

Check if values start with a binary substring.

member EndsWith(suffix: Expr) : Expr

Parameters

Name	Type	Description
suffix	Expr	Prefix substring.

Returns: Expression/Series of data type Boolean.

---

Head

Take the first n bytes of the binary values.

member Head(?n: int) : Expr

Parameters

Name	Type	Description
n	int (optional)	Length of the slice (integer or expression). Negative indexing is supported

Returns: Expression/Series of data type Binary

---

Reinterpret

Interpret bytes as another type.Supported types are numerical or temporal dtypes, or an Array of these dtypes.

member Reinterpret(dtype: DataTypeExpr, ?endianness: Endianness) : Expr
member Reinterpret(dtype: DataType, ?endianness: Endianness) : Expr

Parameters

Name	Type	Description
dtype	DataTypeExpr	Which type to interpret binary column into.
endianness	Endianness (optional)	Which endianness to use when interpreting bytes, by default “little”.

Returns: Expression/Series of data type dtype. Note that rows of the binary array where the length does not match the size in bytes of the output array (number of items * byte size of item) will become NULL.

---

Size

Computes the size of the binary data in the specified unit. The default unit is Bytes. Scaling to other units will result in a Float64 expression.

member Size(?unit: SizeUnit) : Expr

Parameters

Name	Type	Description
unit	SizeUnit (optional)	The unit to scale the binary size to.

Returns: A new Polars Expression representing the scaled size.

---

Slice

Slice the binary values.

member Slice(offset: int, ?length: int) : Expr

Parameters

Name	Type	Description
offset	int	Start index. Negative indexing is supported.
length	int (optional)	Length of the slice. If set to None (default), the slice is taken to the end of the value.

Returns: Expression/Series of data type Binary.

---

StartsWith

Check if values start with a binary substring.

member StartsWith(prefix: Expr) : Expr

Parameters

Name	Type	Description
prefix	Expr	Prefix substring.

Returns: Expression/Series of data type Boolean.

---

Tail

Take the last n bytes of the binary values.

member Tail(?n: int) : Expr

Parameters

Name	Type	Description
n	int (optional)	Length of the slice (integer or expression). Negative indexing is supported

Returns: Expression/Series of data type Binary

---