From 9aa1a52057f5d5d67c6985d48bfa0326b428e20f Mon Sep 17 00:00:00 2001 From: "Scott E. Graves" Date: Sun, 23 Feb 2025 18:10:09 -0600 Subject: [PATCH] Add Download Types --- Download-Types.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 Download-Types.md diff --git a/Download-Types.md b/Download-Types.md new file mode 100644 index 0000000..f7dab64 --- /dev/null +++ b/Download-Types.md @@ -0,0 +1,17 @@ +`repertory` supports 3 different types of downloads for files. 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, `repertory` will automatically switch to `default` mode without any interruptions to file i/o. + +1. Default + * In `default' mode, a file of equal size is allocated in the`cache` directory. + * File read/write occurs in 8MiB chunks for files that are not currently in cache. + * This mode will be forced if any request to write is performed. + * This mode supports read and write. + +2. Ring-buffer + * 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 is only chosen when the actual file size is greater than the ring-buffer size. + * This mode only supports read. + +3. Direct + * In `direct` mode, files are read directly from the corresponding provider without any local caching. + * This mode only supports read. \ No newline at end of file