stream

Documentation

Index

• Constants
• type Opcode
• type Reply
• type Request

Constants

const (
	// Success means that the action passed without any issues.
	Success result = iota
	// Failure means that the action failed to be executed.
	Failure
)

Types

type Opcode

type Opcode uint8

Opcode is used to specify allowed server operations.

const (
	// Undefined represents an undefined operation.
	Undefined Opcode = iota
	// Find represents the directive to find snippets.
	Find
	// List represents the action of listing out snippets.
	List
	// Insert represents the operaion of inserting snippets.
	Insert
	// Delete represents the directive to delete snippets.
	Delete
	// Reload represents the directive to reload the snippet container.
	Reload
)

type Reply

type Reply struct {
	Result result `json:"result"`
	Body   []byte `json:"body"`
}

Reply defines the data format for ther server reply.

type Request

type Request struct {
	Operation Opcode `json:"operation"`
	Body      []byte `json:"body"`
}

Request defines the data format for the server request.