n0-computer / n0-computer/iroh-docs
Request: Make `engine` in `iroh_docs::protocol::Docs` public
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 74
- Forks
- 16
- PR merge metrics
- No merged PRs in 30d
Description
Hello,
How feasible would it be to make the engine field of the Docs struct public? This would allow for retrieving the default author ID without async or error handling; as an alternative, perhaps the Docs struct could get a method returning a iroh_docs::engine::DefaultAuthor? I was able to do this before, but now that Docs is the protocol handler instead of Engine, I can only get the default author through the authors client, which is more of a headache because of async and Result.
Thanks!
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading iroh_docs::protocol::Docs and iroh_docs::engine::DefaultAuthor, then compare the current authors-client path for retrieving the default author. Decide whether exposing engine or adding a Docs method best preserves the public API; done means callers can retrieve the default author without async or error handling.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- backend-api-design
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100