资源类

package
v0.0.0-...-babeac7 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 12, 2024 License: MIT Imports: 22 Imported by: 0

Documentation

Overview

包gres提供了文件和字节之间资源管理及打包/解包的功能。 md5:29e79f40a11fe941

Index

Constants

View Source 
const (
	// 目录分隔符。 md5:a4832545f002edfe
	X常量_目录分隔符 = "/"
)
View Source 
const (
	// X常量_默认分组名称 实例使用的默认分组名称。 md5:451d9ed0f5a0a185
	X常量_默认分组名称 = "default"
)

Variables

This section is empty.

Functions

func Add 

func Add(content string, prefix ...string) error

Add 方法将 'content' 解包并添加到默认资源对象中。 不需要的参数 'prefix' 表示存储在当前资源对象中的每个文件的前缀。 md5:3b5da05501708d4d

func Contains 

func Contains(path string) bool

Contains 检查默认资源对象中是否存在 `path`。 md5:f69f9f792a33a089

func Dump 

func Dump()

Dump 打印默认资源对象的文件。 md5:fc090361befff87e

func Export 

func Export(src, dst string, option ...X结构_ExportOption) error

Export 将指定的路径 `src` 及其所有子文件递归导出并保存到指定的系统路径 `dst`。 md5:944ad6e86342817b

func GetContent 

func GetContent(path string) []byte

GetContent 直接返回默认资源对象中 `path` 的内容。 md5:6446043ef668020c

func IsEmpty 

func IsEmpty() bool

IsEmpty 检查资源管理器是否为空，并返回结果。 md5:3aaae27781ad4e8c

func Load 

func Load(path string, prefix ...string) error

Load 从 `path` 加载、解包并将数据添加到默认资源对象中。 不必要的参数 `prefix` 表示存储到当前资源对象中的每个文件的前缀。 md5:901d4f7e4d8bf0cf

func Pack 

func Pack(srcPaths string, keyPrefix ...string) ([]byte, error)

Pack 将由 `srcPaths` 指定的路径打包成字节。不必要的参数 `keyPrefix` 表示每个文件打包到结果字节中的前缀。

注意，参数 `srcPaths` 支持用逗号分隔多个路径。

警告：请使用 PackWithOption 替代此方法。 md5:bba941587b4a7962

func PackToFileWithOption 

func PackToFileWithOption(srcPaths, dstPath string, option X结构_选项) error

PackToFileWithOption 将由 `srcPaths` 指定的路径打包到目标文件 `dstPath` 中。

注意，参数 `srcPaths` 支持使用逗号分隔多个路径。 md5:5daf8e107f124634

func PackToGoFile 

func PackToGoFile(srcPath, goFilePath, pkgName string, keyPrefix ...string) error

PackToGoFile 将由 `srcPaths` 指定的路径打包成目标 Go 文件 `goFilePath`，并使用给定的包名 `pkgName`。

参数 `keyPrefix`（可选）表示打包到结果字节中的每个文件的前缀。

注意，`srcPaths` 参数支持用逗号分隔多个路径。

警告：请改用 PackToGoFileWithOption。 md5:99701ca10a176f76

func PackToGoFileWithOption 

func PackToGoFileWithOption(srcPath, goFilePath, pkgName string, option X结构_选项) error

PackToGoFileWithOption 将由 `srcPaths` 指定的路径打包到目标Go文件 `goFilePath` 中， 使用给定的包名 `pkgName`。

注意，参数 `srcPaths` 支持使用逗号`,`连接多个路径。 md5:0e7ba248d1ba0543

func PackWithOption 

func PackWithOption(srcPaths string, option X结构_选项) ([]byte, error)

PackWithOption 将由 `srcPaths` 指定的路径打包成字节。

注意，参数 `srcPaths` 支持使用逗号分隔多个路径。 md5:15ee3362e7cd91a0

func X弃用_PackToFile 

func X弃用_PackToFile(srcPaths, dstPath string, keyPrefix ...string) error

X弃用_PackToFile 将`srcPaths`指定的路径打包到目标文件`dstPath`中。 不必要的参数`keyPrefix`表示打包到结果字节中的每个文件的前缀。

注意，参数`srcPaths`支持使用','连接的多个路径。

已弃用：请改用PackToFileWithOption。 md5:222d6d9ef38edd09

Types

type X结构_ExportOption 

type X结构_ExportOption struct {
	RemovePrefix string // 从资源中移除文件名的前缀。 md5:ff1e0af55baecf64
}

X结构_ExportOption 是 Export 函数的选项。 md5:12a5d99e83d743f7

type X结构_Resource 

type X结构_Resource struct {
	// contains filtered or unexported fields
}

func Instance 

func Instance(name ...string) *X结构_Resource

Instance 返回一个 Resource 的实例。 参数 `name` 是该实例的名称。 md5:7525989539de5240

func New 

func New() *X结构_Resource

New 创建并返回一个新的资源对象。 md5:8c594601bad2dd64

func (*X结构_Resource) Add 

func (r *X结构_Resource) Add(content string, prefix ...string) error

Add 解包并把`content`添加到当前资源对象中。不必要的参数`prefix`表示每个文件存储在当前资源对象中的前缀。 md5:93345d9770c1e7fa

func (*X结构_Resource) Contains 

func (r *X结构_Resource) Contains(path string) bool

Contains 检查路径 `path` 是否存在于当前资源对象中。 md5:9beb2e9c06e1e221

func (*X结构_Resource) Dump 

func (r *X结构_Resource) Dump()

Dump 打印当前资源对象的文件。 md5:4533063269cc5df2

func (*X结构_Resource) Export 

func (r *X结构_Resource) Export(src, dst string, option ...X结构_ExportOption) error

Export 将指定的路径 `srcPath` 及其所有子文件递归导出并保存到指定的系统路径 `dstPath`。 md5:271f4d0f27211419

func (*X结构_Resource) Get 

func (r *X结构_Resource) Get(path string) *X结构_文件

Get返回给定路径的文件。 md5:f4989a4832cde2d2

func (*X结构_Resource) GetContent 

func (r *X结构_Resource) GetContent(path string) []byte

GetContent 直接返回 `path` 的内容。 md5:50cf0f721b7b89a5

func (*X结构_Resource) GetWithIndex 

func (r *X结构_Resource) GetWithIndex(path string, indexFiles []string) *X结构_文件

GetWithIndex 在给定路径`path`下搜索文件。如果找到的是一个目录，它会在这个目录下索引文件进行搜索。

GetWithIndex 通常用于HTTP静态文件服务中。 md5:bfb61cc8920b4633

func (*X结构_Resource) IsEmpty 

func (r *X结构_Resource) IsEmpty() bool

IsEmpty 检查资源管理器是否为空，并返回结果。 md5:3aaae27781ad4e8c

func (*X结构_Resource) Load 

func (r *X结构_Resource) Load(path string, prefix ...string) error

Load 从`path`加载、解包并将数据添加到当前资源对象中。不必要的参数`prefix`表示将每个文件存储到当前资源对象中的前缀。 md5:ab3e52fa479e7de6

func (*X结构_Resource) ScanDir 

func (r *X结构_Resource) ScanDir(path string, pattern string, recursive ...bool) []*X结构_文件

ScanDir 在给定路径下返回文件，参数 `path` 应该是一个文件夹类型。

`pattern` 参数支持多个文件名模式，使用逗号 `,` 来分隔多个模式。

如果 `recursive` 参数为 true，它会递归扫描目录。

注意，返回的文件不包含给定的 `path`。 md5:c7e8c1023db3f55f

func (*X结构_Resource) ScanDirFile 

func (r *X结构_Resource) ScanDirFile(path string, pattern string, recursive ...bool) []*X结构_文件

ScanDirFile 返回给定`path`下的所有子文件的绝对路径， 如果给定的参数`recursive`为true，它会递归地扫描目录。

注意，它只返回文件，不包括目录。 md5:0f3154c32271652b

type X结构_文件 

type X结构_文件 struct {
	// contains filtered or unexported fields
}

func Get 

func Get(path string) *X结构_文件

Get返回给定路径的文件。 md5:f4989a4832cde2d2

func GetWithIndex 

func GetWithIndex(path string, indexFiles []string) *X结构_文件

GetWithIndex 在给定路径`path`下搜索文件。如果找到的是一个目录，它会在这个目录下索引文件进行搜索。

GetWithIndex 通常用于HTTP静态文件服务中。 md5:bfb61cc8920b4633

func ScanDir 

func ScanDir(path string, pattern string, recursive ...bool) []*X结构_文件

ScanDir 在给定路径下返回文件，参数 `path` 应该是一个文件夹类型。

`pattern` 参数支持多个文件名模式，使用逗号 `,` 来分隔多个模式。

如果 `recursive` 参数为真，它会递归扫描目录。 md5:4726ded4e00ca75f

func ScanDirFile 

func ScanDirFile(path string, pattern string, recursive ...bool) []*X结构_文件

ScanDirFile 返回给定`path`下的所有子文件的绝对路径， 如果给定的参数`recursive`为true，它会递归地扫描目录。

注意，它只返回文件，不包括目录。 md5:0f3154c32271652b

func Unpack 

func Unpack(path string) ([]*X结构_文件, error)

Unpack 将由 `path` 指定的内容解压缩到 []*File 中。 md5:c88b5e566f58802e

func UnpackContent 

func UnpackContent(content string) ([]*X结构_文件, error)

UnpackContent 将内容解包为 []*File。 md5:a49a123f27175e6d

func (*X结构_文件) Close 

func (f *X结构_文件) Close() error

Close 实现了 http.File 接口。 md5:ed68e1aedf92d678

func (*X结构_文件) Content 

func (f *X结构_文件) Content() []byte

Content 返回文件的内容。 md5:66d562dea01e0ea1

func (*X结构_文件) Export 

func (f *X结构_文件) Export(dst string, option ...X结构_ExportOption) error

Export 将所有子文件递归地导出并保存到指定的系统路径 `dst`。 md5:e85b8976b49230e6

func (*X结构_文件) FileInfo 

func (f *X结构_文件) FileInfo() os.FileInfo

FileInfo 返回一个表示FileHeader的os.FileInfo。 md5:da797c4560c42771

func (X结构_文件) MarshalJSON 

func (f X结构_文件) MarshalJSON() ([]byte, error)

MarshalJSON 实现了接口 MarshalJSON 以供 json.Marshal 使用。 md5:43c3b36e60a18f9a

func (*X结构_文件) Name 

func (f *X结构_文件) Name() string

Name返回文件的名称。 md5:a3ea90169ca420db

func (*X结构_文件) Open 

func (f *X结构_文件) Open() (io.ReadCloser, error)

Open 返回一个 ReadCloser，可以用来访问文件的内容。多个文件可以并发读取。 md5:884ff7d72298ecd8

func (*X结构_文件) Read 

func (f *X结构_文件) Read(b []byte) (n int, err error)

Read implements the io.Reader接口。 md5:ef2823b98664212a

func (*X结构_文件) Readdir 

func (f *X结构_文件) Readdir(count int) ([]os.FileInfo, error)

Readdir 实现了 http.File 接口的 Readdir 方法。 md5:d47ea30bb07047c4

func (*X结构_文件) Seek 

func (f *X结构_文件) Seek(offset int64, whence int) (n int64, err error)

Seek 实现了 io.Seeker 接口。 md5:891a8f7e89e80191

func (*X结构_文件) Stat 

func (f *X结构_文件) Stat() (os.FileInfo, error)

Stat 实现了 http.File 接口中的 Stat 方法。 md5:f25fb28810e2d18b

type X结构_选项 

type X结构_选项 struct {
	Prefix   string // 在资源管理器中每个文件项的文件路径前缀。 md5:54cf09b52af7353f
	KeepPath bool   // 在打包时保留传递的路径，通常用于相对路径。 md5:78a556a27d461bea
}

X结构_选项包含Pack函数的额外选项。 md5:1aecf45a2bd621ac

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.