aboutsummaryrefslogtreecommitdiff
path: root/docs/paths.md
diff options
context:
space:
mode:
authorBruce Hill <bruce@bruce-hill.com>2025-03-05 00:21:30 -0500
committerBruce Hill <bruce@bruce-hill.com>2025-03-05 00:21:30 -0500
commit0a3ad8ba914ab42ebbb88a3d955f71d71d581fc1 (patch)
treee984b58347627f0417a6961dbb8e83afe4739653 /docs/paths.md
parent665050940f1562b045efe942686d04b3c3fac381 (diff)
Alphabetize and index functions
Diffstat (limited to 'docs/paths.md')
-rw-r--r--docs/paths.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/paths.md b/docs/paths.md
index b6d62b61..d361b832 100644
--- a/docs/paths.md
+++ b/docs/paths.md
@@ -37,6 +37,33 @@ intended. Paths can be created from text with slashes using
## Path Methods
+- [`func append(path: Path, text: Text, permissions: Int32 = 0o644[32] -> Void)`](#`append)
+- [`func append_bytes(path: Path, bytes: [Byte], permissions: Int32 = 0o644[32] -> Void)`](#`append_bytes)
+- [`func base_name(path: Path -> Text)`](#`base_name)
+- [`func by_line(path: Path -> func(->Text?)?)`](#`by_line)
+- [`func children(path: Path, include_hidden=no -> [Path])`](#`children)
+- [`func create_directory(path: Path, permissions=0o755[32] -> Void)`](#`create_directory)
+- [`func exists(path: Path -> Bool)`](#`exists)
+- [`func extension(path: Path, full=yes -> Text)`](#`extension)
+- [`func files(path: Path, include_hidden=no -> [Path])`](#`files)
+- [`func glob(path: Path -> [Path])`](#`glob)
+- [`func is_directory(path: Path, follow_symlinks=yes -> Bool)`](#`is_directory)
+- [`func is_file(path: Path, follow_symlinks=yes -> Bool)`](#`is_file)
+- [`func is_socket(path: Path, follow_symlinks=yes -> Bool)`](#`is_socket)
+- [`func is_symlink(path: Path -> Bool)`](#`is_symlink)
+- [`func parent(path: Path -> Path)`](#`parent)
+- [`func read(path: Path -> Text?)`](#`read)
+- [`func read_bytes(path: Path -> [Byte]?)`](#`read_bytes)
+- [`func relative(path: Path, relative_to=(./) -> Path)`](#`relative)
+- [`func remove(path: Path, ignore_missing=no -> Void)`](#`remove)
+- [`func resolved(path: Path, relative_to=(./) -> Path)`](#`resolved)
+- [`func subdirectories(path: Path, include_hidden=no -> [Path])`](#`subdirectories)
+- [`func unique_directory(path: Path -> Path)`](#`unique_directory)
+- [`func write(path: Path, text: Text, permissions=0o644[32] -> Void)`](#`write)
+- [`func write(path: Path, bytes: [Byte], permissions=0o644[32] -> Void)`](#`write_bytes)
+- [`func write_unique(path: Path, text: Text -> Path)`](#`write_unique)
+- [`func write_unique_bytes(path: Path, bytes: [Byte] -> Path)`](#`write_unique_bytes)
+
### `append`
**Description:**