Update Download Types

Scott E. Graves 2025-02-23 18:28:30 -06:00
parent 84afdadcb0
commit b808f4b6b6

@ -4,7 +4,7 @@
The `PreferredDownloadType` setting in `config.json` determines which of these modes is preferred. This does not guarantee the mode will always be chosen, as `repertory` will choose an appropriate mode based on the type of file operation being performed. If a file is currently open in read mode and a request to write is performed, the file will automatically be changed to `default` mode without any interruptions to file i/o. The `PreferredDownloadType` setting in `config.json` determines which of these modes is preferred. This does not guarantee the mode will always be chosen, as `repertory` will choose an appropriate mode based on the type of file operation being performed. If a file is currently open in read mode and a request to write is performed, the file will automatically be changed to `default` mode without any interruptions to file i/o.
## Default ### Default
* In `default` mode, a file of equal size is fully allocated within the`cache` directory. * In `default` mode, a file of equal size is fully allocated within the`cache` directory.
* File read/write occurs in 8MiB chunks for files that are not currently in cache. * File read/write occurs in 8MiB chunks for files that are not currently in cache.
@ -13,14 +13,14 @@ The `PreferredDownloadType` setting in `config.json` determines which of these m
* This mode will be forced if any request to write is performed. * This mode will be forced if any request to write is performed.
* This mode supports read and write. * This mode supports read and write.
## Ring buffer ### Ring buffer
* In `ring_buffer` mode, a fixed-size file (default 1GiB) is allocated within the `buffer` directory. * In `ring_buffer` mode, a fixed-size file (default 1GiB) is allocated within the `buffer` directory.
* This mode will cache up to 1GiB of a file locally preventing the need to fully allocate a file for read operations. * This mode will cache up to 1GiB of a file locally preventing the need to fully allocate a file for read operations.
* This mode is only chosen when the actual file size is greater than the ring-buffer size. * This mode is only chosen when the actual file size is greater than the ring-buffer size.
* This mode only supports read. * This mode only supports read.
## Direct ### Direct
* In `direct` mode, files are read directly from the corresponding provider without any local caching. * In `direct` mode, files are read directly from the corresponding provider without any local caching.
* An in-memory ring buffer is used to cache up to 5 8MiB chunks. * An in-memory ring buffer is used to cache up to 5 8MiB chunks.