github.com/uber/kraken@v0.1.4/lib/store/base/errors.go (about)

     1  // Copyright (c) 2016-2019 Uber Technologies, Inc.
     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  package base
    15  
    16  import "fmt"
    17  
    18  // FileStateError represents errors related to file state.
    19  // It's used when a file is not in the state it was supposed to be in.
    20  type FileStateError struct {
    21  	Op    string
    22  	Name  string
    23  	State FileState
    24  	Msg   string
    25  }
    26  
    27  func (e *FileStateError) Error() string {
    28  	return fmt.Sprintf("failed to perform \"%s\" on %s/%s: %s",
    29  		e.Op, e.State.GetDirectory(), e.Name, e.Msg)
    30  }
    31  
    32  // IsFileStateError returns true if the param is of FileStateError type.
    33  func IsFileStateError(err error) bool {
    34  	_, ok := err.(*FileStateError)
    35  	return ok
    36  }