status

Documentation

Index

• func GetSourceMappings() map[Key]SrcMapping
• type Key
  • func ConvertSetToKeys(s set.Interface) []Key
• type SrcMapping
  • func (o SrcMapping) IsDocMappingASubstrOf(value string) bool
  • func (o SrcMapping) IsYAMLMappingEqualTo(value string) bool

Functions

func GetSourceMappings

func GetSourceMappings() map[Key]SrcMapping

GetSourceMappings returns a mapping of each implentation status to their respective sources.

Types

type Key

type Key uint8

Key is a unique value that represents the different types of possible implementation status value.

const (
	NoStatus Key = iota
	ImplementedStatus
	PartiallyImplementedStatus
	PlannedStatus
	AlternativeImplementationStatus
	NotApplicableStatus
)

Status prefixes.

func ConvertSetToKeys

func ConvertSetToKeys(s set.Interface) []Key

ConvertSetToKeys will convert the set, which each value is of type interface{} to the Key.

type SrcMapping

type SrcMapping map[source.Source]string

SrcMapping is a data structure that represents the text for a particular implementation status in a particular source.

func (SrcMapping) IsDocMappingASubstrOf

func (o SrcMapping) IsDocMappingASubstrOf(value string) bool

IsDocMappingASubstrOf is wrapper that checks if the input string contains the SSP mapping. This is useful because the input string value may have extra characters so we can't do a == (equal to) check.

func (SrcMapping) IsYAMLMappingEqualTo

func (o SrcMapping) IsYAMLMappingEqualTo(value string) bool

IsYAMLMappingEqualTo is a wrapper that checks if the input string equals to the YAML mapping.