enum

Documentation

Index

• type Enum
  • func FromFile(f *fs.File) *Enum
  • func New[T bytes.ByteKeeper](name string, content T) *Enum
  • func (e *Enum) Check() error
  • func (e *Enum) GetAST() (schema.ASTNode, error)
  • func (e *Enum) Len() (uint, error)
  • func (e *Enum) Values() ([]Value, error)
• type Value

Types

type Enum

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

The Enum rule.

func FromFile

func FromFile(f *fs.File) *Enum

FromFile creates Enum rule from specified file.

func New

func New[T bytes.ByteKeeper](name string, content T) *Enum

New creates new Enum rule with specified name and content.

func (*Enum) Check

func (e *Enum) Check() error

Check checks that enum is valid.

func (*Enum) GetAST

func (e *Enum) GetAST() (schema.ASTNode, error)

func (*Enum) Len

func (e *Enum) Len() (uint, error)

func (*Enum) Values

func (e *Enum) Values() ([]Value, error)

Values returns a list of values defined in this enum.

type Value

type Value struct {
	// Comment value's comment.
	Comment string

	// Type value type.
	Type schema.SchemaType

	// Value enum value.
	Value bytes.Bytes
}

Value represents single enum's value.