Documentation ¶
Overview ¶
Package entity defines types for core application objects.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Benchmark ¶
type ChangeSummary ¶
type ChangeSummary struct { Benchmark *Benchmark EnvironmentUUID uuid.UUID CommitSHA string CommitSubject string change.Change }
ChangeSummary is a change with associated metadata.
type CommitIndexRange ¶
func SingleCommitIndexRange ¶
func SingleCommitIndexRange(idx int) CommitIndexRange
func (CommitIndexRange) String ¶
func (r CommitIndexRange) String() string
type Package ¶
func (*Package) ImportPath ¶
type Point ¶
type Point struct { ResultUUID uuid.UUID BenchmarkUUID uuid.UUID EnvironmentUUID uuid.UUID CommitSHA string CommitIndex int Value float64 }
Point in a benchmark result timeseries.
type Properties ¶
func (Properties) UUID ¶
func (p Properties) UUID() uuid.UUID
type Result ¶
type Result struct { File *DataFile Line int Benchmark *Benchmark Commit *Commit Environment Properties Metadata Properties Iterations uint64 Value float64 }
type TaskStatus ¶
type TaskStatus uint
TaskStatus describes the state of a task.
const ( TaskStatusCreated TaskStatus = iota + 1 // initial state TaskStatusInProgress // task has been sent to a worker and is in progress TaskStatusResultUploadStarted // result upload has begun TaskStatusResultUploaded // result upload complete TaskStatusCompleteSuccess // completed successfully TaskStatusCompleteError // completed with error TaskStatusHalted // worker stopped processing the task TaskStatusStaleTimeout // timed out due to inactivity )
Supported task status values.
func TaskStatusCompleteValues ¶
func TaskStatusCompleteValues() []TaskStatus
TaskStatusCompleteValues returns all complete task states.
func TaskStatusPendingValues ¶
func TaskStatusPendingValues() []TaskStatus
TaskStatusPendingValues returns all pending task states.
func TaskStatusString ¶
func TaskStatusString(s string) (TaskStatus, error)
TaskStatusString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.
func TaskStatusTerminalValues ¶
func TaskStatusTerminalValues() []TaskStatus
TaskStatusTerminalValues returns all terminal task states.
func TaskStatusValues ¶
func TaskStatusValues() []TaskStatus
TaskStatusValues returns all values of the enum
func (TaskStatus) IsATaskStatus ¶
func (i TaskStatus) IsATaskStatus() bool
IsATaskStatus returns "true" if the value is listed in the enum definition. "false" otherwise
func (TaskStatus) IsComplete ¶
func (s TaskStatus) IsComplete() bool
IsComplete reports whether this task was completed, either with a success or error.
func (TaskStatus) IsPending ¶
func (s TaskStatus) IsPending() bool
IsPending reports whether this task is in a pending state.
func (TaskStatus) IsTerminal ¶
func (s TaskStatus) IsTerminal() bool
IsTerminal reports whether the task is in a final state, meaning no further changes will happen to it. This could be because processing was completed (success or error), or processing could have stopped for some reason (halted by the worker, marked stale after inactivity).
func (TaskStatus) String ¶
func (i TaskStatus) String() string
type TaskType ¶
type TaskType uint
TaskType describes a type of task.
func TaskTypeString ¶
TaskTypeString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.
func TaskTypeValues ¶
func TaskTypeValues() []TaskType
TaskTypeValues returns all values of the enum
func (TaskType) IsATaskType ¶
IsATaskType returns "true" if the value is listed in the enum definition. "false" otherwise