Skip to content

Commit f2979fc

Browse files
committed
docs: document new error code in documentation
1 parent cdb4af8 commit f2979fc

1 file changed

Lines changed: 11 additions & 9 deletions

File tree

docs/docs/05-utilities/04-error-handling.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -106,15 +106,17 @@ These errors occur during file read/write operations.
106106

107107
These errors occur during model download and resource management.
108108

109-
| Error Code | Description | When It Occurs | How to Handle |
110-
| ----------------------------------- | -------------------------------- | ----------------------------------------------------- | ------------------------------------------------------------------------- |
111-
| `DownloadInterrupted` | Download was interrupted | Not all files were downloaded successfully | Retry the download |
112-
| `ResourceFetcherDownloadFailed` | Resource download failed | Network error, invalid URL, or server error | Check network connection and URL validity, retry with exponential backoff |
113-
| `ResourceFetcherDownloadInProgress` | Download already in progress | Calling `fetch()` for same resource while downloading | Wait for current download to complete |
114-
| `ResourceFetcherAlreadyPaused` | Download already paused | Calling `pauseFetching()` on already paused download | Check download state before pausing |
115-
| `ResourceFetcherAlreadyOngoing` | Download already ongoing | Calling `resumeFetching()` on active download | No action needed, download is already running |
116-
| `ResourceFetcherNotActive` | No active download found | Calling pause/resume/cancel on non-existent download | Verify download was started before trying to control it |
117-
| `ResourceFetcherMissingUri` | Required URI information missing | Internal state error during download operations | Restart the download from beginning |
109+
| Error Code | Description | When It Occurs | How to Handle |
110+
| -------------------------------------- | ------------------------------------------ | -------------------------------------------------------------------- | ------------------------------------------------------------------------- |
111+
| `DownloadInterrupted` | Download was interrupted | Not all files were downloaded successfully | Retry the download |
112+
| `ResourceFetcherDownloadFailed` | Resource download failed | Network error, invalid URL, or server error | Check network connection and URL validity, retry with exponential backoff |
113+
| `ResourceFetcherDownloadInProgress` | Download already in progress | Calling `fetch()` for same resource while downloading | Wait for current download to complete |
114+
| `ResourceFetcherAlreadyPaused` | Download already paused | Calling `pauseFetching()` on already paused download | Check download state before pausing |
115+
| `ResourceFetcherAlreadyOngoing` | Download already ongoing | Calling `resumeFetching()` on active download | No action needed, download is already running |
116+
| `ResourceFetcherNotActive` | No active download found | Calling pause/resume/cancel on non-existent download | Verify download was started before trying to control it |
117+
| `ResourceFetcherMissingUri` | Required URI information missing | Internal state error during download operations | Restart the download from beginning |
118+
| `ResourceFetcherAdapterNotInitialized` | Resource fetcher not initialized | Trying to load resources without calling `initExecutorch()` first | Call `initExecutorch({ resourceFetcher: ... })` before loading models |
119+
| `ResourceFetcherPlatformNotSupported` | Platform not supported by resource fetcher | Using a resource fetcher feature unavailable on the current platform | Use a platform-appropriate fetcher or avoid the unsupported operation |
118120

119121
### Speech-to-Text Streaming Errors
120122

0 commit comments

Comments
 (0)