handler

Documentation

Overview

Read and parse Refractor engine configuration files (.con)

Index

• type ErrGameNotSupported
  • func (e *ErrGameNotSupported) Error() string
• type FileRepository
• type Game
• type Handler
  • func New(repository FileRepository) *Handler
  • func (h *Handler) BuildBasePath(game Game) (string, error)
  • func (h *Handler) GetProfileKeys(game Game) ([]string, error)
  • func (h *Handler) IsValidProfileKey(game Game, profileKey string) (bool, error)
  • func (h *Handler) ReadConfigFile(path string) (*config.Config, error)
  • func (h *Handler) ReadGlobalConfig(game Game) (*config.Config, error)
  • func (h *Handler) ReadProfileConfig(game Game, profileKey string) (*config.Config, error)
  • func (h *Handler) WriteConfigFile(c *config.Config) error

Types

type ErrGameNotSupported

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

func (*ErrGameNotSupported) Error

func (e *ErrGameNotSupported) Error() string

type FileRepository

type FileRepository interface {
	FileExists(path string) (bool, error)
	WriteFile(path string, data []byte, perm os.FileMode) error
	ReadFile(path string) ([]byte, error)
	ReadDir(path string) ([]os.DirEntry, error)
}

type Game

type Game string

const (
	GameBf2 Game = "bf2"
)

type Handler

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

func New

func New(repository FileRepository) *Handler

func (*Handler) BuildBasePath

func (h *Handler) BuildBasePath(game Game) (string, error)

func (*Handler) GetProfileKeys

func (h *Handler) GetProfileKeys(game Game) ([]string, error)

Retrieve a list of profile keys (valid profile directories in the game's profile folder)

func (*Handler) IsValidProfileKey

func (h *Handler) IsValidProfileKey(game Game, profileKey string) (bool, error)

Checks whether a given profile key is valid (a profile with the given key exists)

func (*Handler) ReadConfigFile

func (h *Handler) ReadConfigFile(path string) (*config.Config, error)

func (*Handler) ReadGlobalConfig

func (h *Handler) ReadGlobalConfig(game Game) (*config.Config, error)

func (*Handler) ReadProfileConfig

func (h *Handler) ReadProfileConfig(game Game, profileKey string) (*config.Config, error)

func (*Handler) WriteConfigFile

func (h *Handler) WriteConfigFile(c *config.Config) error