json

Documentation

Overview

Package json implements a simple encoder and decoder for streams of watch events over io.Writer/Readers

Index

• func NewWatchEvent() interface{}
• func Object(codec runtime.Codec, event *watch.Event) (interface{}, error)
• type Decoder
  • func NewDecoder(r io.ReadCloser, codec runtime.Codec) *Decoder
  • func (d *Decoder) Close()
  • func (d *Decoder) Decode() (watch.EventType, runtime.Object, error)
• type Encoder
  • func NewEncoder(w io.Writer, codec runtime.Codec) *Encoder
  • func (e *Encoder) Encode(event *watch.Event) error

Functions

func NewWatchEvent

func NewWatchEvent() interface{}

NewWatchEvent returns the serialization form of watchEvent for structured schemas

func Object

func Object(codec runtime.Codec, event *watch.Event) (interface{}, error)

Object converts a watch.Event into an appropriately serializable JSON object

Types

type Decoder

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

Decoder implements the watch.Decoder interface for io.ReadClosers that have contents which consist of a series of watchEvent objects encoded via JSON. It will decode any object registered in the supplied codec.

func NewDecoder

func NewDecoder(r io.ReadCloser, codec runtime.Codec) *Decoder

NewDecoder creates an Decoder for the given writer and codec.

func (*Decoder) Close

func (d *Decoder) Close()

Close closes the underlying r.

func (*Decoder) Decode

func (d *Decoder) Decode() (watch.EventType, runtime.Object, error)

Decode blocks until it can return the next object in the writer. Returns an error if the writer is closed or an object can't be decoded.

type Encoder

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

Encoder implements the json.Encoder interface for io.Writers that should serialize watchEvent objects into JSON. It will encode any object registered in the supplied codec and return an error otherwies.

func NewEncoder

func NewEncoder(w io.Writer, codec runtime.Codec) *Encoder

NewEncoder creates an Encoder for the given writer and codec

func (*Encoder) Encode

func (e *Encoder) Encode(event *watch.Event) error

Encode writes an event to the writer. Returns an error if the writer is closed or an object can't be encoded.