6.42 Paths

8.12

6.42 Paths🔗ℹ

The . operator can be used on a path expression as equivalent to calling Path functions:

path.bytes()
is
Path.bytes(path)
path.string()
is
Path.string(path)

annotation

Path

Matches a path value.

function

fun Path(path :: Bytes || String || Path) :: Path

Constructs a path given a byte string, string, or existing path. When a path is provided as path, then the result is path.

> def p = Path("/home/rhombus/shape.txt")
> p
#<path:/home/rhombus/shape.txt>
> Path(p)
#<path:/home/rhombus/shape.txt>
> p.string()
"/home/rhombus/shape.txt"

binding operator

Path(bind)

Matches a path where the byte-string form of the path matches bind.

> def Path(p) = Path("/home/rhombus/shape.txt")
> p
#"/home/rhombus/shape.txt"

function

fun Path.bytes(path :: Path) :: Bytes

Converts a path to a byte-string form, which does not lose any information about the path.

> def p = Path("/home/rhombus/shape.txt")
> Path.bytes(p)
#"/home/rhombus/shape.txt"
> p.bytes()
#"/home/rhombus/shape.txt"

function

fun Path.string(path :: Path) :: String

Converts a path to a human-readable form, but the conversion may lose information if the path cannot be expressed using a string (e.g., due to a byte-string form that is not a UTF-8 encoding).

> def p = Path(#"/home/rhombus/shape.txt")
> Path.string(p)
"/home/rhombus/shape.txt"
> p.string()
"/home/rhombus/shape.txt"

1	Rhombus Essentials
2	Collections and Iteration
3	Syntax Objects and Macros
4	Classes and Interfaces
5	Static Information and Binding
6	Core Reference
7	Meta and Macros Reference
8	Rhombus Static by Default
9	Libraries
10	Naming Conventions

6.1	General Forms
6.2	Definitions
6.3	Namespaces
6.4	Import
6.5	Export
6.6	Functions
6.7	Operators
6.8	Classes and Interfaces
6.9	Veneers
6.10	Mutable Variables and Assignment
6.11	Repetitions
6.12	Block
6.13	Conditionals
6.14	Matching
6.15	Iteration
6.16	Recursion
6.17	Context Parameters
6.18	Exceptions
6.19	Continuations
6.20	Implicit Forms
6.21	Static and Dynamic Lookup
6.22	Modules and Submodules
6.23	Booleans
6.24	Numbers
6.25	Characters
6.26	Strings
6.27	Keywords
6.28	Symbols
6.29	Byte Strings
6.30	Lists
6.31	Pairs and Pair Lists
6.32	Mutable Lists
6.33	Arrays
6.34	Maps
6.35	Sets
6.36	Boxes
6.37	Indexables
6.38	Listables
6.39	Sequences
6.40	Appendables
6.41	Comparables
6.42	Paths
6.43	Source Locations
6.44	Void
6.45	Equality
6.46	Dot
6.47	Multiple Values
6.48	Annotations
6.49	Enumerations
6.50	Input and Output
6.51	Eval
6.52	Syntax Objects
6.53	Syntax Classes
6.54	Simple Expression Macros
6.55	Unit Testing

path.bytes()	is	Path.bytes(path)
path.string()	is	Path.string(path)