assets

Documentation

Index

• func NewSessionAssets(cache *AssetCache, server AssetServer) flows.SessionAssets
• type AssetCache
  • func NewAssetCache(maxSize int64, pruneItems int) *AssetCache
  • func (c *AssetCache) GetAsset(server AssetServer, itemType assetType, itemUUID string) (interface{}, error)
  • func (c *AssetCache) Include(data json.RawMessage) error
  • func (c *AssetCache) Shutdown()
• type AssetServer
  • func NewAssetServer(authToken string, typeURLs map[assetType]string, httpClient *utils.HTTPClient) AssetServer
  • func ReadAssetServer(authToken string, httpClient *utils.HTTPClient, data json.RawMessage) (AssetServer, error)
• type MockAssetServer
  • func NewMockAssetServer() *MockAssetServer
  • func (s *MockAssetServer) MarshalJSON() ([]byte, error)
  • func (s *MockAssetServer) MockResponse(url string, response json.RawMessage)
  • func (s *MockAssetServer) MockedRequests() []string

Functions

func NewSessionAssets

func NewSessionAssets(cache *AssetCache, server AssetServer) flows.SessionAssets

NewSessionAssets creates a new session assets instance with the provided base URLs

Types

type AssetCache

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

AssetCache fetches and caches assets for the engine

func NewAssetCache

func NewAssetCache(maxSize int64, pruneItems int) *AssetCache

NewAssetCache creates a new asset cache

func (*AssetCache) GetAsset

func (c *AssetCache) GetAsset(server AssetServer, itemType assetType, itemUUID string) (interface{}, error)

GetAsset gets an asset from the cache if it's there or from the asset server

func (*AssetCache) Include

func (c *AssetCache) Include(data json.RawMessage) error

Include loads assets from the given raw JSON into the cache

func (*AssetCache) Shutdown

func (c *AssetCache) Shutdown()

Shutdown shuts down this asset cache

type AssetServer

type AssetServer interface {
	// contains filtered or unexported methods
}

AssetServer describes the asset server we'll fetch missing assets from

func NewAssetServer

func NewAssetServer(authToken string, typeURLs map[assetType]string, httpClient *utils.HTTPClient) AssetServer

NewAssetServer creates a new asset server

func ReadAssetServer

func ReadAssetServer(authToken string, httpClient *utils.HTTPClient, data json.RawMessage) (AssetServer, error)

ReadAssetServer reads an asset server fronm the given JSON

type MockAssetServer

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

func NewMockAssetServer

func NewMockAssetServer() *MockAssetServer

NewMockAssetServer creates a new mocked asset server for testing

func (*MockAssetServer) MarshalJSON

func (s *MockAssetServer) MarshalJSON() ([]byte, error)

MarshalJSON marshals this mock asset server into JSON

func (*MockAssetServer) MockResponse

func (s *MockAssetServer) MockResponse(url string, response json.RawMessage)

func (*MockAssetServer) MockedRequests

func (s *MockAssetServer) MockedRequests() []string