Documentation
¶
Index ¶
- type Element
- type ElementMapper
- type Entry
- func (e *Entry) Next() Element
- func (e *Entry) Prev() Element
- func (e *Entry) SetNext(elem Element)
- func (e *Entry) SetPrev(elem Element)
- func (e *Entry) StateFields() []string
- func (e *Entry) StateLoad(ctx context.Context, stateSourceObject state.Source)
- func (e *Entry) StateSave(stateSinkObject state.Sink)
- func (e *Entry) StateTypeName() string
- type Linker
- type List
- func (l *List) Back() Element
- func (l *List) Empty() bool
- func (l *List) Front() Element
- func (l *List) InsertAfter(b, e Element)
- func (l *List) InsertBefore(a, e Element)
- func (l *List) Len() (count int)
- func (l *List) PushBack(e Element)
- func (l *List) PushBackList(m *List)
- func (l *List) PushFront(e Element)
- func (l *List) PushFrontList(m *List)
- func (l *List) Remove(e Element)
- func (l *List) Reset()
- func (l *List) StateFields() []string
- func (l *List) StateLoad(ctx context.Context, stateSourceObject state.Source)
- func (l *List) StateSave(stateSinkObject state.Sink)
- func (l *List) StateTypeName() string
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Element ¶
type Element interface {
Linker
}
Element the item that is used at the API level.
N.B. Like Linker, this is unlikely to be an interface in most cases.
type ElementMapper ¶
type ElementMapper struct{}
ElementMapper provides an identity mapping by default.
This can be replaced to provide a struct that maps elements to linker objects, if they are not the same. An ElementMapper is not typically required if: Linker is left as is, Element is left as is, or Linker and Element are the same type.
type Entry ¶
type Entry struct {
// contains filtered or unexported fields
}
Entry is a default implementation of Linker. Users can add anonymous fields of this type to their structs to make them automatically implement the methods needed by List.
+stateify savable
func (*Entry) StateFields ¶
func (*Entry) StateTypeName ¶
type Linker ¶
Linker is the interface that objects must implement if they want to be added to and/or removed from List objects.
N.B. When substituted in a template instantiation, Linker doesn't need to be an interface, and in most cases won't be.
type List ¶
type List struct {
// contains filtered or unexported fields
}
List is an intrusive list. Entries can be added to or removed from the list in O(1) time and with no additional memory allocations.
The zero value for List is an empty list ready to use.
To iterate over a list (where l is a List):
for e := l.Front(); e != nil; e = e.Next() {
// do something with e.
}
+stateify savable
func (*List) InsertBefore ¶
InsertBefore inserts e before a.
func (*List) PushBackList ¶
PushBackList inserts list m at the end of list l, emptying m.
func (*List) PushFrontList ¶
PushFrontList inserts list m at the start of list l, emptying m.
Source Files