Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

entities

package

Go to main page

Versions in this module

v0

v0.2.3

Jan 31, 2023

v0.2.2

Jan 31, 2023

v0.2.1

Jan 31, 2023

Changes in this version

+ func QueryDocument(d Documentable, name ...string) documents.Section

+ func RenderDocument(s documents.Section, level int) template.HTML

+ type Class struct

+ DocStatus DocStatus

+ Document Document

+ Element *rbxapijson.Class

+ ID string

+ MemberList []*Member

+ Members map[string]*Member

+ Metadata Metadata

+ Patches []builds.Patch

+ ReferenceList []ElementTyper

+ References map[rbxapijson.Type]ElementTyper

+ ReferrerList []Referrer

+ Referrers map[[2]string]Referrer

+ Removed bool

+ Subclasses []*Class

+ Superclasses []*Class

+ func (e *Class) ElementType() rbxapijson.Type

+ func (e *Class) GetDocStatus() DocStatus

+ func (e *Class) GetDocument() Document

+ func (e *Class) Identifier() string

+ func (e *Class) IsRemoved() bool

+ type DocStatus struct

+ AggregateProgress float64

+ AggregateStatus int

+ DetailsSections int

+ DetailsStatus int

+ ExampleCount int

+ ExamplesStatus int

+ HasDocument bool

+ SummaryOrphaned bool

+ SummaryStatus int

+ func (s DocStatus) ProgressString() string

+ func (s DocStatus) StatusString(status int) string

+ type Document interface

+ Query func(name ...string) documents.Section

+ Render func() template.HTML

+ SetRender func(renderer markdown.Renderer)

+ type Documentable interface

+ GetDocStatus func() DocStatus

+ GetDocument func() Document

+ type ElementTyper interface

+ ElementType func() rbxapijson.Type

+ Identifier func() string

+ type Entities struct

+ ClassList []*Class

+ Classes map[string]*Class

+ Coverage float32

+ EnumItems map[[2]string]*EnumItem

+ EnumList []*Enum

+ Enums map[string]*Enum

+ Members map[[2]string]*Member

+ TreeRoots []*Class

+ TypeCats []TypeCategory

+ TypeList []*Type

+ Types map[string]*Type

+ func GenerateEntities(patches []builds.Patch) (entities *Entities)

+ func (e *Entities) CoverageString() string

+ func (e *Entities) ElementStatusClasses(suffix bool, v ...interface{}) string

+ func (e *Entities) Icon(v ...interface{}) template.HTML

+ func (entities *Entities) AddClass(action *builds.Action, info builds.Info)

+ func (entities *Entities) AddEnum(action *builds.Action, info builds.Info)

+ func (entities *Entities) AddEnumItem(action *builds.Action, info builds.Info)

+ func (entities *Entities) AddMember(action *builds.Action, info builds.Info)

+ func (entities *Entities) ListAll() []interface{}

+ type Entity interface

+ IsRemoved func() bool

+ type Enum struct

+ DocStatus DocStatus

+ Document Document

+ Element *rbxapijson.Enum

+ ID string

+ ItemList []*EnumItem

+ Items map[string]*EnumItem

+ Metadata Metadata

+ Patches []builds.Patch

+ ReferrerList []Referrer

+ Referrers map[[2]string]Referrer

+ Removed bool

+ func (e *Enum) ElementType() rbxapijson.Type

+ func (e *Enum) GetDocStatus() DocStatus

+ func (e *Enum) GetDocument() Document

+ func (e *Enum) Identifier() string

+ func (e *Enum) IsRemoved() bool

+ type EnumItem struct

+ DocStatus DocStatus

+ Document Document

+ Element *rbxapijson.EnumItem

+ ID [2]string

+ Metadata Metadata

+ Parent *Enum

+ Patches []builds.Patch

+ Removed bool

+ func (e *EnumItem) GetDocStatus() DocStatus

+ func (e *EnumItem) GetDocument() Document

+ func (e *EnumItem) IsRemoved() bool

+ type Member struct

+ DocStatus DocStatus

+ Document Document

+ Element rbxapi.Member

+ ID [2]string

+ Metadata Metadata

+ Parent *Class

+ Patches []builds.Patch

+ ReferenceList []ElementTyper

+ References map[rbxapijson.Type]ElementTyper

+ Removed bool

+ func (e *Member) GetDocStatus() DocStatus

+ func (e *Member) GetDocument() Document

+ func (e *Member) IsRemoved() bool

+ type Metadata struct

+ func (m Metadata) GetInt(prop string) (i int)

+ type Referrer struct

+ Member *Member

+ Parameter *rbxapijson.Parameter

+ type Type struct

+ DocStatus DocStatus

+ Document Document

+ Element rbxapijson.Type

+ ID string

+ Metadata Metadata

+ ReferrerList []Referrer

+ Referrers map[[2]string]Referrer

+ Removed bool

+ RemovedRefList []Referrer

+ RemovedRefs map[[2]string]Referrer

+ func (e *Type) ElementType() rbxapijson.Type

+ func (e *Type) GetDocStatus() DocStatus

+ func (e *Type) GetDocument() Document

+ func (e *Type) Identifier() string

+ func (e *Type) IsRemoved() bool

+ type TypeCategory struct

+ Name string

+ Types []*Type