Expand description
Flatbuffer representations for DTypes
This module contains the code to serialize and deserialize DTypes to and from flatbuffers.
Structs§
- Binary
- Binary
Args - Binary
Builder - Bool
- Bool
Args - Bool
Builder - DType
- DType
Args - DType
Builder - Decimal
- Decimal
Args - Decimal
Builder - Extension
- Extension
Args - Extension
Builder - Fixed
Size List - Fixed
Size List Args - Fixed
Size List Builder - List
- List
Args - List
Builder - Null
- Null
Args - Null
Builder - PType
- Primitive
- Primitive
Args - Primitive
Builder - Struct_
- Struct_
Args - Struct_
Builder - Type
- Type
Union Table Offset - Utf8
- Utf8
Args - Utf8
Builder
Enums§
- Binary
Offset - Bool
Offset - DType
Offset - Decimal
Offset - Extension
Offset - Fixed
Size List Offset - List
Offset - Null
Offset - Primitive
Offset - Struct_
Offset - Utf8
Offset
Constants§
- ENUM_
MAX_ PTYPE Deprecated - ENUM_
MAX_ TYPE Deprecated - ENUM_
MIN_ PTYPE Deprecated - ENUM_
MIN_ TYPE Deprecated - ENUM_
VALUES_ PTYPE Deprecated - ENUM_
VALUES_ TYPE Deprecated
Functions§
- extract_
field - Deserialize single field out of a struct dtype and as a top level dtype
- finish_
dtype_ buffer - finish_
size_ prefixed_ dtype_ buffer - project_
and_ deserialize - Deserialize flatbuffer schema selecting only columns defined by projection
- resolve_
field - Convert name references in projection list into index references.
- root_
as_ dtype - Verifies that a buffer of bytes contains a
DTypeand returns it. Note that verification is still experimental and may not catch every error, or be maximally performant. For the previous, unchecked, behavior useroot_as_dtype_unchecked. - root_
as_ ⚠dtype_ unchecked - Assumes, without verification, that a buffer of bytes contains a DType and returns it.
- root_
as_ dtype_ with_ opts - Verifies, with the given options, that a buffer of bytes
contains a
DTypeand returns it. Note that verification is still experimental and may not catch every error, or be maximally performant. For the previous, unchecked, behavior useroot_as_dtype_unchecked. - size_
prefixed_ root_ as_ dtype - Verifies that a buffer of bytes contains a size prefixed
DTypeand returns it. Note that verification is still experimental and may not catch every error, or be maximally performant. For the previous, unchecked, behavior usesize_prefixed_root_as_dtype_unchecked. - size_
prefixed_ ⚠root_ as_ dtype_ unchecked - Assumes, without verification, that a buffer of bytes contains a size prefixed DType and returns it.
- size_
prefixed_ root_ as_ dtype_ with_ opts - Verifies, with the given verifier options, that a buffer of
bytes contains a size prefixed
DTypeand returns it. Note that verification is still experimental and may not catch every error, or be maximally performant. For the previous, unchecked, behavior useroot_as_dtype_unchecked.