File: filetype.go

package info (click to toggle)
golang-gopkg-h2non-filetype.v1 1.1.3%2Bds1-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 208 kB
  • sloc: makefile: 4
file content (102 lines) | stat: -rw-r--r-- 2,260 bytes parent folder | download
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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
package filetype

import (
	"errors"

	"github.com/h2non/filetype/matchers"
	"github.com/h2non/filetype/types"
)

// Types stores a map of supported types
var Types = types.Types

// NewType creates and registers a new type
var NewType = types.NewType

// Unknown represents an unknown file type
var Unknown = types.Unknown

// ErrEmptyBuffer represents an empty buffer error
var ErrEmptyBuffer = errors.New("Empty buffer")

// ErrUnknownBuffer represents a unknown buffer error
var ErrUnknownBuffer = errors.New("Unknown buffer type")

// AddType registers a new file type
func AddType(ext, mime string) types.Type {
	return types.NewType(ext, mime)
}

// Is checks if a given buffer matches with the given file type extension
func Is(buf []byte, ext string) bool {
	kind := types.Get(ext)
	if kind != types.Unknown {
		return IsType(buf, kind)
	}
	return false
}

// IsExtension semantic alias to Is()
func IsExtension(buf []byte, ext string) bool {
	return Is(buf, ext)
}

// IsType checks if a given buffer matches with the given file type
func IsType(buf []byte, kind types.Type) bool {
	matcher := matchers.Matchers[kind]
	if matcher == nil {
		return false
	}
	return matcher(buf) != types.Unknown
}

// IsMIME checks if a given buffer matches with the given MIME type
func IsMIME(buf []byte, mime string) bool {
	result := false
	types.Types.Range(func(k, v interface{}) bool {
		kind := v.(types.Type)
		if kind.MIME.Value == mime {
			matcher := matchers.Matchers[kind]
			result = matcher(buf) != types.Unknown
			return false
		}
		return true
	})

	return result
}

// IsSupported checks if a given file extension is supported
func IsSupported(ext string) bool {
	result := false
	types.Types.Range(func(k, v interface{}) bool {
		key := k.(string)
		if key == ext {
			result = true
			return false
		}
		return true
	})

	return result
}

// IsMIMESupported checks if a given MIME type is supported
func IsMIMESupported(mime string) bool {
	result := false
	types.Types.Range(func(k, v interface{}) bool {
		kind := v.(types.Type)
		if kind.MIME.Value == mime {
			result = true
			return false
		}
		return true
	})

	return result
}

// GetType retrieves a Type by file extension
func GetType(ext string) types.Type {
	return types.Get(ext)
}