stash/vendor/github.com/gobuffalo/events/event.go

package events

import (
	"encoding/json"
	"errors"
	"strings"
)

// Event represents different events
// in the lifecycle of a Buffalo app
type Event struct {
	// Kind is the "type" of event "app:start"
	Kind string `json:"kind"`
	// Message is optional
	Message string `json:"message"`
	// Payload is optional
	Payload Payload `json:"payload"`
	// Error is optional
	Error error `json:"-"`
}

func (e Event) String() string {
	b, _ := e.MarshalJSON()

	return string(b)
}

// MarshalJSON implements the json marshaler for an event
func (e Event) MarshalJSON() ([]byte, error) {
	m := map[string]interface{}{
		"kind": e.Kind,
	}
	if len(e.Message) != 0 {
		m["message"] = e.Message
	}
	if e.Error != nil {
		m["error"] = e.Error.Error()
	}
	if len(e.Payload) != 0 {
		m["payload"] = e.Payload
	}

	return json.Marshal(m)
}

// Validate that an event is ready to be emitted
func (e Event) Validate() error {
	if len(e.Kind) == 0 {
		return errors.New("kind can not be blank")
	}
	return nil
}

func (e Event) IsError() bool {
	return strings.HasSuffix(e.Kind, ":err")
}