Documentation
¶
Overview ¶
包gres提供了文件和字节之间资源管理及打包/解包的功能。 md5:29e79f40a11fe941
Index ¶
- Constants
- func Add(content string, prefix ...string) error
- func Contains(path string) bool
- func Dump()
- func Export(src, dst string, option ...ExportOption) error
- func GetContent(path string) []byte
- func IsEmpty() bool
- func Load(path string, prefix ...string) error
- func Pack(srcPaths string, keyPrefix ...string) ([]byte, error)
- func PackToFile(srcPaths, dstPath string, keyPrefix ...string) error
- func PackToFileWithOption(srcPaths, dstPath string, option Option) error
- func PackToGoFile(srcPath, goFilePath, pkgName string, keyPrefix ...string) error
- func PackToGoFileWithOption(srcPath, goFilePath, pkgName string, option Option) error
- func PackWithOption(srcPaths string, option Option) ([]byte, error)
- type ExportOption
- type File
- func Get(path string) *File
- func GetWithIndex(path string, indexFiles []string) *File
- func ScanDir(path string, pattern string, recursive ...bool) []*File
- func ScanDirFile(path string, pattern string, recursive ...bool) []*File
- func Unpack(path string) ([]*File, error)
- func UnpackContent(content string) ([]*File, error)
- func (f *File) Close() error
- func (f *File) Content() []byte
- func (f *File) Export(dst string, option ...ExportOption) error
- func (f *File) FileInfo() os.FileInfo
- func (f File) MarshalJSON() ([]byte, error)
- func (f *File) Name() string
- func (f *File) Open() (io.ReadCloser, error)
- func (f *File) Read(b []byte) (n int, err error)
- func (f *File) Readdir(count int) ([]os.FileInfo, error)
- func (f *File) Seek(offset int64, whence int) (n int64, err error)
- func (f *File) Stat() (os.FileInfo, error)
- type Option
- type Resource
- func (r *Resource) Add(content string, prefix ...string) error
- func (r *Resource) Contains(path string) bool
- func (r *Resource) Dump()
- func (r *Resource) Export(src, dst string, option ...ExportOption) error
- func (r *Resource) Get(path string) *File
- func (r *Resource) GetContent(path string) []byte
- func (r *Resource) GetWithIndex(path string, indexFiles []string) *File
- func (r *Resource) IsEmpty() bool
- func (r *Resource) Load(path string, prefix ...string) error
- func (r *Resource) ScanDir(path string, pattern string, recursive ...bool) []*File
- func (r *Resource) ScanDirFile(path string, pattern string, recursive ...bool) []*File
Constants ¶
const (
// DefaultName 实例使用的默认分组名称。 md5:451d9ed0f5a0a185
DefaultName = "default"
)
const (
// 目录分隔符。 md5:a4832545f002edfe
Separator = "/"
)
Variables ¶
This section is empty.
Functions ¶
func Add ¶
Add 方法将 'content' 解包并添加到默认资源对象中。 不需要的参数 'prefix' 表示存储在当前资源对象中的每个文件的前缀。 md5:3b5da05501708d4d
func Export ¶
func Export(src, dst string, option ...ExportOption) error
Export 将指定的路径 `src` 及其所有子文件递归导出并保存到指定的系统路径 `dst`。 md5:944ad6e86342817b
func GetContent ¶
GetContent 直接返回默认资源对象中 `path` 的内容。 md5:6446043ef668020c
func Load ¶
Load 从 `path` 加载、解包并将数据添加到默认资源对象中。 不必要的参数 `prefix` 表示存储到当前资源对象中的每个文件的前缀。 md5:901d4f7e4d8bf0cf
func Pack ¶
Pack 将由 `srcPaths` 指定的路径打包成字节。不必要的参数 `keyPrefix` 表示每个文件打包到结果字节中的前缀。
注意，参数 `srcPaths` 支持用逗号分隔多个路径。
警告：请使用 PackWithOption 替代此方法。 md5:bba941587b4a7962
func PackToFile ¶
PackToFile 将`srcPaths`指定的路径打包到目标文件`dstPath`中。 不必要的参数`keyPrefix`表示打包到结果字节中的每个文件的前缀。
注意，参数`srcPaths`支持使用','连接的多个路径。
已弃用：请改用PackToFileWithOption。 md5:222d6d9ef38edd09
func PackToFileWithOption ¶
PackToFileWithOption 将由 `srcPaths` 指定的路径打包到目标文件 `dstPath` 中。
注意，参数 `srcPaths` 支持使用逗号分隔多个路径。 md5:5daf8e107f124634
func PackToGoFile ¶
PackToGoFile 将由 `srcPaths` 指定的路径打包成目标 Go 文件 `goFilePath`，并使用给定的包名 `pkgName`。
参数 `keyPrefix`（可选）表示打包到结果字节中的每个文件的前缀。
注意，`srcPaths` 参数支持用逗号分隔多个路径。
警告：请改用 PackToGoFileWithOption。 md5:99701ca10a176f76
func PackToGoFileWithOption ¶
PackToGoFileWithOption 将由 `srcPaths` 指定的路径打包到目标Go文件 `goFilePath` 中， 使用给定的包名 `pkgName`。
注意，参数 `srcPaths` 支持使用逗号`,`连接多个路径。 md5:0e7ba248d1ba0543
Types ¶
type ExportOption ¶
type ExportOption struct {
RemovePrefix string // 从资源中移除文件名的前缀。 md5:ff1e0af55baecf64
}
ExportOption 是 Export 函数的选项。 md5:12a5d99e83d743f7
type File ¶
type File struct {
// contains filtered or unexported fields
}
func GetWithIndex ¶
GetWithIndex 在给定路径`path`下搜索文件。如果找到的是一个目录，它会在这个目录下索引文件进行搜索。
GetWithIndex 通常用于HTTP静态文件服务中。 md5:bfb61cc8920b4633
func ScanDir ¶
ScanDir 在给定路径下返回文件，参数 `path` 应该是一个文件夹类型。
`pattern` 参数支持多个文件名模式，使用逗号 `,` 来分隔多个模式。
如果 `recursive` 参数为真，它会递归扫描目录。 md5:4726ded4e00ca75f
func ScanDirFile ¶
ScanDirFile 返回给定`path`下的所有子文件的绝对路径， 如果给定的参数`recursive`为true，它会递归地扫描目录。
注意，它只返回文件，不包括目录。 md5:0f3154c32271652b
func UnpackContent ¶
UnpackContent 将内容解包为 []*File。 md5:a49a123f27175e6d
func (*File) Export ¶
func (f *File) Export(dst string, option ...ExportOption) error
Export 将所有子文件递归地导出并保存到指定的系统路径 `dst`。 md5:e85b8976b49230e6
func (File) MarshalJSON ¶
MarshalJSON 实现了接口 MarshalJSON 以供 json.Marshal 使用。 md5:43c3b36e60a18f9a
func (*File) Open ¶
func (f *File) Open() (io.ReadCloser, error)
Open 返回一个 ReadCloser，可以用来访问文件的内容。多个文件可以并发读取。 md5:884ff7d72298ecd8
type Option ¶
type Option struct {
Prefix string // 在资源管理器中每个文件项的文件路径前缀。 md5:54cf09b52af7353f
KeepPath bool // 在打包时保留传递的路径，通常用于相对路径。 md5:78a556a27d461bea
}
Option包含Pack函数的额外选项。 md5:1aecf45a2bd621ac
type Resource ¶
type Resource struct {
// contains filtered or unexported fields
}
func (*Resource) Add ¶
Add 解包并把`content`添加到当前资源对象中。不必要的参数`prefix`表示每个文件存储在当前资源对象中的前缀。 md5:93345d9770c1e7fa
func (*Resource) Export ¶
func (r *Resource) Export(src, dst string, option ...ExportOption) error
Export 将指定的路径 `srcPath` 及其所有子文件递归导出并保存到指定的系统路径 `dstPath`。 md5:271f4d0f27211419
func (*Resource) GetContent ¶
GetContent 直接返回 `path` 的内容。 md5:50cf0f721b7b89a5
func (*Resource) GetWithIndex ¶
GetWithIndex 在给定路径`path`下搜索文件。如果找到的是一个目录，它会在这个目录下索引文件进行搜索。
GetWithIndex 通常用于HTTP静态文件服务中。 md5:bfb61cc8920b4633
func (*Resource) Load ¶
Load 从`path`加载、解包并将数据添加到当前资源对象中。不必要的参数`prefix`表示将每个文件存储到当前资源对象中的前缀。 md5:ab3e52fa479e7de6
Source Files