README
- ::cache_dirBaseDirs::cache_dir
- ::config_dirBaseDirs::config_dir
- ::config_local_dirBaseDirs::config_local_dir
- ::data_dirBaseDirs::data_dir
- ::data_local_dirBaseDirs::data_local_dir
- ::executable_dirBaseDirs::executable_dir
- ::home_dirBaseDirs::home_dir
- ::newBaseDirs::new
- ::preference_dirBaseDirs::preference_dir
- ::runtime_dirBaseDirs::runtime_dir
- ::state_dirBaseDirs::state_dir
T
Platform
- ::cache_dirProjectDirs::cache_dir
- ::config_dirProjectDirs::config_dir
- ::config_local_dirProjectDirs::config_local_dir
- ::data_dirProjectDirs::data_dir
- ::data_local_dirProjectDirs::data_local_dir
- ::fromProjectDirs::from
- ::preference_dirProjectDirs::preference_dir
- ::project_pathProjectDirs::project_path
- ::runtime_dirProjectDirs::runtime_dir
- ::state_dirProjectDirs::state_dir
- ::audio_dirUserDirs::audio_dir
- ::desktop_dirUserDirs::desktop_dir
- ::document_dirUserDirs::document_dir
- ::download_dirUserDirs::download_dir
- ::font_dirUserDirs::font_dir
- ::home_dirUserDirs::home_dir
- ::newUserDirs::new
- ::picture_dirUserDirs::picture_dir
- ::public_dirUserDirs::public_dir
- ::template_dirUserDirs::template_dir
- ::video_dirUserDirs::video_dir
V
is_windows
V
join
V
path_sep
V
platform

directories

Platform-specific config, cache, and data directory paths for MoonBit (XDG on Linux, conventions on macOS/Windows)

directories

xdg

config

cache

paths

moonbit

Download zip

Author

moonrockz

Version

0.1.0

License

Apache-2.0

Repository

github.com/moonrockz/directories

Last updated

7 months ago

Downloads

Dependencies

moonbitlang/x0.4.40

#moonrockz/directories

Platform-specific config, cache, and data directory paths for MoonBit (XDG on Linux, conventions on macOS/Windows). Port of the directories-rs API.

Information only — this library does not create directories or check existence.

#Installation

moon add moonrockz/directories

#Quick Start

// BaseDirs: user-level cache, config, data paths
match @directories.BaseDirs::new() {
  Some(base) => {
    base.home_dir()      // e.g. /home/alice
    base.config_dir()    // e.g. /home/alice/.config
    base.cache_dir()     // e.g. /home/alice/.cache
  }
  None => () // HOME not set
}

// ProjectDirs: app-specific paths
match @directories.ProjectDirs::from("com", "Foo Corp", "Bar App") {
  Some(proj) => {
    proj.config_dir()    // e.g. /home/alice/.config/barapp
    proj.cache_dir()
  }
  None => ()
}

#API

BaseDirs::new() → Option[BaseDirs]: home, cache_dir, config_dir, config_local_dir, data_dir, data_local_dir, preference_dir; optional executable_dir, runtime_dir, state_dir.
UserDirs::new() → Option[UserDirs]: home_dir plus optional audio, desktop, document, download, font, picture, public, template, video dirs.
ProjectDirs::from(qualifier, organization, application) → Option[ProjectDirs]: project-scoped cache, config, data, etc.

v1 resolves paths from environment variables (HOME, XDG_* on Linux). Native platform APIs may be added in a later version.

#Development

Tests run on all supported targets: mise run test:unit (wasm, wasm-gc, js, native). On Linux, the native target requires libbacktrace-dev (e.g. sudo apt install libbacktrace-dev on Ubuntu/Debian).

BaseDirs

source

pub struct BaseDirs {
  home_dir : String
  cache_dir : String
  config_dir : String
  config_local_dir : String
  data_dir : String
  data_local_dir : String
  executable_dir : String?
  preference_dir : String
  runtime_dir : String?
  state_dir : String?
}

BaseDirs: user-invisible standard directories (cache, config, data, etc.). Follows XDG on Linux; v1 uses env vars only.

BaseDirs::cache_dir

source

fn BaseDirs::cache_dir(self : BaseDirs) -> String

BaseDirs::config_dir

source

fn BaseDirs::config_dir(self : BaseDirs) -> String

BaseDirs::config_local_dir

source

fn BaseDirs::config_local_dir(self : BaseDirs) -> String

BaseDirs::data_dir

source

fn BaseDirs::data_dir(self : BaseDirs) -> String

BaseDirs::data_local_dir

source

fn BaseDirs::data_local_dir(self : BaseDirs) -> String

BaseDirs::executable_dir

source

fn BaseDirs::executable_dir(self : BaseDirs) -> String?

BaseDirs::home_dir

source

fn BaseDirs::home_dir(self : BaseDirs) -> String

BaseDirs::new

source

fn BaseDirs::new() -> BaseDirs?

Create BaseDirs from current environment. Returns None if home is not set. On Windows uses LOCALAPPDATA/APPDATA; on Unix uses XDG_* or $HOME subdirs.

BaseDirs::preference_dir

source

fn BaseDirs::preference_dir(self : BaseDirs) -> String

BaseDirs::runtime_dir

source

fn BaseDirs::runtime_dir(self : BaseDirs) -> String?

BaseDirs::state_dir

source

fn BaseDirs::state_dir(self : BaseDirs) -> String?

Platform

source

pub enum Platform {
  Windows
  Linux
  Darwin
  Unknown
}

ProjectDirs

source

pub struct ProjectDirs {
  project_path : String
  cache_dir : String
  config_dir : String
  config_local_dir : String
  data_dir : String
  data_local_dir : String
  preference_dir : String
  runtime_dir : String?
  state_dir : String?
}

ProjectDirs: project-scoped cache, config, data paths. Path segment rules: Linux (single lowercase segment), macOS (qualifier.Org-App), Windows (Org/App).

ProjectDirs::cache_dir

source

fn ProjectDirs::cache_dir(self : ProjectDirs) -> String

ProjectDirs::config_dir

source

fn ProjectDirs::config_dir(self : ProjectDirs) -> String

ProjectDirs::config_local_dir

source

fn ProjectDirs::config_local_dir(self : ProjectDirs) -> String

ProjectDirs::data_dir

source

fn ProjectDirs::data_dir(self : ProjectDirs) -> String

ProjectDirs::data_local_dir

source

fn ProjectDirs::data_local_dir(self : ProjectDirs) -> String

ProjectDirs::from

source

fn ProjectDirs::from(qualifier : String, organization : String, application : String) -> ProjectDirs?

Create ProjectDirs from qualifier, organization, application. Returns None if HOME (or base dirs) unavailable.

ProjectDirs::preference_dir

source

fn ProjectDirs::preference_dir(self : ProjectDirs) -> String

ProjectDirs::project_path

source

fn ProjectDirs::project_path(self : ProjectDirs) -> String

ProjectDirs::runtime_dir

source

fn ProjectDirs::runtime_dir(self : ProjectDirs) -> String?

ProjectDirs::state_dir

source

fn ProjectDirs::state_dir(self : ProjectDirs) -> String?

UserDirs

source

pub struct UserDirs {
  home_dir : String
  audio_dir : String?
  desktop_dir : String?
  document_dir : String?
  download_dir : String?
  font_dir : String?
  picture_dir : String?
  public_dir : String?
  template_dir : String?
  video_dir : String?
}

UserDirs: user-facing standard directories (Desktop, Documents, Music, etc.). v1 uses XDG_* env vars or $HOME subdirs.

UserDirs::audio_dir

source

fn UserDirs::audio_dir(self : UserDirs) -> String?

UserDirs::desktop_dir

source

fn UserDirs::desktop_dir(self : UserDirs) -> String?

UserDirs::document_dir

source

fn UserDirs::document_dir(self : UserDirs) -> String?

UserDirs::download_dir

source

fn UserDirs::download_dir(self : UserDirs) -> String?

UserDirs::font_dir

source

fn UserDirs::font_dir(self : UserDirs) -> String?

UserDirs::home_dir

source

fn UserDirs::home_dir(self : UserDirs) -> String

UserDirs::new

source

fn UserDirs::new() -> UserDirs?

Create UserDirs from current environment. Returns None if home is not set. On Windows uses USERPROFILE and standard subdirs; on Unix uses XDG_* or $HOME subdirs.

UserDirs::picture_dir

source

fn UserDirs::picture_dir(self : UserDirs) -> String?

UserDirs::public_dir

source

fn UserDirs::public_dir(self : UserDirs) -> String?

UserDirs::template_dir

source

fn UserDirs::template_dir(self : UserDirs) -> String?

UserDirs::video_dir

source

fn UserDirs::video_dir(self : UserDirs) -> String?

is_windows

source

fn is_windows() -> Bool

Convenience: true if platform is Windows.

join

source

fn join(segments : Array[String]) -> String

Join path segments for the current OS. Empty segments are skipped. Uses platform path separator (\ on Windows, / on Unix).

path_sep

source

fn path_sep() -> String

Path separator for the current OS: "\" on Windows, "/" otherwise.

platform

source

fn platform() -> Platform

Returns the current OS platform at runtime (Windows, Linux, Darwin, or Unknown). Implemented via FFI per target: JS uses process.platform; native uses C preprocessor macros.

Source Files

Site source Report issue Packages Build queue Skills Statistics

directories

#moonrockz/directories

#Installation

#Quick Start

#API

#Development

#BaseDirs

#BaseDirs::cache_dir

#BaseDirs::config_dir

#BaseDirs::config_local_dir

#BaseDirs::data_dir

#BaseDirs::data_local_dir

#BaseDirs::executable_dir

#BaseDirs::home_dir

#BaseDirs::new

#BaseDirs::preference_dir

#BaseDirs::runtime_dir

#BaseDirs::state_dir

#Platform

#ProjectDirs

#ProjectDirs::cache_dir

#ProjectDirs::config_dir

#ProjectDirs::config_local_dir

#ProjectDirs::data_dir

#ProjectDirs::data_local_dir

#ProjectDirs::from

#ProjectDirs::preference_dir

#ProjectDirs::project_path

#ProjectDirs::runtime_dir

#ProjectDirs::state_dir

#UserDirs

#UserDirs::audio_dir

#UserDirs::desktop_dir

#UserDirs::document_dir

#UserDirs::download_dir

#UserDirs::font_dir

#UserDirs::home_dir

#UserDirs::new

#UserDirs::picture_dir

#UserDirs::public_dir

#UserDirs::template_dir

#UserDirs::video_dir

#is_windows

#join

#path_sep

#platform

Source Files

BaseDirs

BaseDirs::cache_dir

BaseDirs::config_dir

BaseDirs::config_local_dir

BaseDirs::data_dir

BaseDirs::data_local_dir

BaseDirs::executable_dir

BaseDirs::home_dir

BaseDirs::new

BaseDirs::preference_dir

BaseDirs::runtime_dir

BaseDirs::state_dir

Platform

ProjectDirs

ProjectDirs::cache_dir

ProjectDirs::config_dir

ProjectDirs::config_local_dir

ProjectDirs::data_dir

ProjectDirs::data_local_dir

ProjectDirs::from

ProjectDirs::preference_dir

ProjectDirs::project_path

ProjectDirs::runtime_dir

ProjectDirs::state_dir

UserDirs

UserDirs::audio_dir

UserDirs::desktop_dir

UserDirs::document_dir

UserDirs::download_dir

UserDirs::font_dir

UserDirs::home_dir

UserDirs::new

UserDirs::picture_dir

UserDirs::public_dir

UserDirs::template_dir

UserDirs::video_dir

is_windows

join

path_sep

platform