cloudflare / cloudflare/quiche

documentation of Connection::recv

Open
#1,183 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Rust
Stars
11.8k
Forks
1.1k
Avg merge
21h 9m
Merged PRs (30d)
6

Description

https://github.com/cloudflare/quiche/blob/be37a83c1e3d9bf88fddf3615734666312035cac/quiche/src/lib.rs#L1779-L1786

In the doc, it is not clear that whether `recv` always processes the whole `buf` unless error out. Looking at the code, it seems to be true. Should the doc clarify about that?

Contributor guide

Open the contributing guide

Research direction

Start at quiche/src/lib.rs around lines 1779-1786 and compare the Connection::recv documentation with the referenced implementation. Confirm whether recv processes the whole buffer unless it returns an error, then clarify the documentation so that behavior is explicit.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
networking
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.