README
¶
paths
paths provides centralized filesystem path helpers and constants for the application's directory structure.
Types
| Type | Description |
|---|---|
FileSystemPath |
Wraps a path string with String() and Is() methods |
Functions
| Function | Description |
|---|---|
Application() FileSystemPath |
Current working directory (application root) |
Data() FileSystemPath |
Path to the data/ directory |
Config() FileSystemPath |
Path to the config directory |
Defaults() FileSystemPath |
Path to the defaults directory |
Database() FileSystemPath |
Path to the database directory |
Logs() FileSystemPath |
Path to the logs directory |
Backups() FileSystemPath |
Path to the backups directory |
Dumps() FileSystemPath |
Path to the dumps directory |
Res() FileSystemPath |
Path to the resources directory |
Images() FileSystemPath |
Path to image resources |
HTML() FileSystemPath |
Path to HTML templates |
HTMLTemplates() FileSystemPath |
Path to HTML templates (alias) |
HTMLPage(name string) string |
Full path to a named HTML page |
HTMLTemplate() string |
Path to the main templates file |
Seperator() string |
OS path separator |
Example
import "github.com/mt1976/frantic-core/paths"
func main() {
fmt.Println("App root:", paths.Application().String())
fmt.Println("Config:", paths.Config().String())
fmt.Println("Database:", paths.Database().String())
fmt.Println("Logs:", paths.Logs().String())
}
Documentation
¶
Overview ¶
Package paths centralizes filesystem path helpers and constants.
Index ¶
- func HTMLPage(in string) string
- func HTMLTemplate() string
- func Seperator() string
- type FileSystemPath
- func Application() FileSystemPath
- func Backups() FileSystemPath
- func Config() FileSystemPath
- func Data() FileSystemPath
- func Database() FileSystemPath
- func Defaults() FileSystemPath
- func Dumps() FileSystemPath
- func HTML() FileSystemPath
- func HTMLTemplates() FileSystemPath
- func Images() FileSystemPath
- func Logs() FileSystemPath
- func Res() FileSystemPath
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func HTMLTemplate ¶
func HTMLTemplate() string
Types ¶
type FileSystemPath ¶
type FileSystemPath struct {
// contains filtered or unexported fields
}
func Application ¶
func Application() FileSystemPath
func Backups ¶
func Backups() FileSystemPath
func Config ¶
func Config() FileSystemPath
func Data ¶
func Data() FileSystemPath
func Database ¶
func Database() FileSystemPath
func Defaults ¶
func Defaults() FileSystemPath
func Dumps ¶
func Dumps() FileSystemPath
func HTML ¶
func HTML() FileSystemPath
func HTMLTemplates ¶
func HTMLTemplates() FileSystemPath
func Images ¶
func Images() FileSystemPath
func Logs ¶
func Logs() FileSystemPath
func Res ¶
func Res() FileSystemPath
func (*FileSystemPath) Is ¶
func (F *FileSystemPath) Is(in FileSystemPath) bool
func (FileSystemPath) String ¶
func (f FileSystemPath) String() string
Source Files
Click to show internal directories.
Click to hide internal directories.