apunkt/nyx
1
0
Fork 0
mirror of https://github.com/elicpeter/nyx.git synced 2026-06-12 19:55:14 +02:00
Code Issues Projects Releases Packages Wiki Activity

docs: Enhance module documentation across various files for clarity a… (#62)

Browse source 
* docs: Enhance module documentation across various files for clarity and completeness

* fix: Remove unnecessary blank line in build.rs for cleaner code

* docs: Update documentation to improve clarity and consistency in code comments
This commit is contained in:
Eli Peter 2026-05-02 17:46:45 -04:00 • committed by GitHub
parent 40995e45e7
commit 1f2bfe76c1
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
44 changed files with 721 additions and 366 deletions
Download patch file Download diff file Expand all files Collapse all files

6
src/symex/heap.rs
View file

@ -102,7 +102,7 @@ pub struct FieldAccessRecord {
/// Bounded symbolic heap tracking field-level symbolic values and taint.
///
/// Cloned at fork points during multi-path exploration. Bounded
/// by [`MAX_HEAP_ENTRIES`] total entries and [`MAX_FIELDS_PER_OBJECT`] per
/// by `MAX_HEAP_ENTRIES` total entries and `MAX_FIELDS_PER_OBJECT` per
/// object to prevent blowup on object-heavy code.
#[derive(Clone, Debug)]
pub struct SymbolicHeap {
@ -126,8 +126,8 @@ impl SymbolicHeap {
/// Store a symbolic value into a heap field.
///
/// Bounded: silently drops the store if [`MAX_HEAP_ENTRIES`] or
/// [`MAX_FIELDS_PER_OBJECT`] would be exceeded. `Index(*)` entries are
/// Bounded: silently drops the store if `MAX_HEAP_ENTRIES` or
/// `MAX_FIELDS_PER_OBJECT` would be exceeded. `Index(*)` entries are
/// bounded by [`MAX_TRACKED_INDICES`] per object; overflow collapses all
/// indexed entries into `Elements`.
pub fn store(&mut self, key: HeapKey, value: SymbolicValue, tainted: bool) {