Active-GO/core/errs/unwrapper.go

// =============================================================================
//  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

// Unwrapper is an interface that defines the method Unwrap.
// The Unwrap method should return the underlying error that is wrapped by the type implementing this interface.
type Unwrapper interface {
	Unwrap() error
}

// UnwrapperFnc is a function type that implements the Unwrapper interface.
// It is a function that returns an error when called.
type UnwrapperFnc func() error

// Unwrap implements the Unwrapper interface for the UnwrapperFnc type.
// It invokes the function f and returns the error that the function returns.
func (f UnwrapperFnc) Unwrap() error {
	return f() // Call the function and return its error result.
}