Explicitly document that pod_read_unaligned and try_pod_read_unaligned don't panic on unaligned reads

Lokathor / bytemuck

A crate for mucking around with piles of bytes

https://docs.rs/bytemuck

Apache License 2.0

697 stars 77 forks source link

Explicitly document that pod_read_unaligned and try_pod_read_unaligned don't panic on unaligned reads #220

Closed hniksic closed 7 months ago

hniksic commented 7 months ago

Their names make that reasonably clear already, but it doesn't hurt to be explicit. Also, when choosing between *from_bytes(x) and pod_read_unaligned(x), it's good to have a clearly documented criterion.

The PR also adds a couple other cosmetic doc fixes, as separate commits.

Lokathor commented 7 months ago

released in bytemuck-1.14.1