synctypes

Documentation

Index

• Constants
• Variables
• type EventEnum
  • func AllEventEnums() []EventEnum
  • func EventEnumFromString(s string) (EventEnum, error)
• type StatusEnum
  • func AllStatusEnums() []StatusEnum
  • func StatusEnumFromString(s string) (StatusEnum, error)

Constants

const (
	// Idle ...
	Idle statusEnum = iota
	// Sync ...
	Sync
)

const (
	// Imported ...
	Imported eventEnum = iota
)

Variables

var ErrUnknownEvent = errors.New("sync event: unknown")

ErrUnknownEvent is thrown when an unknown sync event is encountered.

var ErrUnknownStatus = errors.New("sync status: unknown")

ErrUnknownStatus is thrown when an unknown sync status is encountered.

Types

type EventEnum

type EventEnum interface {
	Type() eventEnum
	String() string
}

EventEnum are the exported sync events

func AllEventEnums

func AllEventEnums() []EventEnum

AllEventEnums returns all of the sync events

func EventEnumFromString

func EventEnumFromString(s string) (EventEnum, error)

EventEnumFromString parses a string to return the sync event

type StatusEnum

type StatusEnum interface {
	Type() statusEnum
	String() string
}

StatusEnum are the available sync statuses of the node

func AllStatusEnums

func AllStatusEnums() []StatusEnum

AllStatusEnums returns all of the sync statuses

func StatusEnumFromString

func StatusEnumFromString(s string) (StatusEnum, error)

StatusEnumFromString parses a string to return the sync status