logos-storage/logos-storage-nim
1
0
Fork 0
mirror of https://github.com/logos-storage/logos-storage-nim.git synced 2026-01-04 06:23:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix details in documentation

Browse Source
This commit is contained in:
Arnaud 2025-12-19 12:05:12 +01:00
parent 8c9dee3bad
commit 50df458ec4
No known key found for this signature in database
GPG Key ID: 20E40A5D3110766F
1 changed files with 15 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
library/README.md
View File

@ -45,7 +45,7 @@ This API provides a C-compatible interface to the internal Nim implementation of
Unless explicitly stated otherwise, all functions are asynchronous and execute their work on a separate thread, returning results via the provided callback. The `int` return value is the synchronous status of dispatch: Unless explicitly stated otherwise, all functions are asynchronous and execute their work on a separate thread, returning results via the provided callback. The `int` return value is the synchronous status of dispatch:
- `RET_OK`: job dispatched to the worker thread - `RET_OK`: job dispatched to the worker thread
- `RET_ERR`: immediate failure - `RET_ERR`: immediate failure
- `RET_MISSING_CALLBACK`: callback is missing (if relevant) - `RET_MISSING_CALLBACK`: callback is missing
Some functions may emit progress updates via the callback using `RET_PROGRESS`, and finally complete with `RET_OK` or `RET_ERR`. Some functions may emit progress updates via the callback using `RET_PROGRESS`, and finally complete with `RET_OK` or `RET_ERR`.
For upload/download streaming, `msg` contains a chunk of data and `len` the chunk length. For upload/download streaming, `msg` contains a chunk of data and `len` the chunk length.
@ -138,16 +138,6 @@ int storage_destroy(void *ctx, StorageCallback callback, void *userData);
--- ---
### `storage_set_event_callback`
Not used currently. Reserved for future use to set an event callback.
```c
void storage_set_event_callback(void *ctx, StorageCallback callback, void *userData);
```
---
## Version ## Version
### `storage_version` ### `storage_version`
@ -264,13 +254,13 @@ int storage_connect(
--- ---
## Upload API ## Upload
### `storage_upload_init` ### `storage_upload_init`
Initialize an upload session for a file. Initialize an upload session for a file.
- `filepath`: absolute path for file upload; for chunk uploads it's the file name - `filepath`: absolute path for file upload; for chunk uploads it's the file name. The metadata filename and mime type are derived from this value.
- `chunkSize`: chunk size for upload (default: `1024 * 64` bytes) - `chunkSize`: chunk size for upload (default: `1024 * 64` bytes)
- Callback returns the `sessionId` - Callback returns the `sessionId`
@ -477,7 +467,7 @@ int storage_delete(void *ctx, const char *cid, StorageCallback callback, void *u
### `storage_fetch` ### `storage_fetch`
Fetch content identified by `cid` from the network into local store Fetch content identified by `cid` from the network into local store
Done in background; callback will not receive progress updates. in background. The callback will not receive progress updates.
```c ```c
int storage_fetch(void *ctx, const char *cid, StorageCallback callback, void *userData); int storage_fetch(void *ctx, const char *cid, StorageCallback callback, void *userData);
@ -493,6 +483,17 @@ Check if content identified by `cid` exists in local store.
int storage_exists(void *ctx, const char *cid, StorageCallback callback, void *userData); int storage_exists(void *ctx, const char *cid, StorageCallback callback, void *userData);
``` ```
### `storage_set_event_callback`
Not used currently. Reserved for future use to set an event callback.
```c
void storage_set_event_callback(void *ctx, StorageCallback callback, void *userData);
```
---
## Go wrapper ## Go wrapper
A Go wrapper is available [here](https://github.com/logos-storage/logos-storage-go-bindings). A Go wrapper is available [here](https://github.com/logos-storage/logos-storage-go-bindings).