Function repl_history_file

pub fn repl_history_file() -> Option<PathBuf>

Retrieve the path to the REPL history file.

This function will attempt to create all parent directories of the returned path. If creating parent directories fails, the error is ignored.

Callers should call this function once at start-up and retain the returned value for later use. Some platforms depend on ambient global state in the environment, so subsequent calls may return different results.

Platform Notes

The file is stored in the application data directory for the host operating system.

On Apple targets, the history file is located at a path like:

/Users/username/Library/Application Support/org.artichokeruby.airb/history

On Windows, the history file is located at a path like:

C:\Users\username\AppData\Local\Artichoke Ruby\airb\data\history.txt

On Linux and other Unix platforms excluding Apple targets, the history file is located in the XDG state home following the XDG Base Directory Specification. By default, the history file is located at:

$HOME/.local/state/artichokeruby/airb_history

Examples

use artichoke_repl_history::repl_history_file;

if let Some(hist_file) = repl_history_file() {
    // load history ...
}