The highest tagged major version is
README
¶
go-xdg
Package xdg provides support for the XDG Base Directory
Specification.
License
The MIT License (MIT)
Copyright (c) 2018 Tom Payne
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Documentation
¶
Overview ¶
Package xdg provides support for the XDG Base Directory Specification. See https://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type XDG ¶
type XDG struct {
ConfigHome string
ConfigDirs []string
DataHome string
DataDirs []string
CacheHome string
RuntimeDir string
}
An XDG represents an XDG configuration.
func NewXDG ¶
NewXDG returns a new XDG, configured from the user's environment variables according to the XDG specification.
func (*XDG) OpenConfigFile ¶
func (x *XDG) OpenConfigFile(open func(string) (*os.File, error), nameComponents ...string) (*os.File, string, error)
OpenConfigFile opens the first configuration file with the given name found, its full path, and any error. If no file can be found, the error will be os.ErrNotExist.
The file is opened with the open argument. If open is nil, os.Open is used.
func (*XDG) OpenDataFile ¶
func (x *XDG) OpenDataFile(open func(string) (*os.File, error), nameComponents ...string) (*os.File, string, error)
OpenDataFile opens the first data file with the given name found, its full path, and any error. If no file can be found, the error will be os.ErrNotExist.
The file is opened with the open argument. If open is nil, os.Open is used.
Source Files