From be7a6febcbfb63e1c9df71a729d3fb2ad03c76f7 Mon Sep 17 00:00:00 2001 From: Paul Campbell Date: Sat, 2 Nov 2024 07:13:30 +0000 Subject: [PATCH] docs: update readme --- README.md | 43 +++++++++++++++++-------------------------- 1 file changed, 17 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index cf59be9..b7d2ed1 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,28 @@ ## kxio -[![status-badge](https://ci.kemitix.net/api/badges/53/status.svg)](https://ci.kemitix.net/repos/53) - Provides injectable Filesystem and Network resources to make code more testable. -### FileSystem - -There are two FileSystem implementation: [filesystem] and [fs]. - -- [filesystem] is the legacy implementation and will be removed in a future version. -- [fs] is the current version and is intended to stand-in for and extend the [std::fs] module from the Standard Library. - #### std::fs alternatives | To Do | [std::fs] | [kxio::fs::FileSystem] | | | ----- | ---------------- | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | -| [ ] | canonicalize | path_canonicalize | Returns the canonical, absolute form of a path with all intermediate components normalized and symbolic links resolved. | -| [ ] | copy | file_copy | Copies the contents of one file to another. This function will also copy the permission bits of the original file to the destination file. | -| [ ] | create_dir | dir_create | Creates a new, empty directory at the provided path | -| [ ] | create_dir_all | dir_create_all | Recursively create a directory and all of its parent components if they are missing. | -| [ ] | hard_link | link_create | Creates a new hard link on the filesystem. | -| [ ] | metadata | path_metadata | Given a path, query the file system to get information about a file, directory, etc. | -| [ ] | read | file_read | Read the entire contents of a file into a bytes vector. | -| [ ] | read_dir | dir_read | Returns an iterator over the entries within a directory. | -| [ ] | read_link | link_read | Reads a symbolic link, returning the file that the link points to. | -| [x] | read_to_string | file_read_to_string | Read the entire contents of a file into a string. | -| [ ] | remove_dir | dir_remove | Removes an empty directory. | -| [ ] | remove_dir_all | dir_remove_all | Removes a directory at this path, after removing all its contents. Use carefully! | -| [ ] | remove_file | file_remove | Removes a file from the filesystem. | -| [ ] | rename | path_rename | Rename a file or directory to a new name, replacing the original file if to already exists. | -| [ ] | set_permissions | path_set_permissions | Changes the permissions found on a file or a directory. | -| [ ] | symlink_metadata | link_metadata | Query the metadata about a file without following symlinks. | -| [x] | write | file_write | Write a slice as the entire contents of a file. | +| [ ] | canonicalize | path(path).canonicalize() | Returns the canonical, absolute form of a path with all intermediate components normalized and symbolic links resolved. | +| [ ] | copy | file(path).copy(target) | Copies the contents of one file to another. This function will also copy the permission bits of the original file to the destination file. | +| [x] | create_dir | dir(path).create() | Creates a new, empty directory at the provided path | +| [x] | create_dir_all | dir(path).create_all() | Recursively create a directory and all of its parent components if they are missing. | +| [ ] | hard_link | link(path)create() | Creates a new hard link on the filesystem. | +| [ ] | metadata | path(path).metadata() | Given a path, query the file system to get information about a file, directory, etc. | +| [ ] | read | file(path).reader().bytes() | Read the entire contents of a file into a bytes vector. | +| [x] | read_dir | dir(path).read() | Returns an iterator over the entries within a directory. | +| [ ] | read_link | link(path).read() | Reads a symbolic link, returning the file that the link points to. | +| [x] | read_to_string | file(path).reader().to_string() | Read the entire contents of a file into a string. | +| [ ] | remove_dir | dir(path).remove() | Removes an empty directory. | +| [ ] | remove_dir_all | dir(path).remove_all() | Removes a directory at this path, after removing all its contents. Use carefully! | +| [ ] | remove_file | file(path).remove() | Removes a file from the filesystem. | +| [ ] | rename | path(path).rename() | Rename a file or directory to a new name, replacing the original file if to already exists. | +| [ ] | set_permissions | path(path).set_permissions() | Changes the permissions found on a file or a directory. | +| [ ] | symlink_metadata | link(path).metadata() | Query the metadata about a file without following symlinks. | +| [x] | write | file(path).write() | Write a slice as the entire contents of a file. | ### Network