aivi.path

Lexical path manipulation on Text strings plus the PathSource handle marker for host directory snapshots. The functions in this module are synchronous and pure — they perform no I/O and never touch the filesystem.

use aivi.path (
    parent
    filename
    stem
    extension
    join
    isAbsolute
    normalize
)

---

Types

Path

type Path = Text

A type alias for Text that signals intent. Use it in your own types to make path arguments self-documenting.

use aivi.path (Path)

type FileRef = {
    path: Path,
    label: Text
}

PathError

type PathError =
  | InvalidPath Text
  | PathNotFound Text

---

Intrinsics

parent : Text -> Option Text

Return the directory containing this path. Returns None for a root or empty path.

use aivi.path (parent)

filename : Text -> Option Text

Return the final path component, including its extension. Returns None for a root path.

use aivi.path (filename)

stem : Text -> Option Text

Return the final path component without its extension.

use aivi.path (stem)

extension : Text -> Option Text

Return the extension (characters after the last dot in the filename).

use aivi.path (extension)

join : Text -> Text -> Text

Append a segment to a base path. If the segment is absolute it replaces the base (POSIX semantics).

use aivi.path (join)

isAbsolute : Text -> Bool

Return True when the path begins with /.

use aivi.path (isAbsolute)

normalize : Text -> Text

Resolve . (current directory) and .. (parent directory) segments lexically, without touching the filesystem.

use aivi.path (normalize)

---

Real-world example

use aivi.path (
    join
    normalize
)

use aivi.fs (
    FsSource
    FsError
)

value configDir : Text = "/etc/demo"

@source fs configDir
signal files : FsSource

value configPath : Text = join configDir "app.conf"
value backupPath : Text = normalize (join configDir "../demo/app.conf.bak")
value readConfig : Signal (Result FsError Text) = files.read "app.conf"
value writeBackup : Task Text Unit = files.writeText "app.conf.bak" "..."

TIP

Combine aivi.path with FsSource handles: use the pure path functions to build lexical path text, then use @source fs ... for the actual read/write/delete boundary.