message

Documentation

Overview

Package message provides functions for managing data used by conditions and transforms.

Index

• type Flag
• type Message
  • func New(opts ...func(*Message)) *Message
  • func (m *Message) AsControl() *Message
  • func (m *Message) Data() []byte
  • func (m *Message) DeleteValue(key string) error
  • func (m *Message) GetValue(key string) Value
  • func (m *Message) HasFlag(i Flag) bool
  • func (m *Message) IsControl() bool
  • func (m *Message) Metadata() []byte
  • func (m *Message) SetData(data []byte) *Message
  • func (m *Message) SetMetadata(metadata []byte) *Message
  • func (m *Message) SetValue(key string, value interface{}) error
  • func (m *Message) SkipEmptyValues() *Message
  • func (m *Message) SkipMissingValues() *Message
  • func (m *Message) SkipNullValues() *Message
  • func (m *Message) String() string
• type Value
  • func (v Value) Array() []Value
  • func (v Value) Bool() bool
  • func (v Value) Bytes() []byte
  • func (v Value) Exists() bool
  • func (v Value) Float() float64
  • func (v Value) Int() int64
  • func (v Value) IsArray() bool
  • func (v Value) IsEmpty() bool
  • func (v Value) IsMissing() bool
  • func (v Value) IsNull() bool
  • func (v Value) IsObject() bool
  • func (v Value) Map() map[string]Value
  • func (v Value) String() string
  • func (v Value) Uint() uint64
  • func (v Value) Value() any

Types

type Flag

type Flag int

const (

	// IsControl indicates that the message is a control message.
	IsControl Flag = iota
	// SkipNullValues indicates that null values should be ignored when processing the message.
	SkipNullValues
	// SkipMissingValues indicates that missing values should be ignored when processing the message.
	SkipMissingValues
	// SkipEmptyValues indicates that empty values should be ignored when processing the message.
	SkipEmptyValues
)

type Message

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

Message is the data structure that is handled by transforms and interpreted by conditions.

Data in each message can be accessed and modified as JSON text or binary data:

• JSON text is accessed using the GetValue, SetValue, and DeleteValue methods.
• Binary data is accessed using the Data and SetData methods.

Metadata is an additional data field that is meant to store information about the message, but can be used for any purpose. For JSON text, metadata is accessed using the GetValue, SetValue, and DeleteValue methods with a key prefixed with "meta" (e.g. "meta foo"). Binary metadata is accessed using the Metadata and SetMetadata methods.

Messages can also be configured as "control messages." Control messages are used for flow control in Substation functions and applications, but can be used for any purpose depending on the needs of a transform or condition. These messages should not contain data or metadata.

func New

func New(opts ...func(*Message)) *Message

New returns a new Message.

func (*Message) AsControl

func (m *Message) AsControl() *Message

AsControl sets the message as a control message.

func (*Message) Data

func (m *Message) Data() []byte

Data returns the message data.

func (*Message) DeleteValue

func (m *Message) DeleteValue(key string) error

DeleteValue deletes a value in the message data or metadata.

If the key is prefixed with "meta" (e.g. "meta foo"), then the value is removed from the metadata field, otherwise it is removed from the data field.

This only works with JSON text. If the message data or metadata is not JSON text, then this method does nothing.

func (*Message) GetValue

func (m *Message) GetValue(key string) Value

GetValue returns a value from the message data or metadata.

If the key is prefixed with "meta" (e.g. "meta foo"), then the value is retrieved from the metadata field, otherwise it is retrieved from the data field.

This only works with JSON text. If the message data or metadata is not JSON text, then an empty value is returned.

func (*Message) HasFlag

func (m *Message) HasFlag(i Flag) bool

HasFlag returns true if the message contains a flag.

func (*Message) IsControl

func (m *Message) IsControl() bool

IsControl returns true if the message is a control message.

func (*Message) Metadata

func (m *Message) Metadata() []byte

Metadata returns the message metadata.

func (*Message) SetData

func (m *Message) SetData(data []byte) *Message

SetData sets the message data.

func (*Message) SetMetadata

func (m *Message) SetMetadata(metadata []byte) *Message

SetMetadata sets the message metadata.

func (*Message) SetValue

func (m *Message) SetValue(key string, value interface{}) error

SetValue sets a value in the message data or metadata.

If the key is prefixed with "meta" (e.g. "meta foo"), then the value is placed into the metadata field, otherwise it is placed into the data field.

This only works with JSON text. If the message data or metadata is not JSON text, then this method does nothing.

func (*Message) SkipEmptyValues

func (m *Message) SkipEmptyValues() *Message

func (*Message) SkipMissingValues

func (m *Message) SkipMissingValues() *Message

func (*Message) SkipNullValues

func (m *Message) SkipNullValues() *Message

func (*Message) String

func (m *Message) String() string

String returns the message data as a string.

type Value

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

Value is a wrapper around gjson.Result that provides a consistent interface for converting values from JSON text.

func (Value) Array

func (v Value) Array() []Value

Array returns the value as a slice of Value.

func (Value) Bool

func (v Value) Bool() bool

Bool returns the value as a bool.

func (Value) Bytes

func (v Value) Bytes() []byte

Bytes returns the value as a byte slice.

func (Value) Exists

func (v Value) Exists() bool

Exists returns true if the value exists.

func (Value) Float

func (v Value) Float() float64

Float returns the value as a float64.

func (Value) Int

func (v Value) Int() int64

Int returns the value as an int64.

func (Value) IsArray

func (v Value) IsArray() bool

IsArray returns true if the value is an array.

func (Value) IsEmpty

func (v Value) IsEmpty() bool

IsEmpty returns true if the value is an empty string, empty array, empty object, or null.

func (Value) IsMissing

func (v Value) IsMissing() bool

IsMissing returns true if the value is missing.

func (Value) IsNull

func (v Value) IsNull() bool

IsNull returns true if the value is null.

func (Value) IsObject

func (v Value) IsObject() bool

IsObject returns true if the value is an object.

func (Value) Map

func (v Value) Map() map[string]Value

Map returns the value as a map of string to Value.

func (Value) String

func (v Value) String() string

String returns the value as a string.

func (Value) Uint

func (v Value) Uint() uint64

Uint returns the value as a uint64.

func (Value) Value

func (v Value) Value() any

Value returns the value as an interface{}.