view

Documentation

Overview

Package view allows to get a View of entity.Entity objects

Index

• type Iterator
• type View
  • func New() *View
  • func (vw *View) Add(ent *entity.Entity) *entity.Entity
  • func (vw *View) Clear()
  • func (vw *View) Iterator(rtypes ...reflect.Type) Iterator
  • func (vw *View) Remove(ent *entity.Entity) error
  • func (vw View) Size() int
  • func (vw View) String() string

Types

type Iterator

type Iterator interface {
	// Next returns next element
	Next() Iterator
	// Value returns the current item value
	Value() *entity.Entity
}

Iterator for view

type View

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

View represent a set of entity.Entity objects

func New

func New() *View

New creates a new empty View

func (*View) Add

func (vw *View) Add(ent *entity.Entity) *entity.Entity

Add a entity.Entity instance to a View

func (*View) Clear

func (vw *View) Clear()

Clear removes all entity.Entity from the view.View

func (*View) Iterator

func (vw *View) Iterator(rtypes ...reflect.Type) Iterator

Iterator return an view.Iterator for the given varg reflect.Type

func (*View) Remove

func (vw *View) Remove(ent *entity.Entity) error

Remove a entity.Entity from a View

func (View) Size

func (vw View) Size() int

Size of entity.Entity in the View

func (View) String

func (vw View) String() string

String get a string representation of a View