federated

Documentation

Index

• Variables
• func PlatformStrings() []string
• func WorkerStrings() []string
• type Platform
  • func PlatformString(s string) (Platform, error)
  • func PlatformValues() []Platform
  • func (i Platform) IsAPlatform() bool
  • func (i Platform) MarshalJSON() ([]byte, error)
  • func (i Platform) MarshalYAML() (interface{}, error)
  • func (i *Platform) Scan(value interface{}) error
  • func (i Platform) String() string
  • func (i *Platform) UnmarshalJSON(data []byte) error
  • func (p *Platform) UnmarshalParam(param string) error
  • func (i *Platform) UnmarshalYAML(unmarshal func(interface{}) error) error
  • func (i Platform) Value() (driver.Value, error)
  • func (Platform) Values() []string
• type Worker
  • func GetValueByWorkerStr(workerStr string) Worker
  • func WorkerString(s string) (Worker, error)
  • func WorkerValues() []Worker
  • func (w Worker) Component() string
  • func (i Worker) IsAWorker() bool
  • func (i Worker) MarshalJSON() ([]byte, error)
  • func (i Worker) MarshalYAML() (interface{}, error)
  • func (w Worker) Name() string
  • func (i *Worker) Scan(value interface{}) error
  • func (i Worker) String() string
  • func (i *Worker) UnmarshalJSON(data []byte) error
  • func (w *Worker) UnmarshalParam(param string) error
  • func (i *Worker) UnmarshalYAML(unmarshal func(interface{}) error) error
  • func (i Worker) Value() (driver.Value, error)
  • func (Worker) Values() []string

Variables

var ToPlatformMap = map[Worker]Platform{
	Core: PlatformMastodon,
}

ToPlatformMap is a map of worker to platform

var ToTagsMap = map[Worker][]tag.Tag{
	Core: {tag.Social},
}

ToTagsMap is a map of worker to tags

Functions

func PlatformStrings

func PlatformStrings() []string

PlatformStrings returns a slice of all String values of the enum

func WorkerStrings

func WorkerStrings() []string

WorkerStrings returns a slice of all String values of the enum

Types

type Platform

type Platform uint64

const (
	PlatformUnknown  Platform = iota // Unknown
	PlatformMastodon                 // Mastodon
)

func PlatformString

func PlatformString(s string) (Platform, error)

PlatformString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.

func PlatformValues

func PlatformValues() []Platform

PlatformValues returns all values of the enum

func (Platform) IsAPlatform

func (i Platform) IsAPlatform() bool

IsAPlatform returns "true" if the value is listed in the enum definition. "false" otherwise

func (Platform) MarshalJSON

func (i Platform) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for Platform

func (Platform) MarshalYAML

func (i Platform) MarshalYAML() (interface{}, error)

MarshalYAML implements a YAML Marshaler for Platform

func (*Platform) Scan

func (i *Platform) Scan(value interface{}) error

func (Platform) String

func (i Platform) String() string

func (*Platform) UnmarshalJSON

func (i *Platform) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for Platform

func (*Platform) UnmarshalParam

func (p *Platform) UnmarshalParam(param string) error

func (*Platform) UnmarshalYAML

func (i *Platform) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements a YAML Unmarshaler for Platform

func (Platform) Value

func (i Platform) Value() (driver.Value, error)

func (Platform) Values

func (Platform) Values() []string

type Worker

type Worker int

const (
	Core Worker = iota + 1 // core
)

func GetValueByWorkerStr

func GetValueByWorkerStr(workerStr string) Worker

func WorkerString

func WorkerString(s string) (Worker, error)

WorkerString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.

func WorkerValues

func WorkerValues() []Worker

WorkerValues returns all values of the enum

func (Worker) Component

func (w Worker) Component() string

func (Worker) IsAWorker

func (i Worker) IsAWorker() bool

IsAWorker returns "true" if the value is listed in the enum definition. "false" otherwise

func (Worker) MarshalJSON

func (i Worker) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for Worker

func (Worker) MarshalYAML

func (i Worker) MarshalYAML() (interface{}, error)

MarshalYAML implements a YAML Marshaler for Worker

func (Worker) Name

func (w Worker) Name() string

func (*Worker) Scan

func (i *Worker) Scan(value interface{}) error

func (Worker) String

func (i Worker) String() string

func (*Worker) UnmarshalJSON

func (i *Worker) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for Worker

func (*Worker) UnmarshalParam

func (w *Worker) UnmarshalParam(param string) error

func (*Worker) UnmarshalYAML

func (i *Worker) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements a YAML Unmarshaler for Worker

func (Worker) Value

func (i Worker) Value() (driver.Value, error)

func (Worker) Values

func (Worker) Values() []string