active3/core/errs/err_param.go

// ------------------------------------------------------------------------
//   Project active2
//   Active Thing (activething.com) git.activething.com/go
//
//   File name  err_param.go
//   Created by DEV
//   Modified   04/04/2024
//
//   Copyright 2024 activething.com 
// ------------------------------------------------------------------------
// 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.
// ------------------------------------------------------------------------

package errs

import (
	"errs/erinfo"
	"errs/erstfy"
	"fmt"
)

type (

	ErrParam 	struct {
		code 	string
		param 	string
		message string
	}
)


func NewErrParam (param string, msgf string, params ...any) *ErrParam {
	return &ErrParam {
		code   : CodeParamError,
		param  : param,
		message: fmt.Sprintf(msgf,params...) }}


func NewErrNilParam (param string, msgf string, params ...any) *ErrParam {
	return &ErrParam {
		code 	: CodeParamNilError,
		param 	: param,
		message : fmt.Sprintf(msgf,params...) }}



func (e ErrParam) Code () string {
	return e.code }

func (e ErrParam) Error() string {
	return e.code }

func (e ErrParam) Message () string {
	return e.message }

func (e ErrParam) Param () string {
	return e.param }



func (e ErrParam) String () string {
	return e.Stringify(false) }

func (e ErrParam) Stringify (_ bool) string {
	if len(e.message) > 0 {
		return erstfy.DefaultStringer().LabelLine("param", e.param)
	}
	return erstfy.DefaultStringer().BuildLines(
		erstfy.DefaultStringer().LabelLine("param", e.param),
		erstfy.DefaultStringer().LabelLine("message", e.message))
}

func (e ErrParam) Collect (c erinfo.Collector) {
	c.AddFieldString("message",e.message)
	c.AddFieldString("param",e.param)
}