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.

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

sendmmsg documentation is incorrect #2030

Open
kalradivyanshu opened this issue May 2, 2023 · 3 comments
Open

sendmmsg documentation is incorrect #2030

kalradivyanshu opened this issue May 2, 2023 · 3 comments

Comments

@kalradivyanshu
Copy link

kalradivyanshu commented May 2, 2023

https://docs.rs/nix/latest/nix/sys/socket/fn.sendmmsg.html is incorrect. The doc says that sendmmsg takes 3 arguments:

Arguments

  • fd: Socket file descriptor
  • data: Struct that implements IntoIterator with SendMmsgData items
  • flags: Optional flags passed directly to the operating system.

But it takes 6? And as far as I can tell SendMmsgData doesn't exist anymore? I would love a working example of how to use sendmmsg.

Thanks!

@kalradivyanshu kalradivyanshu changed the title sendmmsg documentation is wrong sendmmsg documentation is incorrect May 2, 2023
@asomers
Copy link
Member

asomers commented Jun 29, 2023

sendmmsg is notoriously hard to use, and hard to bind in Rust. Nix has been through a few different versions. @pacak @rtzoeller could you please take a look?

@pacak
Copy link
Contributor

pacak commented Jun 29, 2023

Derp. I totally forgot to update the documentation when updating sendmmsg. Now there's also #2038 that changes sendmmsg a bit more....

@pacak
Copy link
Contributor

pacak commented Jun 29, 2023

Updated the docs in #2038 a bit, at least now it doesn't contradict to the type signature.

@Jan561 Jan561 mentioned this issue Nov 23, 2023
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants