xdgleam

Types

BaseDirectory

pub type BaseDirectory {
  BaseDirectory(
    data_home: String,
    config_home: String,
    cache_home: String,
    state_home: String,
    data_dirs: List(String),
    config_dirs: List(String),
    runtime_dir: option.Option(String),
  )
}

Constructors

BaseDirectory(
  data_home: String,
  config_home: String,
  cache_home: String,
  state_home: String,
  data_dirs: List(String),
  config_dirs: List(String),
  runtime_dir: option.Option(String),
)

Error

</>

pub type Error {
  Error(kind: ErrorKind)
}

Constructors

```
Error(kind: ErrorKind)
```

ErrorKind

</>

pub type ErrorKind {
  AnyError
}

Constructors

```
AnyError
```

Values

config_dirs

</>

pub fn config_dirs() -> Result(List(String), Nil)

data_dirs

</>

pub fn data_dirs() -> Result(List(String), Nil)

Reads $XDG_CONFIG_DIRS

home

</>

pub fn home() -> Result(String, Nil)

Reads $HOME

new

</>

pub fn new() -> BaseDirectory

Deprecated: Use xdgleam/xdg instead

read_config_dirs

</>

pub fn read_config_dirs() -> Result(List(String), Nil)

Deprecated: Use xdgleam/config_dirs instead

Reads $XDG_CONFIG_DIRS

read_data_dirs

</>

pub fn read_data_dirs() -> Result(List(String), Nil)

Deprecated: Use xdgleam/data_dirs instead

Reads $XDG_CONFIG_DIRS

read_home

</>

pub fn read_home() -> Result(String, Nil)

Deprecated: Use xdgleam/home instead

Reads $HOME

read_runtime_dirs

</>

pub fn read_runtime_dirs() -> Result(option.Option(String), Nil)

Deprecated: Use xdgleam/runtime_dirs instead

Reads $XDG_RUNTIME_DIR

runtime_dirs

</>

pub fn runtime_dirs() -> Result(option.Option(String), Nil)

Reads $XDG_RUNTIME_DIR

xdg

</>

pub fn xdg() -> BaseDirectory