Struct ObjectBuilder 

pub struct ObjectBuilder { /* private fields */ }

A struct for building object files

Implementations

impl ObjectBuilder

pub fn new(path: &str) -> Self

Examples found in repository

examples/simple.rs (line 4)

pub fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut obj = ObjectBuilder::new("test.o");

    obj.decls(vec![
        ("callme", Decl::Function(Scope::Import)),
        ("call", Decl::Function(Scope::Export)),
        ("data", Decl::Data(Scope::Export)),
    ]);

    obj.define(
        "call",
        vec![
            0xF3, 0x0F, 0x1E, 0xFA,         // endbr64
            0x55,                           // push rbp
            0x48, 0x89, 0xE5,               // mov rbp, rsp
            0xE8, 0x00, 0x00, 0x00, 0x00,   // call callme
            0x5D,                           // pop rbp
            0xC3,                           // ret
        ],
    );

    obj.define("data", 
        b"Hello World".into()
    );

    obj.link(Link {
        from: "call".into(),
        to: "callme".into(),
        at: 9,
    });

    obj.write(BinFormat::host(), Arch::host(), Endian::host())?;

    Ok(())
}

pub fn decls(&mut self, decls: Vec<(&str, Decl)>)

Adds a list of decls

Examples found in repository

examples/simple.rs (lines 6-10)

pub fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut obj = ObjectBuilder::new("test.o");

    obj.decls(vec![
        ("callme", Decl::Function(Scope::Import)),
        ("call", Decl::Function(Scope::Export)),
        ("data", Decl::Data(Scope::Export)),
    ]);

    obj.define(
        "call",
        vec![
            0xF3, 0x0F, 0x1E, 0xFA,         // endbr64
            0x55,                           // push rbp
            0x48, 0x89, 0xE5,               // mov rbp, rsp
            0xE8, 0x00, 0x00, 0x00, 0x00,   // call callme
            0x5D,                           // pop rbp
            0xC3,                           // ret
        ],
    );

    obj.define("data", 
        b"Hello World".into()
    );

    obj.link(Link {
        from: "call".into(),
        to: "callme".into(),
        at: 9,
    });

    obj.write(BinFormat::host(), Arch::host(), Endian::host())?;

    Ok(())
}

pub fn add_decl(&mut self, name: &str, decl: Decl)

Adds a decl

pub fn define(&mut self, sym: &str, data: Vec<u8>)

Defines a symbol

Examples found in repository

examples/simple.rs (lines 12-22)

pub fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut obj = ObjectBuilder::new("test.o");

    obj.decls(vec![
        ("callme", Decl::Function(Scope::Import)),
        ("call", Decl::Function(Scope::Export)),
        ("data", Decl::Data(Scope::Export)),
    ]);

    obj.define(
        "call",
        vec![
            0xF3, 0x0F, 0x1E, 0xFA,         // endbr64
            0x55,                           // push rbp
            0x48, 0x89, 0xE5,               // mov rbp, rsp
            0xE8, 0x00, 0x00, 0x00, 0x00,   // call callme
            0x5D,                           // pop rbp
            0xC3,                           // ret
        ],
    );

    obj.define("data", 
        b"Hello World".into()
    );

    obj.link(Link {
        from: "call".into(),
        to: "callme".into(),
        at: 9,
    });

    obj.write(BinFormat::host(), Arch::host(), Endian::host())?;

    Ok(())
}

pub fn link(&mut self, link: Link)

Adds an link to the object file

Examples found in repository

examples/simple.rs (lines 28-32)

pub fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut obj = ObjectBuilder::new("test.o");

    obj.decls(vec![
        ("callme", Decl::Function(Scope::Import)),
        ("call", Decl::Function(Scope::Export)),
        ("data", Decl::Data(Scope::Export)),
    ]);

    obj.define(
        "call",
        vec![
            0xF3, 0x0F, 0x1E, 0xFA,         // endbr64
            0x55,                           // push rbp
            0x48, 0x89, 0xE5,               // mov rbp, rsp
            0xE8, 0x00, 0x00, 0x00, 0x00,   // call callme
            0x5D,                           // pop rbp
            0xC3,                           // ret
        ],
    );

    obj.define("data", 
        b"Hello World".into()
    );

    obj.link(Link {
        from: "call".into(),
        to: "callme".into(),
        at: 9,
    });

    obj.write(BinFormat::host(), Arch::host(), Endian::host())?;

    Ok(())
}

pub fn write( &mut self, format: BinFormat, arch: Arch, endian: Endian, ) -> Result<(), Box<dyn Error>>

Writes all internaly saved symbols etc. to a object file

Args:

• format - specifes the binary format of the object file
• arch - specifes the architecture of the object file
• endian - specifes the endian of the object file

Examples found in repository

examples/simple.rs (line 34)

pub fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut obj = ObjectBuilder::new("test.o");

    obj.decls(vec![
        ("callme", Decl::Function(Scope::Import)),
        ("call", Decl::Function(Scope::Export)),
        ("data", Decl::Data(Scope::Export)),
    ]);

    obj.define(
        "call",
        vec![
            0xF3, 0x0F, 0x1E, 0xFA,         // endbr64
            0x55,                           // push rbp
            0x48, 0x89, 0xE5,               // mov rbp, rsp
            0xE8, 0x00, 0x00, 0x00, 0x00,   // call callme
            0x5D,                           // pop rbp
            0xC3,                           // ret
        ],
    );

    obj.define("data", 
        b"Hello World".into()
    );

    obj.link(Link {
        from: "call".into(),
        to: "callme".into(),
        at: 9,
    });

    obj.write(BinFormat::host(), Arch::host(), Endian::host())?;

    Ok(())
}

Trait Implementations

impl Clone for ObjectBuilder

fn clone(&self) -> ObjectBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ObjectBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.