jsonstream

package
v0.0.0-...-7ef7dd6 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 10, 2018 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// PullStatusDownloading represents downloading status.
	PullStatusDownloading = "downloading"
	// PullStatusWaiting represents waiting status.
	PullStatusWaiting = "waiting"
	// PullStatusResolving represents resolving status.
	PullStatusResolving = "resolving"
	// PullStatusResolved represents resolved status.
	PullStatusResolved = "resolved"
	// PullStatusExists represents exist status.
	PullStatusExists = "exists"
	// PullStatusDone represents done status.
	PullStatusDone = "done"
)

Variables

This section is empty.

Functions

func PullReferenceStatus

func PullReferenceStatus(short bool, msg JSONMessage) string

PullReferenceStatus returns the status of pulling the image reference.

NOTE: if the stdout is not terminal, it should only show the reference and status without progress bar.

Types

type Formater

type Formater interface {
	// BegineWrite write some datas at the stream beginning.
	BeginWrite() ([]byte, error)

	// EndWrite write some datas at the stream ending.
	EndWrite() ([]byte, error)

	// Write write a object be serialized.
	Write(o interface{}) ([]byte, error)
}

Formater define the data's format via stream transfer.

type JSONError

type JSONError struct {
	Code    int    `json:"code,omitempty"`
	Message string `json:"message,omitempty"`
}

JSONError wraps a concrete Code and Message as error.

func (*JSONError) Error

func (e *JSONError) Error() string

Error implement the error interface.

type JSONMessage

type JSONMessage struct {
	ID           string          `json:"id,omitempty"`
	Status       string          `json:"status,omitempty"`
	Detail       *ProgressDetail `json:"progressDetail,omitempty"`
	Error        *JSONError      `json:"errorDetail,omitempty"`
	ErrorMessage string          `json:"error,omitempty"`

	StartedAt time.Time `json:"started_at,omitempty"`
	UpdatedAt time.Time `json:"updated_at,omitempty"`
}

JSONMessage defines a message struct for jsonstream. It describes id, status, progress detail, started and updated.

type JSONStream

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

JSONStream represents a stream transfer, the data be encoded with json.

func New

func New(out io.Writer, f Formater) *JSONStream

New creates a 'JSONStream' instance and use a goroutine to recv/send data.

func (*JSONStream) Close

func (s *JSONStream) Close() error

Close closes the stream transfer.

func (*JSONStream) Wait

func (s *JSONStream) Wait()

Wait waits the stream to finish.

func (*JSONStream) WriteObject

func (s *JSONStream) WriteObject(obj interface{}) error

WriteObject writes a object to client via stream tranfer.

type ProgressDetail

type ProgressDetail struct {
	Current int64 `json:"current"`
	Total   int64 `json:"total"`
}

ProgressDetail represents the status.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL