diff --git a/Download-Types.md b/Download-Types.md index b3ce111..dc6279b 100644 --- a/Download-Types.md +++ b/Download-Types.md @@ -2,19 +2,22 @@ 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. -1. Default +## Default + * 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. * Even though writes occur within 1 or more 8MiB chunks, the file will not be scheduled for upload until all chunks have been downloaded. * This mode will be forced if any request to write is performed. * This mode supports read and write. -2. Ring buffer +## 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 +## 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