convert

Documentation

Overview

Package convert provides a function to generate conversion functions for a vehicle struct.

Index

• Constants
• func GetSchemaVersion(jsonData []byte) string
• func NameFromV2Signal(sigResult gjson.Result) (string, error)
• func SignalsFromPayload(ctx context.Context, tokenGetter TokenIDGetter, jsonData []byte) ([]vss.Signal, error)
• func SignalsFromV1Payload(ctx context.Context, tokenGetter TokenIDGetter, jsonData []byte) ([]vss.Signal, error)
• func SignalsFromV2Payload(jsonData []byte) ([]vss.Signal, error)
• func SourceFromV1Data(jsonData []byte) (string, error)
• func SourceFromV2Data(jsonData []byte) (string, error)
• func SubjectFromV1Data(jsonData []byte) (string, error)
• func TimestampFromV1Data(jsonData []byte) (time.Time, error)
• func TimestampFromV2Signal(sigResult gjson.Result) (time.Time, error)
• func TokenIDFromV2Data(jsonData []byte) (uint32, error)
• type FieldNotFoundError
  • func (e FieldNotFoundError) Error() string
• type TokenIDGetter
• type VersionError
  • func (e VersionError) Error() string

Constants

const (
	// StatusV1 is the version string for payloads with the version 1.0 schema.
	StatusV1 = "1.0"
	// StatusV1Converted is the version string for payloads that have been converted to the 1.0 schema.
	StatusV1Converted = "1.1"
	// StatusV2 is the version string for payloads with the version 2.0 schema.
	StatusV2 = "2.0"
)

Functions

func GetSchemaVersion

func GetSchemaVersion(jsonData []byte) string

GetSchemaVersion returns the version string of the schema used in the payload.

func NameFromV2Signal

func NameFromV2Signal(sigResult gjson.Result) (string, error)

NameFromV2Signal gets a name from a V2 signal.

func SignalsFromPayload

func SignalsFromPayload(ctx context.Context, tokenGetter TokenIDGetter, jsonData []byte) ([]vss.Signal, error)

SignalsFromPayload extracts signals from a payload. It detects the payload version and calls the appropriate function.

func SignalsFromV1Payload

func SignalsFromV1Payload(ctx context.Context, tokenGetter TokenIDGetter, jsonData []byte) ([]vss.Signal, error)

SignalsFromV1Payload gets a slice signals from a v1 payload.

func SignalsFromV2Payload

func SignalsFromV2Payload(jsonData []byte) ([]vss.Signal, error)

SignalsFromV2Payload extracts signals from a V2 payload.

func SourceFromV1Data

func SourceFromV1Data(jsonData []byte) (string, error)

SourceFromV1Data gets a source field from a v1 payload.

func SourceFromV2Data

func SourceFromV2Data(jsonData []byte) (string, error)

SourceFromV2Data gets a source from a V2 payload.

func SubjectFromV1Data

func SubjectFromV1Data(jsonData []byte) (string, error)

SubjectFromV1Data gets a subject from a v1 payload.

func TimestampFromV1Data

func TimestampFromV1Data(jsonData []byte) (time.Time, error)

TimestampFromV1Data gets a timestamp from a v1 payload.

func TimestampFromV2Signal

func TimestampFromV2Signal(sigResult gjson.Result) (time.Time, error)

TimestampFromV2Signal gets a timestamp from a V2 signal.

func TokenIDFromV2Data

func TokenIDFromV2Data(jsonData []byte) (uint32, error)

TokenIDFromV2Data gets a tokenID from a V2 payload.

Types

type FieldNotFoundError

type FieldNotFoundError struct {
	Field  string
	Lookup string
}

FieldNotFoundError is an error for missing fields.

func (FieldNotFoundError) Error

func (e FieldNotFoundError) Error() string

Error returns the error message.

type TokenIDGetter

type TokenIDGetter interface {
	TokenIDFromSubject(ctx context.Context, subject string) (uint32, error)
}

TokenIDGetter is an interface to get a tokenID from a subject.

type VersionError

type VersionError struct {
	Version string
}

VersionError is an error for unsupported specversion.

func (VersionError) Error

func (e VersionError) Error() string

Error returns the error message.