tags

README

go-tags

Work in progress.

Documentation

Overview

package tag provides interfaces and methods for working with tags.

Index

• func CleanStringTag(raw string) (string, error)
• func IsNotMachineTagError(err error) bool
• type NotMachineTagError
  • func (e NotMachineTagError) Error() string
• type StringTag
  • func (t *StringTag) Clean() string
  • func (t *StringTag) IsMachineTag() bool
  • func (t *StringTag) Namespace() (string, error)
  • func (t *StringTag) Predicate() (string, error)
  • func (t *StringTag) Raw() string
  • func (t *StringTag) Value() (string, error)
• type Tag
  • func NewStringTag(raw string) (Tag, error)

Functions

func CleanStringTag

func CleanStringTag(raw string) (string, error)

func IsNotMachineTagError

func IsNotMachineTagError(err error) bool

Return a boolean value indicating whether or not err is of type NotMachineTagError

Types

type NotMachineTagError

type NotMachineTagError struct{}

type NotMachineTagError defines an implementation of the error interface signaling that a tag is not a valid machine tag.

func (NotMachineTagError) Error

func (e NotMachineTagError) Error() string

The string representation of a NotMachineTagError error.

type StringTag

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

type StringTag implements the Tag interface for string-based tags.

func (*StringTag) Clean

func (t *StringTag) Clean() string

func (*StringTag) IsMachineTag

func (t *StringTag) IsMachineTag() bool

func (*StringTag) Namespace

func (t *StringTag) Namespace() (string, error)

func (*StringTag) Predicate

func (t *StringTag) Predicate() (string, error)

func (*StringTag) Raw

func (t *StringTag) Raw() string

func (*StringTag) Value

func (t *StringTag) Value() (string, error)

type Tag

type Tag interface {
	// The raw user-defined string tag value.
	Raw() string
	// The URI-safe value of the raw tag value.
	Clean() string
	// A boolean flag indicating whether or not the tag can be parsed as a machine tag.
	IsMachineTag() bool
	// The namespace value of a valid machine tag triple.
	Namespace() (string, error)
	// The predicate value of a valid machine tag triple.
	Predicate() (string, error)
	// The value of a valid machine tag triple.
	Value() (string, error)
}

type Tag defines a common interface for working with tag values.

func NewStringTag

func NewStringTag(raw string) (Tag, error)