journal

func LoadState ¶

func LoadState(cause error) error

LoadState wraps a journal state loading failure.

Parameters:

• cause: the underlying error.

Returns:

• error: "load journal state: <cause>"

func LoadStateErr ¶

func LoadStateErr(cause error) error

LoadStateErr wraps a failure to load journal processing state.

Parameters:

• cause: the underlying error

Returns:

• error: "load journal state: <cause>"

func LoadStateFailed ¶

func LoadStateFailed(cause error) error

LoadStateFailed wraps a journal state loading failure.

Parameters:

• cause: the underlying error

Returns:

• error: "load journal state: <cause>"

func NoDir ¶

func NoDir(path string) error

NoDir returns an error when the journal directory does not exist.

Parameters:

• path: absolute path to the missing journal directory.

Returns:

• error: includes a hint to run 'ctx recall export --all'

func NoEntries ¶

func NoEntries(path string) error

NoEntries returns an error when the journal directory has no entries.

Parameters:

• path: path to the empty journal directory.

Returns:

• error: includes a hint to run 'ctx recall export --all'

func NoEntriesMatch ¶

func NoEntriesMatch(patterns string) error

NoEntriesMatch returns an error when a pattern matches nothing.

Parameters:

• patterns: the patterns that matched nothing.

Returns:

• error: "no journal entries match: <patterns>"

func ReadDir ¶

func ReadDir(cause error) error

ReadDir wraps a failure to read the journal directory.

Parameters:

• cause: the underlying OS error.

Returns:

• error: "read journal directory: <cause>"

func RegenerateRequiresAll ¶

func RegenerateRequiresAll() error

RegenerateRequiresAll returns a validation error when --regenerate is used without --all.

Returns:

• error: explains the flag dependency

func SaveState ¶

func SaveState(cause error) error

SaveState wraps a journal state saving failure.

Parameters:

• cause: the underlying error.

Returns:

• error: "save journal state: <cause>"

func SaveStateFailed ¶

func SaveStateFailed(cause error) error

SaveStateFailed wraps a journal state save failure.

Parameters:

• cause: the underlying error

Returns:

• error: "save journal state: <cause>"

func Scan ¶

func Scan(cause error) error

Scan wraps a journal scanning failure.

Parameters:

• cause: the underlying scan error.

Returns:

• error: "failed to scan journal: <cause>"

func StageNotSet ¶

func StageNotSet(filename, stage string) error

StageNotSet returns an error when a journal stage has not been set.

Parameters:

• filename: the journal filename
• stage: the stage name

Returns:

• error: "<filename>: <stage> not set"

func UnknownStage ¶

func UnknownStage(stage, valid string) error

UnknownStage returns an error for an unrecognized journal stage.

Parameters:

• stage: the unknown stage name
• valid: comma-separated list of valid stage names

Returns:

• error: "unknown stage <stage>; valid: <valid>"