aboutsummaryrefslogtreecommitdiffstats
path: root/vendor/github.com/mholt/archiver/v3/error.go
blob: a46235c65220993972baf211fe00b3da629a15a1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
package archiver

import (
	"fmt"
	"strings"
)

// IllegalPathError is an error returned when an illegal
// path is detected during the archival process.
//
// By default, only the Filename is showed on error, but you might
// also get the absolute value of the invalid path on the AbsolutePath
// field.
type IllegalPathError struct {
	AbsolutePath string
	Filename     string
}

func (err *IllegalPathError) Error() string {
	return fmt.Sprintf("illegal file path: %s", err.Filename)
}

// IsIllegalPathError returns true if the provided error is of
// the type IllegalPathError.
func IsIllegalPathError(err error) bool {
	return err != nil && strings.Contains(err.Error(), "illegal file path: ")
}