encoding

Documentation

Index

• type Codec
  • func (c *Codec) Decode(ctx context.Context, msg transport.Message) (*cloudevents.Event, error)
  • func (c *Codec) Encode(ctx context.Context, e cloudevents.Event) (transport.Message, error)
• type CodecStructured
• type CodecV02
  • func (v CodecV02) Decode(ctx context.Context, msg transport.Message) (*cloudevents.Event, error)
  • func (v CodecV02) Encode(ctx context.Context, e cloudevents.Event) (transport.Message, error)
• type CodecV03
  • func (v CodecV03) Decode(ctx context.Context, msg transport.Message) (*cloudevents.Event, error)
  • func (v CodecV03) Encode(ctx context.Context, e cloudevents.Event) (transport.Message, error)
• type CodecV1
  • func (v CodecV1) Decode(ctx context.Context, msg transport.Message) (*cloudevents.Event, error)
  • func (v CodecV1) Encode(ctx context.Context, e cloudevents.Event) (transport.Message, error)
• type Encoding
  • func (e Encoding) String() string
  • func (e Encoding) Version() string
• type EventBridgeMessage
  • func DecodeEventBridgeMessage(body []byte) (message *EventBridgeMessage, ok bool)
  • func (m *EventBridgeMessage) GetBody() []byte
  • func (m *EventBridgeMessage) IsValid() bool
• type Message
  • func (m Message) CloudEventsVersion() string
• type SNSMessage
  • func DecodeSNSMessage(body []byte) (message *SNSMessage, ok bool)
  • func (m *SNSMessage) GetBody() []byte
  • func (m *SNSMessage) IsNotification() bool

Types

type Codec

type Codec struct {
	Encoding      Encoding
	TransportName string
	// contains filtered or unexported fields
}

func (*Codec) Decode

func (c *Codec) Decode(ctx context.Context, msg transport.Message) (*cloudevents.Event, error)

func (*Codec) Encode

func (c *Codec) Encode(ctx context.Context, e cloudevents.Event) (transport.Message, error)

type CodecStructured

type CodecStructured struct {
	Encoding Encoding
}

CodecStructured represents an structured http transport codec for all versions. Intended to be used as a base class.

type CodecV02

type CodecV02 struct {
	CodecStructured

	TransportName string
	Encoding      Encoding
}

func (CodecV02) Decode

func (v CodecV02) Decode(ctx context.Context, msg transport.Message) (*cloudevents.Event, error)

func (CodecV02) Encode

func (v CodecV02) Encode(ctx context.Context, e cloudevents.Event) (transport.Message, error)

type CodecV03

type CodecV03 struct {
	CodecStructured

	TransportName string
	Encoding      Encoding
}

func (CodecV03) Decode

func (v CodecV03) Decode(ctx context.Context, msg transport.Message) (*cloudevents.Event, error)

func (CodecV03) Encode

func (v CodecV03) Encode(ctx context.Context, e cloudevents.Event) (transport.Message, error)

type CodecV1

type CodecV1 struct {
	CodecStructured

	TransportName string
	Encoding      Encoding
}

func (CodecV1) Decode

func (v CodecV1) Decode(ctx context.Context, msg transport.Message) (*cloudevents.Event, error)

func (CodecV1) Encode

func (v CodecV1) Encode(ctx context.Context, e cloudevents.Event) (transport.Message, error)

type Encoding

type Encoding int32

Encoding to use for NATS transport.

const (
	// Default allows NATS transport implementation to pick.
	Default Encoding = iota
	// StructuredV02 is Structured CloudEvents spec v0.2.
	StructuredV02
	// StructuredV03 is Structured CloudEvents spec v0.3.
	StructuredV03
	// StructuredV1 is Structured CloudEvents spec v1.0.
	StructuredV1
	// Unknown is unknown.
	Unknown
)

func (Encoding) String

func (e Encoding) String() string

String pretty-prints the encoding as a string.

func (Encoding) Version

func (e Encoding) Version() string

Version pretty-prints the encoding version as a string.

type EventBridgeMessage

type EventBridgeMessage struct {
	DetailType string      `json:"detail-type"` // In case of EventBridge, this value is nonempty string
	Detail     interface{} `json:"detail"`      // Message object
}

func DecodeEventBridgeMessage

func DecodeEventBridgeMessage(body []byte) (message *EventBridgeMessage, ok bool)

func (*EventBridgeMessage) GetBody

func (m *EventBridgeMessage) GetBody() []byte

func (*EventBridgeMessage) IsValid

func (m *EventBridgeMessage) IsValid() bool

type Message

type Message struct {
	Body []byte
}

func (Message) CloudEventsVersion

func (m Message) CloudEventsVersion() string

type SNSMessage

type SNSMessage struct {
	Type    string // In case of SNS, the type is "Notification"
	Message string // JSON encoded message
}

func DecodeSNSMessage

func DecodeSNSMessage(body []byte) (message *SNSMessage, ok bool)

func (*SNSMessage) GetBody

func (m *SNSMessage) GetBody() []byte

func (*SNSMessage) IsNotification

func (m *SNSMessage) IsNotification() bool