decode

package

v0.24.5 Latest Latest Go to latest Published: May 15, 2024 License: BSD-3-Clause Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

git.sr.ht/~ionous/tapestry

Links

Open Source Insights

Documentation ¶

Index ¶

func DecodeMessage(msg map[string]any) (ret compact.Message, err error)
func DecodeSignature(key string) (ret []string, err error)
func Hash(slot, fullsig string) uint64
func ParseMessage(v any) (ret compact.Message, err error)
type CustomDecoder
type Decoder
type PatternDecoder
type SignatureTable
- func (fac SignatureTable) Create(slot, fullsig string) (ret typeinfo.Instance, okay bool)
- func (fac SignatureTable) FindType(hash uint64) (ret any, okay bool)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func DecodeMessage ¶

func DecodeMessage(msg map[string]any) (ret compact.Message, err error)

unpack a map of plain values into a description of a tapestry command. doesn't operate recursively, and doesn't check to see if the command is one that exists.

func DecodeSignature ¶

func DecodeSignature(key string) (ret []string, err error)

given a key such as "Command noun:trait:change choice:" separate out the command name and parameter labels

func Hash ¶

func Hash(slot, fullsig string) uint64

Hash helper for generating signatures lookups. ex: bool_eval=Not: the sig includes all of the colon separated labels used to indicate a given type. the slot specifies the typename a command fits into.

func ParseMessage ¶

func ParseMessage(v any) (ret compact.Message, err error)

same as decode; errors if the passed value is something other than a map of plain values.

Types ¶

type CustomDecoder ¶

type CustomDecoder func(dec *Decoder, slot *typeinfo.Slot, plainData any) (typeinfo.Instance, error)

create an arbitrary command from arbitrary data ex. boolean literals are stored as actual bool values.

type Decoder ¶

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

func (*Decoder) Customize ¶

func (dec *Decoder) Customize(c CustomDecoder) *Decoder

customize the handling of specific slots.

func (*Decoder) Decode ¶

func (dec *Decoder) Decode(out typeinfo.Instance, plainData any) (err error)

given a desired output structure, read the passed plain data

func (*Decoder) Patternize ¶

func (dec *Decoder) Patternize(p PatternDecoder) *Decoder

handle conversion of unknown commands to scripted function calls.

func (*Decoder) Signatures ¶

func (dec *Decoder) Signatures(t ...map[uint64]typeinfo.Instance) *Decoder

provide translation from command signatures to actual commands. ex. "Tapestry:" to *story.StoryFile

type PatternDecoder ¶

type PatternDecoder func(dec *Decoder, slot *typeinfo.Slot, msg compact.Message) (typeinfo.Instance, error)

handle pattern parsing.

type SignatureTable ¶

type SignatureTable []map[uint64]typeinfo.Instance

hash to pointer to a nil value of the type ex. 15485098871275255450: (*Comparison)(nil)

func (SignatureTable) Create ¶

func (fac SignatureTable) Create(slot, fullsig string) (ret typeinfo.Instance, okay bool)

create a new instance of the type and return its pointer

func (SignatureTable) FindType ¶

func (fac SignatureTable) FindType(hash uint64) (ret any, okay bool)

return the nil pointer to the type.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL