aboutsummaryrefslogtreecommitdiffstats
path: root/bug/interface.go
diff options
context:
space:
mode:
Diffstat (limited to 'bug/interface.go')
-rw-r--r--bug/interface.go29
1 files changed, 9 insertions, 20 deletions
diff --git a/bug/interface.go b/bug/interface.go
index e71496a9..2ae31fd1 100644
--- a/bug/interface.go
+++ b/bug/interface.go
@@ -7,34 +7,34 @@ import (
)
type Interface interface {
- // Id return the Bug identifier
+ // Id returns the Bug identifier
Id() entity.Id
- // Validate check if the Bug data is valid
+ // Validate checks if the Bug data is valid
Validate() error
// Append an operation into the staging area, to be committed later
Append(op Operation)
- // Operations return the ordered operations
+ // Operations returns the ordered operations
Operations() []Operation
- // Indicate that the in-memory state changed and need to be commit in the repository
+ // NeedCommit indicates that the in-memory state changed and need to be commit in the repository
NeedCommit() bool
- // Commit write the staging area in Git and move the operations to the packs
+ // Commit writes the staging area in Git and move the operations to the packs
Commit(repo repository.ClockedRepo) error
- // Lookup for the very first operation of the bug.
+ // FirstOp lookup for the very first operation of the bug.
// For a valid Bug, this operation should be a CreateOp
FirstOp() Operation
- // Lookup for the very last operation of the bug.
+ // LastOp lookup for the very last operation of the bug.
// For a valid Bug, should never be nil
LastOp() Operation
- // Compile a bug in a easily usable snapshot
- Compile() Snapshot
+ // Compile a bug in an easily usable snapshot
+ Compile() *Snapshot
// CreateLamportTime return the Lamport time of creation
CreateLamportTime() lamport.Time
@@ -42,14 +42,3 @@ type Interface interface {
// EditLamportTime return the Lamport time of the last edit
EditLamportTime() lamport.Time
}
-
-func bugFromInterface(bug Interface) *Bug {
- switch bug := bug.(type) {
- case *Bug:
- return bug
- case *WithSnapshot:
- return bug.Bug
- default:
- panic("missing type case")
- }
-}