github.com/vescale/zgraph@v0.0.0-20230410094002-959c02d50f95/storage/mvcc/errors.go (about)

     1  // Copyright 2022 zGraph Authors. All rights reserved.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package mvcc
    16  
    17  import (
    18  	"fmt"
    19  
    20  	"github.com/vescale/zgraph/storage/kv"
    21  )
    22  
    23  // LockedError is returned when trying to Read/Write on a locked key. Caller should
    24  // backoff or cleanup the lock then retry.
    25  type LockedError struct {
    26  	Key      kv.Key
    27  	Primary  kv.Key
    28  	StartVer kv.Version
    29  	TTL      uint64
    30  }
    31  
    32  // Error formats the lock to a string.
    33  func (e *LockedError) Error() string {
    34  	return fmt.Sprintf("key is locked, key: %q, primary: %q, startVer: %v",
    35  		e.Key, e.Primary, e.StartVer)
    36  }