Skip to content

debug/elf: document errors returned by Open #76399

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

Closed
wants to merge 2 commits into from
+4 −0
Closed

debug/elf: document errors returned by Open #76399

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
66db1ec
document FormatError
MusicalNinjaDad Nov 21, 2025
de75e2d
document errors returned by Open
MusicalNinjaDad Nov 21, 2025
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
4 changes: 4 additions & 0 deletions src/debug/elf/file.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,6 +230,7 @@ type Symbol struct {
* ELF reader
*/

// FormatError is returned if the data does not have the correct format for an ELF.
type FormatError struct {
off int64
msg string
Expand All @@ -246,6 +247,9 @@ func (e *FormatError) Error() string {
}

// Open opens the named file using [os.Open] and prepares it for use as an ELF binary.
//
// Will return [*FormatError] if the file does not have the correct format for an ELF or
// [*os.PathError] if an error is encountered opening or reading the file.
func Open(name string) (*File, error) {
f, err := os.Open(name)
if err != nil {
Expand Down