BlockStorage/repertory
1
0
Fork 0
Code Issues 3 Pull Requests Releases 9 Wiki Activity

Update Download Types

sgraves76
2025-08-14 19:47:42 -05:00
parent 52492db1f1
commit 873ea89145
1 changed files with 8 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
Download-Types.md

@@ -11,11 +11,11 @@ You can set your preferred mode using the `PreferredDownloadType` option in `con
## 🔹 Mode Overview
| Mode | Description | Access Type |
|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------|-------------|
| **default** | Creates a local cache file matching the full size of the remote file. Reads/writes in 8 MiB chunks. Writes are uploaded only after full download. If the mount is unmounted prematurely, uploads resume on the next mount. | Read/Write |
| **direct** | Reads directly from the provider without creating a local cache file. Uses an **in-memory ring buffer** (up to five 8 MiB chunks). | Read-only |
| **ring_buffer** | Allocates a **fixed-size buffer file** (default 512 MiB) inside the `buffer` directory. Used for reading large files that exceed the ring buffer size. | Read-only |
| Mode | Description | Access Type |
|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|
| **default** | Starts in **direct mode** (read-only, minimal caching). If a write occurs, it switches to **read/write mode**, creating a local cache file matching the remote file size and reading/writing in 8 MiB chunks. Uploads occur after full download. If the mount is unmounted prematurely, uploads resume on the next mount. Currently behaves the same as `ring_buffer` but may change in the future to a different selection mechanism. | Read/Write |
| **direct** | Reads directly from the provider without creating a local cache file. Uses an **in-memory ring buffer** (up to five 8 MiB chunks). | Read-only |
| **ring_buffer** | Allocates a **fixed-size buffer file** (default 512 MiB) inside the `buffer` directory. Used for reading large files that exceed the in-memory buffer size. Currently behaves the same as `default`. | Read-only |
---
@@ -24,6 +24,7 @@ You can set your preferred mode using the `PreferredDownloadType` option in `con
- **Use `default`** when:
- You need both read and write access.
- You want to ensure files can upload after partial downloads or disconnections.
- You are okay with it currently acting like `ring_buffer` but potentially changing in the future.
- **Use `direct`** when:
- You only need read access.
- You want the lowest disk usage.
@@ -31,6 +32,7 @@ You can set your preferred mode using the `PreferredDownloadType` option in `con
- **Use `ring_buffer`** when:
- You are reading very large files repeatedly.
- You want to limit disk space usage by using a fixed-size disk buffer.
- You want behavior currently identical to `default`.
---
@@ -42,4 +44,4 @@ You can set your preferred mode using the `PreferredDownloadType` option in `con
}
```
Replace `"default"` with `"direct"` or `"ring_buffer"` to change the mode.
Replace `"default"` with `"direct"` or `"ring_buffer"` to change the mode.