You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
81 lines
3.0 KiB
81 lines
3.0 KiB
// =============================================================================
|
|
// Active-GO Framework
|
|
// Copyright (c) 2024 ActiveThing (https://activething.com)
|
|
// Author: Juan V. Navarro juanvnl@activething.com
|
|
// =============================================================================
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
// of this software and associated documentation files (the "Software"), to deal
|
|
// in the Software without restriction, including without limitation the rights
|
|
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
// copies of the Software, and to permit persons to whom the Software is
|
|
// furnished to do so, subject to the following conditions:
|
|
//
|
|
// The above copyright notice and this permission notice shall be included in
|
|
// all copies or substantial portions of the Software.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
// THE SOFTWARE.
|
|
//
|
|
// =============================================================================
|
|
|
|
package errs
|
|
|
|
// ErrPanic is a custom error type that represents a specific error case involving a panic.
|
|
//
|
|
// Fields:
|
|
// - cause: The underlying error that triggered the panic, if any.
|
|
type ErrPanic struct {
|
|
cause error
|
|
}
|
|
|
|
// NewErrPanic creates a new instance of ErrPanic.
|
|
//
|
|
// Parameters:
|
|
// - cause: The underlying error that caused the panic.
|
|
//
|
|
// Returns:
|
|
// - A pointer to the newly created ErrPanic instance.
|
|
func NewErrPanic(cause error) *ErrPanic {
|
|
return &ErrPanic{cause: cause}
|
|
}
|
|
|
|
// Error returns a string representation of the ErrPanic error.
|
|
// This is the implementation of the error interface.
|
|
//
|
|
// Returns:
|
|
// - A constant string (CodePanicError) representing the error message.
|
|
func (e ErrPanic) Error() string {
|
|
return CodePanicError // Note: Ensure CodePanicError is defined elsewhere.
|
|
}
|
|
|
|
// Unwrap provides access to the underlying error (if any) in the ErrPanic instance.
|
|
//
|
|
// Returns:
|
|
// - The underlying error that caused the panic, or nil if there is no cause.
|
|
// Note: Currently, this implementation always returns nil.
|
|
func (e ErrPanic) Unwrap() error {
|
|
return nil // Consider returning e.cause for compatibility with errors.Unwrap.
|
|
}
|
|
|
|
// Cause retrieves the underlying cause of the ErrPanic error.
|
|
//
|
|
// Returns:
|
|
// - The underlying error that caused the panic.
|
|
func (e ErrPanic) Cause() error {
|
|
return e.cause
|
|
}
|
|
|
|
// With wraps the ErrPanic instance into an ErrWith structure for additional context.
|
|
//
|
|
// Returns:
|
|
// - An ErrWith instance containing the ErrPanic error.
|
|
func (e ErrPanic) With() ErrWith {
|
|
return MakeErrWith(e)
|
|
}
|