yggdrasil/yggdrasil-elf
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Rewrite docs section about unsafe code

Browse Source 
This addresses feedback from #30
This commit is contained in:
Christopher Cole 2023-02-09 01:42:02 -08:00
parent dea6edfdf7
commit db0c3938a0
No known key found for this signature in database
GPG Key ID: 0AC856975983E9DB
2 changed files with 14 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -11,22 +11,16 @@ The `elf` crate provides a pure-safe-rust interface for reading ELF object files
# Capabilities
### ✨ No unsafe code ✨
With memory safety a core goal, this crate contains zero unsafe code blocks, so you
can trust in rust's memory safety guarantees without also having to trust this
library developer as having truly been "right" in why some unsafe block was safe. 💃
Many of the other rust ELF parsers out there contain bits of unsafe code deep
down or in dependencies to reinterpret/transmute byte contents as structures in
order to drive zero-copy parsing. They're slick, and there's typically
appropriate checking to validate the assumptions to make that unsafe code work,
but nevertheless it introduces unsafe code blocks at the core of the parsers. This
crate strives to serve as an alternate implementation with zero unsafe blocks, while
also biasing for performance.
### ✨ Uses only safe interfaces ✨
With memory safety a core goal, this crate contains zero unsafe code blocks of
its own and only uses safe interface methods from core and std, so you can
trust in rust's memory safety guarantees without also having to trust this
library developer as having truly been "right" in why some unsafe block was
safe. 💃
Note: I'd love to see this crate be enhanced further once rust provides safe transmutes.
See <https://github.com/rust-lang/project-safe-transmute>
See: <https://github.com/rust-lang/project-safe-transmute>
### ✨ Fuzz Tested ✨
Various parts of the library are fuzz tested for panics and crashes (see `fuzz/`).
@ -140,4 +134,4 @@ let (sym_idx, sym) = hash_table.find(name, &dynsyms, &strtab)
assert_eq!(sym_idx, 2);
assert_eq!(strtab.get(sym.st_name as usize).unwrap(), "memset");
assert_eq!(sym, dynsyms.get(sym_idx).unwrap());
```
```

18
src/lib.rs
View File

@ -2,18 +2,12 @@
//!
//! # Capabilities
//!
//! ### ✨ No unsafe code ✨
//! With memory safety a core goal, this crate contains zero unsafe code blocks, so you
//! can trust in rust's memory safety guarantees without also having to trust this
//! library developer as having truly been "right" in why some unsafe block was safe. 💃
//!
//! Many of the other rust ELF parsers out there contain bits of unsafe code deep
//! down or in dependencies to reinterpret/transmute byte contents as structures in
//! order to drive zero-copy parsing. They're slick, and there's typically
//! appropriate checking to validate the assumptions to make that unsafe code work,
//! but nevertheless it introduces unsafe code blocks at the core of the parsers. This
//! crate strives to serve as an alternate implementation with zero unsafe blocks, while
//! also biasing for performance.
//! ### ✨ Uses only safe interfaces ✨
//! With memory safety a core goal, this crate contains zero unsafe code blocks
//! of its own and only uses safe interface methods from core and std, so you can
//! trust in rust's memory safety guarantees without also having to trust this
//! library developer as having truly been "right" in why some unsafe block was
//! safe. 💃
//!
//! Note: I'd love to see this crate be enhanced further once rust provides safe transmutes.
//!