Copyright (c) 2015, Dave Cheney <[email protected]>
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this
  list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Licensing

CoreStore is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.

Copyright 2015-2017, Cyrill @ Schumacher.fm and the CoreStore contributors

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

     http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

# Functions

As finds the first error in err's chain that matches target, and if so, sets target to that error value and returns true.

Attach

Attach adds Kind `k` to an error but only if the error has been created with this package.

Cause

Cause returns the underlying cause of the error, if possible.

CausedBehaviour

CausedBehaviour returns the first underlying caused kind/behaviour of the error, if possible.

Detach

Detach opposite of Attach.

Errorf

Errorf formats according to a format specifier and returns the string as a value that satisfies error.

Is reports whether any error in err's chain matches target.

MarshalAppend

MarshalAppend marshals an arbitrary error into a byte slice.

MatchAllKind

MatchAllKind checks if all Kinds are included in `err`.

MatchAnyKind

MatchAnyKind checks if at least one Kind is included in `err`.

MatchKind

MatchKind returns true if `err` is of Kind `k`.

New

New returns an error with the supplied message.

Unmarshal

Unmarshal unmarshals the byte slice into an error value.

UnwrapKind

UnwrapKind extract the Kind of an error.

UnwrapKinds

UnwrapKinds checks if error has a Kind/behaviour and returns a slice with all found Kinds.

UnwrapStack

UnwrapStack tries to extract the previous stack trace after unmarshalling a byte slice into an error.

WithMessage

WithMessage annotates err with a new message.

WithMessagef

WithMessagef annotates err with the format specifier.

WithStack

WithStack annotates err with a stack trace at the point WithStack was called.

Wrap

Wrap returns an error annotating err with a stack trace at the point Wrap is called, and the supplied message.

Wrapf

Wrapf returns an error annotating err with a stack trace at the point Wrapf is called, and the format specifier.