1
1
mirror of https://github.com/wez/wezterm.git synced 2024-08-16 17:50:28 +03:00

Merge remote-tracking branch 'origin/Path-and-MetaData' into Path-and-MetaData

This commit is contained in:
Danielkonge 2023-12-03 19:49:17 +01:00
commit dc3afcd892
2 changed files with 0 additions and 86 deletions

View File

@ -1,20 +0,0 @@
# `MetaData` object
{{since('nightly')}}
`MetaData` represents the metadata of a directory, file or symlink.
`MetaData` implements a `__tostring` meta method, so you can print it
for debugging.
`MetaData` has the following methods:
- [bytes](bytes.md)
- [is_dir](is_dir.md)
- [is_file](is_file.md)
- [is_symlink](is_symlink.md)
- [secs_since_accessed](secs_since_accessed.md)
- [secs_since_created](secs_since_created.md)
- [secs_since_modified](secs_since_modified.md)

View File

@ -1,66 +0,0 @@
# `Path` object
{{since('nightly')}}
`Path` represents a string describing a path.
`Path` implements
- a `__tostring` meta method, which gives you back the string
describing the path (assuming the string is valid UTF-8). Thus, you can easily
use a `Path` object with `string.format` or `print` or `tostring`.
- a `__concat` meta method, which allows you to concatenate a `Path` with another
`Path` object or a string as if you are concatenating strings.
- an `__eq` meta method, which allows you to check if two `Path` objects are equal.
*Note:* Concatenation of the form `path1 .. path2` or `path .. string` will work
as expected, but `string .. path` will not work, since Lua uses the `string.__concat`
meta method in this case.
`Path` also implements the following string methods:
- `byte`
- `find`
- `gmatch`
- `gsub`
- `len`
- `lower`
- `match`
- `rep`
- `reverse`
- `sub`
- `upper`
*Note:* These are all the `string` functions in Lua that don't start with either
something other than a string or a format string. These methods are implemented
in such a way that they transform the given `Path` object to a string and then
calls the standard `string` method on this string. For technical reasons this
means that the methods will only work on strings that are valid UTF-8.
Additionally `Path` has the following methods:
- [ancestors](ancestors.md)
- [basename](basename.md)
- [canonical_path](canonical_path.md)
- [clone](clone.md)
- [components](components.md)
- [dirname](dirname.md)
- [ends_with](ends_with.md)
- [extension](extension.md)
- [file_stem](file_stem.md)
- [is_absolute](is_absolute.md)
- [is_relative](is_relative.md)
- [join](join.md)
- [metadata](metadata.md)
- [pop](pop.md)
- [push](push.md)
- [read_dir](read_dir.md)
- [read_link](read_link.md)
- [set_extension](set_extension.md)
- [set_filename](set_filename.md)
- [starts_with](starts_with.md)
- [strip_prefix](strip_prefix.md)
- [symlink_metadata](symlink_metadata.md)
- [try_exists](try_exists.md)