Skip to content

Improve documentation around AddressSpaceId #13

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

Merged
mnemonikr merged 1 commit into from
Oct 16, 2025
Merged

Improve documentation around AddressSpaceId #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions src/sleigh.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,9 @@ impl From<&sys::VarnodeData> for VarnodeData {
}
}

/// Address space identifier for an address space
/// Address space identifier for an address space. While this value is unique, it is **NOT**
/// guaranteed to be deterministically constructed. This means different instances of Sleigh may
/// identify the same address space with _different_ identifiers.
#[derive(Copy, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct AddressSpaceId(usize);

Expand Down Expand Up @@ -315,7 +317,9 @@ impl From<sys::spacetype> for AddressSpaceType {
}
}

/// A pcode instruction
/// A pcode instruction. Interpreting the pcode instruction can require additional context in some
/// cases. For example, the [OpCode::Load] operation encodes the [AddressSpace] using the
/// [AddressSpaceId]. This identifier in particular may differ across Sleigh instances.
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct PcodeInstruction {
/// The originating address for this instruction. This information is necessary to include for
Expand Down