murex rocks

Welcome

About

Install

Change Log

Blog

Technical Docs

Language Tour

Interactive Shell

Rosetta Stone

User Guide

Open Source

Discuss

Contribute

Source Code

Search Site

path

Structured object for working with file and directory paths

Description

The path type Turns file and directory paths into structured objects.

The root directory (typically /) is counted as a directory. If a path is relative rather than absolute then / will be excluded from outputted string.

Examples

First two elements in a path

» $PWD[..2]
/Users/

Check if path exists

» set path foobar="/dev/foobar"
» $foobar.2.Exists

path data structure

» set path foobar="/dev/foobar"
» $foobar -> format json
[
    {
        "Exists": true,
        "IsDir": true,
        "IsRelative": false,
        "Value": "/"
    },
    {
        "Exists": true,
        "IsDir": true,
        "IsRelative": false,
        "Value": "dev"
    },
    {
        "Exists": false,
        "IsDir": false,
        "IsRelative": false,
        "Value": "foobar"
    }
]

Supported Hooks

• Marshal() Supported
• ReadArray() Each element is a directory branch. Root, /, is treated as it’s own element
• ReadArrayWithType() Same as ReadArray()
• ReadIndex() Returns a directory branch or filename if last element is a file
• ReadMap() Not currently supported
• ReadNotIndex() Supported
• Unmarshal() Supported
• WriteArray() Each element is a directory branch

See Also

• MUREX_EXE: Absolute path to running shell
• PWD: Current working directory
• PWDHIST: History of each change to the sessions working directory
• paths: Structured array for working with $PATH style data

Read more about type hooks

• ReadIndex() (type): Data type handler for the index, [, builtin
• ReadNotIndex() (type): Data type handler for the bang-prefixed index, ![, builtin
• ReadArray() (type): Read from a data type one array element at a time
• WriteArray() (type): Write a data type, one array element at a time
• ReadMap() (type): Treat data type as a key/value structure and read its contents
• Marshal() (type): Converts structured memory into a structured file format (eg for stdio)
• Unmarshal() (type): Converts a structured file format into structured memory

---

This document was generated from builtins/types/paths/path_doc.yaml.