stateloader

Documentation

Index

• Constants
• func ContainsSubstring(substring string) func(string) bool
• func FilterEmptyStrings(s string) bool
• func LoadAllState(ctx context.Context, paths []files.Path, loader StateLoader) (*files.System[*files.State], error)
• func SyncedFiles(ctx context.Context, g git.Git, loader StateLoader, loc string, ...) (*files.System[*files.State], error)
• type ParseConfig
  • func RecommendedNewlineSeparatedConfig() ParseConfig
• type ParseResult
  • func Parse(ctx context.Context, loader StateLoader, path files.Path, conf ParseConfig) (*ParseResult, error)
• type StateLoader

Constants

const RecommendedSectionEnd = "END OF AUTOGENERATED SECTION BY SYNCER"

const RecommendedSectionStart = "THIS SECTION IS AUTOGENERATED BY SYNCER, DO NOT EDIT"

Functions

func ContainsSubstring

func ContainsSubstring(substring string) func(string) bool

func FilterEmptyStrings

func FilterEmptyStrings(s string) bool

func LoadAllState

func LoadAllState(ctx context.Context, paths []files.Path, loader StateLoader) (*files.System[*files.State], error)

func SyncedFiles

func SyncedFiles(ctx context.Context, g git.Git, loader StateLoader, loc string, syncFlag string) (*files.System[*files.State], error)

Types

type ParseConfig

type ParseConfig struct {
	SplitBy       string
	StartSection  func(string) bool
	EndSection    func(string) bool
	SectionTrim   func(string) string
	SectionSorter func([]string)
	Filter        func(string) bool
}

func RecommendedNewlineSeparatedConfig

func RecommendedNewlineSeparatedConfig() ParseConfig

type ParseResult

type ParseResult struct {
	State          *files.State
	PreAutogenMsg  string
	AutogenMsg     string
	PostAutogenMsg string
}

func Parse

func Parse(ctx context.Context, loader StateLoader, path files.Path, conf ParseConfig) (*ParseResult, error)

type StateLoader

type StateLoader interface {
	LoadState(ctx context.Context, path files.Path) (*files.State, error)
}