paths

Documentation

Index

• func AddDirectory(dirNames string) error
• func DefaultDownloadPath() string
• func DirExistsAndMkdirAll(afe afero.Afero, path string) error
• func GetDatabasePath() string
• func GetLogPath() string
• func GetRootPath() string
• func GetSlicePath() string
• func InitializePaths(opts *PathOptions) error
• func IsGorunEnv() bool
• func ObtainRootPath() string
• type PathConfig
• type PathOptions
  • func NewPathOptions(rootPath, downloadPath string) *PathOptions

Functions

func AddDirectory

func AddDirectory(dirNames string) error

AddDirectory 动态添加新目录 参数:

• dirNames: string 要创建的目录路径

返回值：

• error: 如果目录创建失败，返回错误信息

func DefaultDownloadPath

func DefaultDownloadPath() string

DefaultDownloadPath 返回操作系统的默认下载路径。 返回值：

• string: 默认下载路径

func DirExistsAndMkdirAll

func DirExistsAndMkdirAll(afe afero.Afero, path string) error

DirExistsAndMkdirAll 检查路径是否存在并且是一个目录，如果不存在则创建目录路径和所有尚不存在的父级。 参数:

• afe: afero.Afero 文件系统接口
• path: string 要检查和创建的目录路径

返回值:

• error 如果出现错误，返回相应的错误信息

func GetDatabasePath

func GetDatabasePath() string

GetDatabasePath 返回数据库路径 返回值：

• string: 数据库路径

func GetLogPath

func GetLogPath() string

GetLogPath 返回日志路径 返回值：

• string: 日志路径

func GetRootPath

func GetRootPath() string

GetRootPath 返回根目录路径 返回值：

• string: 根目录路径

func GetSlicePath

func GetSlicePath() string

GetSlicePath 返回切片路径 返回值：

• string: 切片路径

func InitializePaths

func InitializePaths(opts *PathOptions) error

InitializePaths 初始化所有必要的路径 参数：

• opts: 可选的路径配置，可以为 nil

返回值：

• error: 初始化过程中的错误，如果没有错误则为 nil

func IsGorunEnv

func IsGorunEnv() bool

IsGorunEnv 判断是否为go run运行环境 返回值：

• bool: 是否为go run环境

func ObtainRootPath

func ObtainRootPath() string

ObtainRootPath 获取根目录路径 返回值：

• string: 根目录路径

Types

type PathConfig

type PathConfig struct {
	RootPath     string // 根路径
	DatabasePath string // 数据库路径
	//UploadPath   string // 上传路径
	//DownloadPath string // 下载路径
	SlicePath string // 切片路径
	LogPath   string // 日志路径

}

PathConfig 存储所有相关路径

var (
	Config PathConfig // Config 是全局路径配置实例

)

全局变量来存储根路径

type PathOptions

type PathOptions struct {
	RootPath     string // 根路径
	DownloadPath string // 下载路径
}

PathOptions 定义可选的路径配置

func NewPathOptions

func NewPathOptions(rootPath, downloadPath string) *PathOptions

NewPathOptions 创建一个新的 PathOptions 实例 参数:

• rootPath: 根路径
• downloadPath: 下载路径

返回值:

• *PathOptions: 新创建的 PathOptions 实例