dirs

README

dirs

Introduction

• a tiny low-level library with a minimal API
• that provides the platform-specific, user-accessible locations
• for retrieving and storing configuration, cache and other data
• on Linux, Windows, macOS and other platforms.

The library provides the location of these directories by leveraging the mechanisms defined by

• the XDG base directory and the XDG user directory specifications on Linux
• the Known Folder API on Windows
• the Standard Directories guidelines on macOS

Platforms

This library is written in Go, and supports Linux, macOS and Windows. Other platforms are also supported; they use the XDG conventions.

It's mid-level sister library, directories, is available for Rust (directories-rs) and on the JVM (directories-jvm).

License

Licensed under Apache License 2.0.

Documentation

Overview

Copyright 2022 Rishvic Pushpakaran

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2022-2023 Rishvic Pushpakaran

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Variables
• func AudioDir() (string, error)
• func CacheDir() (string, error)
• func ConfigDir() (string, error)
• func DataDir() (string, error)
• func DataLocalDir() (string, error)
• func DesktopDir() (string, error)
• func DocumentDir() (string, error)
• func DownloadDir() (string, error)
• func ExecutableDir() (string, error)
• func FontDir() (string, error)
• func HomeDir() (string, error)
• func PictureDir() (string, error)
• func PreferenceDir() (string, error)
• func PublicDir() (string, error)
• func RuntimeDir() (string, error)
• func StateDir() (string, error)
• func TemplateDir() (string, error)
• func VideoDir() (string, error)
• type Cache
  • func NewCache(f func() (string, error)) *Cache
  • func (c *Cache) Cur() (string, error)
  • func (c *Cache) Reset()

Variables

var ErrNotFound = errors.New("directory not found")

Functions

func AudioDir

func AudioDir() (string, error)

func CacheDir

func CacheDir() (string, error)

func ConfigDir

func ConfigDir() (string, error)

func DataDir

func DataDir() (string, error)

func DataLocalDir

func DataLocalDir() (string, error)

func DesktopDir

func DesktopDir() (string, error)

func DocumentDir

func DocumentDir() (string, error)

func DownloadDir

func DownloadDir() (string, error)

func ExecutableDir

func ExecutableDir() (string, error)

func FontDir

func FontDir() (string, error)

func HomeDir

func HomeDir() (string, error)

func PictureDir

func PictureDir() (string, error)

func PreferenceDir

func PreferenceDir() (string, error)

func PublicDir

func PublicDir() (string, error)

func RuntimeDir

func RuntimeDir() (string, error)

func StateDir

func StateDir() (string, error)

func TemplateDir

func TemplateDir() (string, error)

func VideoDir

func VideoDir() (string, error)

Types

type Cache

type Cache struct {
	// contains filtered or unexported fields
}

func NewCache

func NewCache(f func() (string, error)) *Cache

func (*Cache) Cur

func (c *Cache) Cur() (string, error)

func (*Cache) Reset

func (c *Cache) Reset()