admin

Documentation

Index

• Constants
• func RunAdminServer(ctx context.Context, setupOpts *controller.SetupOpts)
• type OutputFormat
  • func (f OutputFormat) String() string
• type SnapshotResponseData
  • func (r SnapshotResponseData) Format(format OutputFormat) ([]byte, error)
  • func (r SnapshotResponseData) MarshalJSON() ([]byte, error)
  • func (r SnapshotResponseData) MarshalJSONString() string

Constants

const (
	// Json marshals the data into json, with indents included
	Json = iota

	// JsonCompact marshals the data into json, but without indents
	JsonCompact

	// Yaml marshals the data into yaml
	Yaml
)

Functions

func RunAdminServer

func RunAdminServer(ctx context.Context, setupOpts *controller.SetupOpts)

Types

type OutputFormat

type OutputFormat int

OutputFormat identifies the format to output an object

func (OutputFormat) String

func (f OutputFormat) String() string

type SnapshotResponseData

type SnapshotResponseData struct {
	Data  any   `json:"data"`
	Error error `json:"error"`
}

SnapshotResponseData is the data that is returned by Getter methods on the History object It allows us to encapsulate data and errors together, so that if an issue occurs during the request, we can get access to all the relevant information

func (SnapshotResponseData) Format

func (r SnapshotResponseData) Format(format OutputFormat) ([]byte, error)

func (SnapshotResponseData) MarshalJSON

func (r SnapshotResponseData) MarshalJSON() ([]byte, error)

func (SnapshotResponseData) MarshalJSONString

func (r SnapshotResponseData) MarshalJSONString() string