logos-storage/logos-storage-go-bindings
1
0
Fork 0
mirror of https://github.com/logos-storage/logos-storage-go-bindings.git synced 2026-03-29 23:43:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
Arnaud 2025-10-17 14:34:34 +02:00
parent 27b68f6d8f
commit a68d92ee8c
No known key found for this signature in database
GPG Key ID: 20E40A5D3110766F
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -98,7 +98,7 @@ Now the module is ready for use in your project.
The release process is defined [here](./RELEASE.md).
## Usage
## API
### Init
@ -307,4 +307,10 @@ peerId := "..."
record, err := node.CodexPeerDebug(peerId)
```
`CodexPeerDebug` is only available if you built with `-d:codex_enable_api_debug_peers=true` flag.
`CodexPeerDebug` is only available if you built with `-d:codex_enable_api_debug_peers=true` flag.
### Context and cancellation
Go contexts are exposed only on the long-running operations as `UploadReader`, `UploadFile`, and `DownloadFile`. If the
context is cancelled, those methods cancel the active upload or download. Short lived API calls don’t take a context
because they usually finish before a cancellation signal could matter.