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

Jump to bottom

BufMut does not include safety invariants in trait documentation #664

Open
djkoloski opened this issue Jan 24, 2024 · 1 comment
Open

BufMut does not include safety invariants in trait documentation #664

djkoloski opened this issue Jan 24, 2024 · 1 comment

Comments

@djkoloski
Copy link

BufMut is unsafe to implement, but there are no safety requirements telling users what they need to ensure for their implementations to be sound. It looks like #329 lists out the requirements, so they may just need to be translated into documentation.
@Darksonn
Copy link
Contributor

Yes, it looks like you are correct.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Darksonn @djkoloski