state

Documentation

Index

• Variables
• type DefaultState
  • func NewDefault() *DefaultState
  • func (d *DefaultState) AddEvents(sync *api.SyncResponse) error
  • func (d *DefaultState) EachRoomState(id matrix.RoomID, typ event.Type, f func(string, event.StateEvent) error) error
  • func (d *DefaultState) RoomState(roomID matrix.RoomID, eventType event.Type, key string) (event.StateEvent, error)
  • func (d *DefaultState) RoomStates(roomID matrix.RoomID, eventType event.Type) (map[string]event.StateEvent, error)
  • func (d *DefaultState) RoomSummary(roomID matrix.RoomID) (api.SyncRoomSummary, error)
• type RoomState

Variables

var ErrStopIter error

ErrStopIter is a copy of gotrix.ErrStopIter.

Types

type DefaultState

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

DefaultState is the default used implementation of state by the gotrix package.

func NewDefault

func NewDefault() *DefaultState

NewDefault returns a DefaultState that has been initialized empty.

func (*DefaultState) AddEvents

func (d *DefaultState) AddEvents(sync *api.SyncResponse) error

AddEvents sets the room state events inside a DefaultState to be returned by DefaultState later.

func (*DefaultState) EachRoomState

func (d *DefaultState) EachRoomState(id matrix.RoomID, typ event.Type, f func(string, event.StateEvent) error) error

EachRoomState calls f for every event of the specified type. It terminates iteration when an error is returned. Use ErrStopIter to denote a non-failure condition. It makes a copy internally and calls f on it.

func (*DefaultState) RoomState

func (d *DefaultState) RoomState(roomID matrix.RoomID, eventType event.Type, key string) (event.StateEvent, error)

RoomState returns the last event added in AddEvents. It never returns an error as it does not forget state.

func (*DefaultState) RoomStates

func (d *DefaultState) RoomStates(roomID matrix.RoomID, eventType event.Type) (map[string]event.StateEvent, error)

RoomStates returns the last set of events added in AddEvents.

func (*DefaultState) RoomSummary

func (d *DefaultState) RoomSummary(roomID matrix.RoomID) (api.SyncRoomSummary, error)

RoomSummary returns the summaries set in AddEvents.

type RoomState

type RoomState map[event.Type]map[string]event.StateEvent

RoomState is the state kept by a DefaultState for each room.