Struct skyline::patching::BranchBuilder

pub struct BranchBuilder { /* private fields */ }

A builder type to help when replacing branches in games

Example:

// Replace the instruction at `main` + 0x14a8504 with a branch
// to `main` + 0x14a853C
BranchBuilder::branch()
    .branch_offset(0x14a8504)
    .branch_to_offset(0x14a853C)
    .replace()

// Replace the instruction at `main` + 0x14a8504 with a branch
// to `replacement_function`
BranchBuilder::branch()
    .branch_offset(0x14a8504)
    .branch_to_ptr(replacement_function as *const ())
    .replace()

Implementations

impl BranchBuilder

pub fn branch() -> Self

Create new branch builder for a b ARM instruction

pub fn branch_link() -> Self

Create new branch builder for a bl ARM instruction

pub fn branch_offset(self, offset: usize) -> Self

Set the offset within the executable of the instruction to replace

pub fn branch_to_offset(self, offset: usize) -> Self

Offset within the executable for the branch to jump to

pub fn branch_to_ptr<T>(self, ptr: *const T) -> Self

Set a pointer for the branch to be jumped to. Must be within +/- 128 MiB of the given offset

pub fn replace(self)

Replaces an instruction at the provided offset with a branch to the given pointer.

Panics

Panics if an offset/ptr hasn’t been provided or if the pointer is out of range of the branch