kayomn/ona
1
0
Fork 0
Code Issues 8 Pull Requests Projects 4 Releases Activity

Shorten argument names in [coral::file_system] methods

Browse Source
This commit is contained in:
kayomn 2023-03-02 20:40:24 +00:00
parent 36ca698e22
commit a44aed2fe3
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
source/coral/files.cpp
View File

@ -64,29 +64,29 @@ export namespace coral {
virtual ~file_system() {}; virtual ~file_system() {};
/** /**
* Attempts to read the file in `target_path`, calling `then` if it was successfully opened for reading and * Attempts to read the file in `path`, calling `then` if it was successfully opened for reading and passing the
* passing the [file_reader] context along. * [file_reader] context along.
* *
* See [file_reader] for more information on how to read from the file. * See [file_reader] for more information on how to read from the file.
*/ */
virtual void read_file(slice<char const> const & target_path, closure<void(file_reader &)> const & then) {} virtual void read_file(slice<char const> const & path, closure<void(file_reader &)> const & then) {}
/** /**
* Attempts to walk the file tree from `target_path`, calling `then` if it was successfully opened for walking * Attempts to walk the file tree from `path`, calling `then` if it was successfully opened for walking and
* and passing the [file_walker] context along. * passing the [file_walker] context along.
* *
* See [file_walker] for more information on how to traverse the file tree. * See [file_walker] for more information on how to traverse the file tree.
*/ */
virtual void walk_files(slice<char const> const & target_path, closure<void(file_walker &)> const & then) {} virtual void walk_files(slice<char const> const & path, closure<void(file_walker &)> const & then) {}
/** /**
* Attempts to write a file in the file system located at `target_path`, calling `then` if it was successfully * Attempts to write a file in the file system located at `path`, calling `then` if it was successfully created
* created and / or opened for writing and passing the [file_writer] context along. * and / or opened for writing and passing the [file_writer] context along.
* *
* See [file_writer] for more information on how to write to the file. * See [file_writer] for more information on how to write to the file.
* *
* *Note*: Any file already existing at `target_path` will be overwritten to create a new file for writing. * *Note*: Any file already existing at `path` will be overwritten to create a new file for writing.
*/ */
virtual void write_file(slice<char const> const & target_path, closure<void(file_writer &)> const & then) {} virtual void write_file(slice<char const> const & path, closure<void(file_writer &)> const & then) {}
}; };
} }