clout

Documentation

Index

• Constants
• func NewKey() string
• type Clout
  • func Load(context contextpkg.Context, url exturl.URL, forceFormat string) (*Clout, error)
  • func NewClout() *Clout
  • func Read(reader io.Reader, format string) (*Clout, error)
  • func Unpack(map_ ard.Map) (*Clout, error)
  • func (self *Clout) Copy() (*Clout, error)
  • func (self *Clout) CopyAsIs() *Clout
  • func (self *Clout) MarshalJSON() ([]byte, error)
  • func (self *Clout) MarshalableStringMaps() any
  • func (self *Clout) NewVertex(id string) *Vertex
  • func (self *Clout) Resolve() error
  • func (self *Clout) ResolveEdges() error
• type Edge
  • func (self *Edge) GetMetadata() ard.StringMap
  • func (self *Edge) GetProperties() ard.StringMap
  • func (self *Edge) MarshalCBOR() ([]byte, error)
  • func (self *Edge) MarshalJSON() ([]byte, error)
  • func (self *Edge) MarshalMsgpack() ([]byte, error)
  • func (self *Edge) MarshalYAML() (any, error)
  • func (self *Edge) Marshalable(stringMaps bool) any
  • func (self *Edge) Remove()
  • func (self *Edge) ToARD(reflector *ard.Reflector) (any, error)
  • func (self *Edge) Unmarshal(f func(m *MarshalableEdge) error) error
  • func (self *Edge) UnmarshalCBOR(data []byte) error
  • func (self *Edge) UnmarshalJSON(data []byte) error
  • func (self *Edge) UnmarshalMsgpack(data []byte) error
  • func (self *Edge) UnmarshalYAML(unmarshal func(any) error) error
• type Edges
  • func (self Edges) Size() int
• type Entity
• type MarshalableCloutStringMaps
• type MarshalableEdge
• type MarshalableEdgeStringMaps
• type MarshalableVertexStringMaps
• type Vertex
  • func (self *Vertex) GetMetadata() ard.StringMap
  • func (self *Vertex) GetProperties() ard.StringMap
  • func (self *Vertex) MarshalJSON() ([]byte, error)
  • func (self *Vertex) MarshalableStringMaps() any
  • func (self *Vertex) NewEdgeTo(target *Vertex) *Edge
  • func (self *Vertex) NewEdgeToID(targetId string) *Edge
  • func (self *Vertex) Remove()
• type Vertexes

Constants

const Version = "1.0"

Functions

func NewKey

func NewKey() string

Types

type Clout

type Clout struct {
	Version    string        `json:"version" yaml:"version" ard:"version"`
	Metadata   ard.StringMap `json:"metadata" yaml:"metadata" ard:"metadata"`
	Properties ard.StringMap `json:"properties" yaml:"properties" ard:"properties"`
	Vertexes   Vertexes      `json:"vertexes" yaml:"vertexes" ard:"vertexes"`
}

func Load

func Load(context contextpkg.Context, url exturl.URL, forceFormat string) (*Clout, error)

func NewClout

func NewClout() *Clout

func Read

func Read(reader io.Reader, format string) (*Clout, error)

func Unpack

func Unpack(map_ ard.Map) (*Clout, error)

func (*Clout) Copy

func (self *Clout) Copy() (*Clout, error)

Creates a copy of the Clout in which ARD is used for all data.

func (*Clout) CopyAsIs

func (self *Clout) CopyAsIs() *Clout

Creates a copy of the Clout in which non-ARD data is left as is.

func (*Clout) MarshalJSON

func (self *Clout) MarshalJSON() ([]byte, error)

(json.Marshaler interface)

func (*Clout) MarshalableStringMaps

func (self *Clout) MarshalableStringMaps() any

func (*Clout) NewVertex

func (self *Clout) NewVertex(id string) *Vertex

func (*Clout) Resolve

func (self *Clout) Resolve() error

func (*Clout) ResolveEdges

func (self *Clout) ResolveEdges() error

type Edge

type Edge struct {
	Metadata   ard.StringMap
	Properties ard.StringMap
	Source     *Vertex
	TargetID   string
	Target     *Vertex
}

func (*Edge) GetMetadata

func (self *Edge) GetMetadata() ard.StringMap

Entity interface

func (*Edge) GetProperties

func (self *Edge) GetProperties() ard.StringMap

Entity interface

func (*Edge) MarshalCBOR

func (self *Edge) MarshalCBOR() ([]byte, error)

(cbor.Marshaler interface)

func (*Edge) MarshalJSON

func (self *Edge) MarshalJSON() ([]byte, error)

(json.Marshaler interface)

func (*Edge) MarshalMsgpack

func (self *Edge) MarshalMsgpack() ([]byte, error)

(msgpack.Marshaler interface)

func (*Edge) MarshalYAML

func (self *Edge) MarshalYAML() (any, error)

([yaml.Marshaler] interface)

func (*Edge) Marshalable

func (self *Edge) Marshalable(stringMaps bool) any

func (*Edge) Remove

func (self *Edge) Remove()

func (*Edge) ToARD

func (self *Edge) ToARD(reflector *ard.Reflector) (any, error)

(ard.ToARD interface)

func (*Edge) Unmarshal

func (self *Edge) Unmarshal(f func(m *MarshalableEdge) error) error

func (*Edge) UnmarshalCBOR

func (self *Edge) UnmarshalCBOR(data []byte) error

cbor.Unmarshaler interface

func (*Edge) UnmarshalJSON

func (self *Edge) UnmarshalJSON(data []byte) error

json.Unmarshaler interface

func (*Edge) UnmarshalMsgpack

func (self *Edge) UnmarshalMsgpack(data []byte) error

msgpack.Unmarshaler interface

func (*Edge) UnmarshalYAML

func (self *Edge) UnmarshalYAML(unmarshal func(any) error) error

yaml.Unmarshaler interface

type Edges

type Edges []*Edge

func (Edges) Size

func (self Edges) Size() int

Note: ".length" will not work reliably in JavaScript because once the value is bound it will not reflect changes to the struct's field

type Entity

type Entity interface {
	GetMetadata() ard.StringMap
	GetProperties() ard.StringMap
}

type MarshalableCloutStringMaps

type MarshalableCloutStringMaps Clout

type MarshalableEdge

type MarshalableEdge struct {
	Metadata   ard.StringMap `json:"metadata" yaml:"metadata" ard:"metadata"`
	Properties ard.StringMap `json:"properties" yaml:"properties" ard:"properties"`
	TargetID   string        `json:"targetID" yaml:"targetID" ard:"targetID"`
}

type MarshalableEdgeStringMaps

type MarshalableEdgeStringMaps struct {
	Metadata   ard.StringMap `json:"metadata"`
	Properties ard.StringMap `json:"properties"`
	TargetID   string        `json:"targetID"`
}

type MarshalableVertexStringMaps

type MarshalableVertexStringMaps struct {
	Metadata   ard.StringMap `json:"metadata"`
	Properties ard.StringMap `json:"properties"`
	EdgesOut   Edges         `json:"edgesOut"`
}

type Vertex

type Vertex struct {
	Clout      *Clout        `json:"-" yaml:"-"`
	ID         string        `json:"-" yaml:"-"`
	Metadata   ard.StringMap `json:"metadata" yaml:"metadata"`
	Properties ard.StringMap `json:"properties" yaml:"properties"`
	EdgesOut   Edges         `json:"edgesOut" yaml:"edgesOut"`
	EdgesIn    Edges         `json:"-" yaml:"-"`
}

func (*Vertex) GetMetadata

func (self *Vertex) GetMetadata() ard.StringMap

Entity interface

func (*Vertex) GetProperties

func (self *Vertex) GetProperties() ard.StringMap

Entity interface

func (*Vertex) MarshalJSON

func (self *Vertex) MarshalJSON() ([]byte, error)

(json.Marshaler interface)

func (*Vertex) MarshalableStringMaps

func (self *Vertex) MarshalableStringMaps() any

func (*Vertex) NewEdgeTo

func (self *Vertex) NewEdgeTo(target *Vertex) *Edge

func (*Vertex) NewEdgeToID

func (self *Vertex) NewEdgeToID(targetId string) *Edge

func (*Vertex) Remove

func (self *Vertex) Remove()

type Vertexes

type Vertexes map[string]*Vertex