fbs

package
v0.0.0-...-790036a Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 17, 2019 License: MIT Imports: 1 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source
var EnumNamesEncoding = map[Encoding]string{
	EncodingPLAIN:      "PLAIN",
	EncodingDICTIONARY: "DICTIONARY",
}
View Source
var EnumNamesTimeUnit = map[TimeUnit]string{
	TimeUnitSECOND:      "SECOND",
	TimeUnitMILLISECOND: "MILLISECOND",
	TimeUnitMICROSECOND: "MICROSECOND",
	TimeUnitNANOSECOND:  "NANOSECOND",
}
View Source
var EnumNamesTypE = map[TypE]string{
	TypEBOOL:      "BOOL",
	TypEINT8:      "INT8",
	TypEINT16:     "INT16",
	TypEINT32:     "INT32",
	TypEINT64:     "INT64",
	TypEUINT8:     "UINT8",
	TypEUINT16:    "UINT16",
	TypEUINT32:    "UINT32",
	TypEUINT64:    "UINT64",
	TypEFLOAT:     "FLOAT",
	TypEDOUBLE:    "DOUBLE",
	TypEUTF8:      "UTF8",
	TypEBINARY:    "BINARY",
	TypECATEGORY:  "CATEGORY",
	TypETIMESTAMP: "TIMESTAMP",
	TypEDATE:      "DATE",
	TypETIME:      "TIME",
}
View Source
var EnumNamesTypeMetadata = map[TypeMetadata]string{
	TypeMetadataNONE:              "NONE",
	TypeMetadataCategoryMetadata:  "CategoryMetadata",
	TypeMetadataTimestampMetadata: "TimestampMetadata",
	TypeMetadataDateMetadata:      "DateMetadata",
	TypeMetadataTimeMetadata:      "TimeMetadata",
}

Functions

func CTableAddColumns

func CTableAddColumns(builder *flatbuffers.Builder, columns flatbuffers.UOffsetT)

func CTableAddDescription

func CTableAddDescription(builder *flatbuffers.Builder, description flatbuffers.UOffsetT)

func CTableAddMetadata

func CTableAddMetadata(builder *flatbuffers.Builder, metadata flatbuffers.UOffsetT)

func CTableAddNumRows

func CTableAddNumRows(builder *flatbuffers.Builder, numRows int64)

func CTableAddVersion

func CTableAddVersion(builder *flatbuffers.Builder, version int32)

func CTableEnd

func CTableEnd(builder *flatbuffers.Builder) flatbuffers.UOffsetT

func CTableStart

func CTableStart(builder *flatbuffers.Builder)

/ Table metadata (likely JSON), not yet used

func CTableStartColumnsVector

func CTableStartColumnsVector(builder *flatbuffers.Builder, numElems int) flatbuffers.UOffsetT

func CategoryMetadataAddLevels

func CategoryMetadataAddLevels(builder *flatbuffers.Builder, levels flatbuffers.UOffsetT)

func CategoryMetadataAddOrdered

func CategoryMetadataAddOrdered(builder *flatbuffers.Builder, ordered bool)

func CategoryMetadataEnd

func CategoryMetadataEnd(builder *flatbuffers.Builder) flatbuffers.UOffsetT

func CategoryMetadataStart

func CategoryMetadataStart(builder *flatbuffers.Builder)

func ColumnAddMetadata

func ColumnAddMetadata(builder *flatbuffers.Builder, metadata flatbuffers.UOffsetT)

func ColumnAddMetadataType

func ColumnAddMetadataType(builder *flatbuffers.Builder, metadataType byte)

func ColumnAddName

func ColumnAddName(builder *flatbuffers.Builder, name flatbuffers.UOffsetT)

func ColumnAddUserMetadata

func ColumnAddUserMetadata(builder *flatbuffers.Builder, userMetadata flatbuffers.UOffsetT)

func ColumnAddValues

func ColumnAddValues(builder *flatbuffers.Builder, values flatbuffers.UOffsetT)

func ColumnEnd

func ColumnEnd(builder *flatbuffers.Builder) flatbuffers.UOffsetT

func ColumnStart

func ColumnStart(builder *flatbuffers.Builder)

/ This should (probably) be JSON

func DateMetadataEnd

func DateMetadataEnd(builder *flatbuffers.Builder) flatbuffers.UOffsetT

func DateMetadataStart

func DateMetadataStart(builder *flatbuffers.Builder)

func PrimitiveArrayAddEncoding

func PrimitiveArrayAddEncoding(builder *flatbuffers.Builder, encoding int8)

func PrimitiveArrayAddLength

func PrimitiveArrayAddLength(builder *flatbuffers.Builder, length int64)

func PrimitiveArrayAddNullCount

func PrimitiveArrayAddNullCount(builder *flatbuffers.Builder, nullCount int64)

func PrimitiveArrayAddOffset

func PrimitiveArrayAddOffset(builder *flatbuffers.Builder, offset int64)

func PrimitiveArrayAddTotalBytes

func PrimitiveArrayAddTotalBytes(builder *flatbuffers.Builder, totalBytes int64)

func PrimitiveArrayAddTypE

func PrimitiveArrayAddTypE(builder *flatbuffers.Builder, typE int8)

func PrimitiveArrayEnd

func PrimitiveArrayEnd(builder *flatbuffers.Builder) flatbuffers.UOffsetT

func PrimitiveArrayStart

func PrimitiveArrayStart(builder *flatbuffers.Builder)

func TimeMetadataAddUnit

func TimeMetadataAddUnit(builder *flatbuffers.Builder, unit int8)

func TimeMetadataEnd

func TimeMetadataEnd(builder *flatbuffers.Builder) flatbuffers.UOffsetT

func TimeMetadataStart

func TimeMetadataStart(builder *flatbuffers.Builder)

func TimestampMetadataAddTimezone

func TimestampMetadataAddTimezone(builder *flatbuffers.Builder, timezone flatbuffers.UOffsetT)

func TimestampMetadataAddUnit

func TimestampMetadataAddUnit(builder *flatbuffers.Builder, unit int8)

func TimestampMetadataEnd

func TimestampMetadataEnd(builder *flatbuffers.Builder) flatbuffers.UOffsetT

func TimestampMetadataStart

func TimestampMetadataStart(builder *flatbuffers.Builder)

/ Timestamp data is assumed to be UTC, but the time zone is stored here for / presentation as localized

Types

type CTable

type CTable struct {
	// contains filtered or unexported fields
}

func GetRootAsCTable

func GetRootAsCTable(buf []byte, offset flatbuffers.UOffsetT) *CTable

func (*CTable) Columns

func (rcv *CTable) Columns(obj *Column, j int) bool

func (*CTable) ColumnsLength

func (rcv *CTable) ColumnsLength() int

func (*CTable) Description

func (rcv *CTable) Description() []byte

/ Some text (or a name) metadata about what the file is, optional

func (*CTable) Init

func (rcv *CTable) Init(buf []byte, i flatbuffers.UOffsetT)

func (*CTable) Metadata

func (rcv *CTable) Metadata() []byte

/ Table metadata (likely JSON), not yet used

func (*CTable) MutateNumRows

func (rcv *CTable) MutateNumRows(n int64) bool

func (*CTable) MutateVersion

func (rcv *CTable) MutateVersion(n int32) bool

/ Version number of the Feather format

func (*CTable) NumRows

func (rcv *CTable) NumRows() int64

/ Some text (or a name) metadata about what the file is, optional

func (*CTable) Table

func (rcv *CTable) Table() flatbuffers.Table

func (*CTable) Version

func (rcv *CTable) Version() int32

/ Version number of the Feather format

type CategoryMetadata

type CategoryMetadata struct {
	// contains filtered or unexported fields
}

func GetRootAsCategoryMetadata

func GetRootAsCategoryMetadata(buf []byte, offset flatbuffers.UOffsetT) *CategoryMetadata

func (*CategoryMetadata) Init

func (rcv *CategoryMetadata) Init(buf []byte, i flatbuffers.UOffsetT)

func (*CategoryMetadata) Levels

func (rcv *CategoryMetadata) Levels(obj *PrimitiveArray) *PrimitiveArray

/ The category codes are presumed to be integers that are valid indexes into / the levels array

func (*CategoryMetadata) MutateOrdered

func (rcv *CategoryMetadata) MutateOrdered(n bool) bool

func (*CategoryMetadata) Ordered

func (rcv *CategoryMetadata) Ordered() bool

/ The category codes are presumed to be integers that are valid indexes into / the levels array

func (*CategoryMetadata) Table

func (rcv *CategoryMetadata) Table() flatbuffers.Table

type Column

type Column struct {
	// contains filtered or unexported fields
}

func GetRootAsColumn

func GetRootAsColumn(buf []byte, offset flatbuffers.UOffsetT) *Column

func (*Column) Init

func (rcv *Column) Init(buf []byte, i flatbuffers.UOffsetT)

func (*Column) Metadata

func (rcv *Column) Metadata(obj *flatbuffers.Table) bool

func (*Column) MetadataType

func (rcv *Column) MetadataType() byte

func (*Column) MutateMetadataType

func (rcv *Column) MutateMetadataType(n byte) bool

func (*Column) Name

func (rcv *Column) Name() []byte

func (*Column) Table

func (rcv *Column) Table() flatbuffers.Table

func (*Column) UserMetadata

func (rcv *Column) UserMetadata() []byte

/ This should (probably) be JSON

func (*Column) Values

func (rcv *Column) Values(obj *PrimitiveArray) *PrimitiveArray

type DateMetadata

type DateMetadata struct {
	// contains filtered or unexported fields
}

func GetRootAsDateMetadata

func GetRootAsDateMetadata(buf []byte, offset flatbuffers.UOffsetT) *DateMetadata

func (*DateMetadata) Init

func (rcv *DateMetadata) Init(buf []byte, i flatbuffers.UOffsetT)

func (*DateMetadata) Table

func (rcv *DateMetadata) Table() flatbuffers.Table

type Encoding

type Encoding = int8
const (
	EncodingPLAIN Encoding = 0
	/// Data is stored dictionary-encoded
	/// dictionary size: <INT32 Dictionary size>
	/// dictionary data: <TYPE primitive array>
	/// dictionary index: <INT32 primitive array>
	///
	/// TODO: do we care about storing the index values in a smaller typeclass
	EncodingDICTIONARY Encoding = 1
)

type PrimitiveArray

type PrimitiveArray struct {
	// contains filtered or unexported fields
}

func GetRootAsPrimitiveArray

func GetRootAsPrimitiveArray(buf []byte, offset flatbuffers.UOffsetT) *PrimitiveArray

func (*PrimitiveArray) Encoding

func (rcv *PrimitiveArray) Encoding() Encoding

func (*PrimitiveArray) Init

func (rcv *PrimitiveArray) Init(buf []byte, i flatbuffers.UOffsetT)

func (*PrimitiveArray) Length

func (rcv *PrimitiveArray) Length() int64

/ The number of logical values in the array

func (*PrimitiveArray) MutateEncoding

func (rcv *PrimitiveArray) MutateEncoding(n Encoding) bool

func (*PrimitiveArray) MutateLength

func (rcv *PrimitiveArray) MutateLength(n int64) bool

/ The number of logical values in the array

func (*PrimitiveArray) MutateNullCount

func (rcv *PrimitiveArray) MutateNullCount(n int64) bool

/ The number of observed nulls

func (*PrimitiveArray) MutateOffset

func (rcv *PrimitiveArray) MutateOffset(n int64) bool

/ Relative memory offset of the start of the array data excluding the size / of the metadata

func (*PrimitiveArray) MutateTotalBytes

func (rcv *PrimitiveArray) MutateTotalBytes(n int64) bool

/ The total size of the actual data in the file

func (*PrimitiveArray) MutateTypE

func (rcv *PrimitiveArray) MutateTypE(n TypE) bool

func (*PrimitiveArray) NullCount

func (rcv *PrimitiveArray) NullCount() int64

/ The number of observed nulls

func (*PrimitiveArray) Offset

func (rcv *PrimitiveArray) Offset() int64

/ Relative memory offset of the start of the array data excluding the size / of the metadata

func (*PrimitiveArray) Table

func (rcv *PrimitiveArray) Table() flatbuffers.Table

func (*PrimitiveArray) TotalBytes

func (rcv *PrimitiveArray) TotalBytes() int64

/ The total size of the actual data in the file

func (*PrimitiveArray) TypE

func (rcv *PrimitiveArray) TypE() TypE

type TimeMetadata

type TimeMetadata struct {
	// contains filtered or unexported fields
}

func GetRootAsTimeMetadata

func GetRootAsTimeMetadata(buf []byte, offset flatbuffers.UOffsetT) *TimeMetadata

func (*TimeMetadata) Init

func (rcv *TimeMetadata) Init(buf []byte, i flatbuffers.UOffsetT)

func (*TimeMetadata) MutateUnit

func (rcv *TimeMetadata) MutateUnit(n TimeUnit) bool

func (*TimeMetadata) Table

func (rcv *TimeMetadata) Table() flatbuffers.Table

func (*TimeMetadata) Unit

func (rcv *TimeMetadata) Unit() TimeUnit

type TimeUnit

type TimeUnit = int8
const (
	TimeUnitSECOND      TimeUnit = 0
	TimeUnitMILLISECOND TimeUnit = 1
	TimeUnitMICROSECOND TimeUnit = 2
	TimeUnitNANOSECOND  TimeUnit = 3
)

type TimestampMetadata

type TimestampMetadata struct {
	// contains filtered or unexported fields
}

func GetRootAsTimestampMetadata

func GetRootAsTimestampMetadata(buf []byte, offset flatbuffers.UOffsetT) *TimestampMetadata

func (*TimestampMetadata) Init

func (rcv *TimestampMetadata) Init(buf []byte, i flatbuffers.UOffsetT)

func (*TimestampMetadata) MutateUnit

func (rcv *TimestampMetadata) MutateUnit(n TimeUnit) bool

func (*TimestampMetadata) Table

func (rcv *TimestampMetadata) Table() flatbuffers.Table

func (*TimestampMetadata) Timezone

func (rcv *TimestampMetadata) Timezone() []byte

/ Timestamp data is assumed to be UTC, but the time zone is stored here for / presentation as localized

func (*TimestampMetadata) Unit

func (rcv *TimestampMetadata) Unit() TimeUnit

type TypE

type TypE = int8

/ Feather is an experimental serialization format implemented using / techniques from Apache Arrow. It was created as a proof-of-concept of an / interoperable file format for storing data frames originating in Python or / R. It enabled the developers to sidestep some of the open design questions / in Arrow from early 2016 and instead create something simple and useful for / the intended use cases.

const (
	TypEBOOL      TypE = 0
	TypEINT8      TypE = 1
	TypEINT16     TypE = 2
	TypEINT32     TypE = 3
	TypEINT64     TypE = 4
	TypEUINT8     TypE = 5
	TypEUINT16    TypE = 6
	TypEUINT32    TypE = 7
	TypEUINT64    TypE = 8
	TypEFLOAT     TypE = 9
	TypEDOUBLE    TypE = 10
	TypEUTF8      TypE = 11
	TypEBINARY    TypE = 12
	TypECATEGORY  TypE = 13
	TypETIMESTAMP TypE = 14
	TypEDATE      TypE = 15
	TypETIME      TypE = 16
)

type TypeMetadata

type TypeMetadata = byte
const (
	TypeMetadataNONE              TypeMetadata = 0
	TypeMetadataCategoryMetadata  TypeMetadata = 1
	TypeMetadataTimestampMetadata TypeMetadata = 2
	TypeMetadataDateMetadata      TypeMetadata = 3
	TypeMetadataTimeMetadata      TypeMetadata = 4
)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL