mirror of
				https://github.com/superseriousbusiness/gotosocial.git
				synced 2025-11-03 18:52:24 -06:00 
			
		
		
		
	* [chore] Remove years from all license headers Years or year ranges aren't required in license headers. Many projects have removed them in recent years and it avoids a bit of yearly toil. In many cases our copyright claim was also a bit dodgy since we added the 2021-2023 header to files created after 2021 but you can't claim copyright into the past that way. * [chore] Add license header check This ensures a license header is always added to any new file. This avoids maintainers/reviewers needing to remember to check for and ask for it in case a contribution doesn't include it. * [chore] Add missing license headers * [chore] Further updates to license header * Use the more common // indentend comment format * Remove the hack we had for the linter now that we use the // format * Add SPDX license identifier
		
			
				
	
	
		
			56 lines
		
	
	
	
		
			2 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
			
		
		
	
	
			56 lines
		
	
	
	
		
			2 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
// GoToSocial
 | 
						|
// Copyright (C) GoToSocial Authors admin@gotosocial.org
 | 
						|
// SPDX-License-Identifier: AGPL-3.0-or-later
 | 
						|
//
 | 
						|
// This program is free software: you can redistribute it and/or modify
 | 
						|
// it under the terms of the GNU Affero General Public License as published by
 | 
						|
// the Free Software Foundation, either version 3 of the License, or
 | 
						|
// (at your option) any later version.
 | 
						|
//
 | 
						|
// This program is distributed in the hope that it will be useful,
 | 
						|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
 | 
						|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 | 
						|
// GNU Affero General Public License for more details.
 | 
						|
//
 | 
						|
// You should have received a copy of the GNU Affero General Public License
 | 
						|
// along with this program.  If not, see <http://www.gnu.org/licenses/>.
 | 
						|
 | 
						|
package state
 | 
						|
 | 
						|
import (
 | 
						|
	"github.com/superseriousbusiness/gotosocial/internal/cache"
 | 
						|
	"github.com/superseriousbusiness/gotosocial/internal/db"
 | 
						|
	"github.com/superseriousbusiness/gotosocial/internal/storage"
 | 
						|
	"github.com/superseriousbusiness/gotosocial/internal/workers"
 | 
						|
)
 | 
						|
 | 
						|
// 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.
 | 
						|
type State struct {
 | 
						|
	// Caches provides access to this state's collection of caches.
 | 
						|
	Caches cache.Caches
 | 
						|
 | 
						|
	// DB provides access to the database.
 | 
						|
	DB db.DB
 | 
						|
 | 
						|
	// Storage provides access to the storage driver.
 | 
						|
	Storage *storage.Driver
 | 
						|
 | 
						|
	// Workers provides access to this state's collection of worker pools.
 | 
						|
	Workers workers.Workers
 | 
						|
 | 
						|
	// prevent pass-by-value.
 | 
						|
	_ nocopy
 | 
						|
}
 | 
						|
 | 
						|
// nocopy when embedded will signal linter to
 | 
						|
// error on pass-by-value of parent struct.
 | 
						|
type nocopy struct{}
 | 
						|
 | 
						|
func (*nocopy) Lock() {}
 | 
						|
 | 
						|
func (*nocopy) Unlock() {}
 |