Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ringbuf: Fix callback docs #1100

Merged
merged 1 commit into from
Feb 26, 2025
Merged

ringbuf: Fix callback docs #1100

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion libbpf-rs/src/ringbuf.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,8 @@ impl<'slf, 'cb: 'slf> RingBufferBuilder<'slf, 'cb> {
/// manager. The callback should take one argument, a slice of raw bytes,
/// and return an i32.
///
/// Non-zero return values in the callback will stop ring buffer consumption early.
/// Negative return values in the callback will stop ring buffer consumption early and
/// propagate the error code to the polling caller.
///
/// The callback provides a raw byte slice. You may find libraries such as
/// [`plain`](https://crates.io/crates/plain) helpful.
Expand Down