state

Documentation

Index

• type State

Types

type State

type State struct {
	// Caches provides access to this state's collection of caches.
	Caches cache.Caches

	// Timelines provides access to this state's collection of timelines.
	Timelines timeline.Timelines

	// DB provides access to the database.
	DB db.DB

	// FedLocks provides access to this state's mutex
	// map of per URI federation locks, intended for
	// use in internal/federation functions.
	//
	// Used during account and status dereferencing,
	// and by the go-fed/activity library.
	FedLocks mutexes.MutexMap

	// ProcessingLocks provides access to this state's
	// mutex map of per URI locks, intended for use
	// in internal/processing functions, for example
	// when updating accounts, migrating, approving
	// or rejecting an account, changing stats or
	// pinned statuses, creating notifs, etc.
	ProcessingLocks mutexes.MutexMap

	// Storage provides access to the storage driver.
	Storage *storage.Driver

	// Workers provides access to this state's collection of worker pools.
	Workers workers.Workers
	// contains filtered or unexported fields
}

State provides a means of dependency injection and sharing of resources across different subpackages of the GoToSocial codebase. DO NOT assume that any particular field will be initialized if you are accessing this during initialization. A pointer to a State{} is often passed during subpackage initialization, while the returned subpackage type will later then be set and stored within the State{} itself.