elf

Documentation

Index

• Constants
• func CustomError(original FileError, msg string, args ...any) error
• type File
  • func ReadAll(file io.Reader) (*File, error)
  • func (ef *File) AsBytes() []byte
  • func (ef *File) HasSection(name string) bool
  • func (ef *File) ReadSection(name string) ([]byte, error)
  • func (ef *File) SectionAddress(name string) (uint64, error)
  • func (ef *File) SectionSize(name string) (uint64, error)
  • func (ef *File) Sections() []string
  • func (ef *File) WriteSection(name string, data []byte, offset uint64) error
• type FileError
  • func (r FileError) Error() string

Constants

const (
	FileOpenErr      = FileError("cannot open the file with the passed file name")
	NoSuchSectionErr = FileError("there is no such section in the passed elf file")
	OutOfBoundsErr   = FileError("attempting to write out of the section bounds")
)

Functions

func CustomError

func CustomError(original FileError, msg string, args ...any) error

CustomError returns FileError that can use the classic fmt message/varargs.

Types

type File

type File struct {
	// contains filtered or unexported fields
}

File represents the contents of an elf binary file

func ReadAll

func ReadAll(file io.Reader) (*File, error)

ReadAll initializes an elf file object from a file stream

func (*File) AsBytes

func (ef *File) AsBytes() []byte

AsBytes returns a copy of the file as a byte array representation

func (*File) HasSection

func (ef *File) HasSection(name string) bool

HasSection returns whether an elf file has a section named 'name'

func (*File) ReadSection

func (ef *File) ReadSection(name string) ([]byte, error)

ReadSection reads the whole specified elf section

func (*File) SectionAddress

func (ef *File) SectionAddress(name string) (uint64, error)

SectionAddress returns the address of the section, if it exists

func (*File) SectionSize

func (ef *File) SectionSize(name string) (uint64, error)

SectionSize returns the size of the section, if it exists

func (*File) Sections

func (ef *File) Sections() []string

Sections returns a list of the sections within an elf file

func (*File) WriteSection

func (ef *File) WriteSection(name string, data []byte, offset uint64) error

WriteSection writes data at the specified offset within the specified section

type FileError

type FileError string

FileError identifies an error related to a hex file

func (FileError) Error

func (r FileError) Error() string

Error returns a string representation of a FileError