format

Documentation

Overview

Package format formats structured events.

The "application/cloudevents+json" format is built-in and always available. Other formats may be added.

Index

• Constants
• Variables
• func Add(f Format)
• func IsFormat(mediaType string) bool
• func Marshal(mediaType string, e ce.Event) ([]byte, error)
• func Unmarshal(mediaType string, b []byte, e *ce.Event) error
• type Format
  • func Lookup(mediaType string) Format
• type UnknownFormat
  • func (uf UnknownFormat) Marshal(ce.Event) ([]byte, error)
  • func (uf UnknownFormat) MediaType() string
  • func (uf UnknownFormat) Unmarshal([]byte, *ce.Event) error

Constants

const Prefix = "application/cloudevents"

Prefix for event-format media types.

Variables

var JSON = jsonFmt{}

JSON is the built-in "application/cloudevents+json" format.

Functions

func Add

func Add(f Format)

Add a new Format. It can be retrieved by Lookup(f.MediaType())

func IsFormat

func IsFormat(mediaType string) bool

IsFormat returns true if mediaType begins with "application/cloudevents"

func Marshal

func Marshal(mediaType string, e ce.Event) ([]byte, error)

Marshal an event to bytes using the mediaType event format.

func Unmarshal

func Unmarshal(mediaType string, b []byte, e *ce.Event) error

Unmarshal bytes to an event using the mediaType event format.

Types

type Format

type Format interface {
	// MediaType identifies the format
	MediaType() string
	// Marshal event to bytes
	Marshal(ce.Event) ([]byte, error)
	// Unmarshal bytes to event
	Unmarshal([]byte, *ce.Event) error
}

Format marshals and unmarshals structured events to bytes.

func Lookup

func Lookup(mediaType string) Format

Lookup returns the format for mediaType, or nil if not found.

type UnknownFormat

type UnknownFormat string

UnknownFormat allows an event with an unknown format string to be forwarded, but Marshal() and Unmarshal will always fail.

func (UnknownFormat) Marshal

func (uf UnknownFormat) Marshal(ce.Event) ([]byte, error)

func (UnknownFormat) MediaType

func (uf UnknownFormat) MediaType() string

func (UnknownFormat) Unmarshal

func (uf UnknownFormat) Unmarshal([]byte, *ce.Event) error