search

capnproto / capnproto-rust

Cap'n Proto for Rust
MIT License
2.06k stars 222 forks source link

docs: document capnrpc/src/lib.rs #502

Closed SteveLauC closed 5 months ago

SteveLauC commented 5 months ago

What does this PR do

Document most types/interfaces in capnp-rpc/src/lib.rs.

Why

I started working on #495, the first thing was to read the source code, then I found these are a lot of concepts that I am not aware of, and they do not have documents. Considering this is a Rust port is the C++ implementation, authors of this port should be already familiar with those concepts, this is understandable.

But I am completely new to them, so I took a look at the C++ repo, found the concept I wanted to understand, and copied the documents into the Rust code.

For stuff that already exists in the C++ impl, the documents are directly pasted, documents of other things are added based on my understanding.

codecov[bot] commented 5 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 51.73%. Comparing base (ab342b3) to head (8c86956). Report is 15 commits behind head on master.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #502 +/- ## ========================================== + Coverage 51.64% 51.73% +0.09% ========================================== Files 69 69 Lines 33735 33808 +73 ========================================== + Hits 17422 17492 +70 - Misses 16313 16316 +3 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

dwrensha commented 5 months ago

Thanks!