package plan9obj

Import Path
	debug/plan9obj (on go.dev)

Dependency Relation
	imports 6 packages, and imported by one package

Involved Source Files

	  d file.go
		Package plan9obj implements access to Plan 9 a.out object files.
		
		# Security
		
		This package is not designed to be hardened against adversarial inputs, and is
		outside the scope of https://go.dev/security/policy. In particular, only basic
		validation is done when parsing object files. As such, care should be taken when
		parsing untrusted inputs, as parsing malformed files may consume significant
		resources, or cause panics.

	    plan9obj.go
Package-Level Type Names (total 5)

	/* sort by: alphabet | popularity */
	 type File (struct)
		A File represents an open Plan 9 a.out file.

		Fields (total 8)
			FileHeader FileHeader
			FileHeader.Bss uint32
			FileHeader.Entry uint64
			FileHeader.HdrSize uint64
			FileHeader.LoadAddress uint64
			FileHeader.Magic uint32
			FileHeader.PtrSize int
			Sections []*Section
		Methods (total 3)
			(*File) Close() error
				Close closes the [File].
				If the [File] was created using [NewFile] directly instead of [Open],
				Close has no effect.

			(*File) Section(name string) *Section
				Section returns a section with the given name, or nil if no such
				section exists.

			(*File) Symbols() ([]Sym, error)
				Symbols returns the symbol table for f.

		Implements (at least one exported)
			*File : io.Closer
		As Outputs Of (at least 2)
			func NewFile(r io.ReaderAt) (*File, error)
			func Open(name string) (*File, error)

	 type FileHeader (struct)
		A FileHeader represents a Plan 9 a.out file header.

		Fields (total 6)
			Bss uint32
			Entry uint64
			HdrSize uint64
			LoadAddress uint64
			Magic uint32
			PtrSize int

	 type Section (struct)
		A Section represents a single section in a Plan 9 a.out file.

		Fields (total 5)
			ReaderAt io.ReaderAt
				Embed ReaderAt for ReadAt method.
				Do not embed SectionReader directly
				to avoid having Read and Seek.
				If a client wants Read and Seek it must use
				Open() to avoid fighting over the seek offset
				with other clients.

			SectionHeader SectionHeader
			SectionHeader.Name string
			SectionHeader.Offset uint32
			SectionHeader.Size uint32
		Methods (total 3)
			(*Section) Data() ([]byte, error)
				Data reads and returns the contents of the Plan 9 a.out section.

			(*Section) Open() io.ReadSeeker
				Open returns a new ReadSeeker reading the Plan 9 a.out section.

			( Section) ReadAt(p []byte, off int64) (n int, err error)
		Implements (at least one exported)
			 Section : io.ReaderAt
		As Outputs Of (at least one exported)
			func (*File).Section(name string) *Section

	 type SectionHeader (struct)
		A SectionHeader represents a single Plan 9 a.out section header.
		This structure doesn't exist on-disk, but eases navigation
		through the object file.

		Fields (total 3)
			Name string
			Offset uint32
			Size uint32

	 type Sym (struct)
		A Symbol represents an entry in a Plan 9 a.out symbol table section.

		Fields (total 3)
			Name string
			Type rune
			Value uint64
		As Outputs Of (at least one exported)
			func (*File).Symbols() ([]Sym, error)


Package-Level Functions (total 2)

	 func NewFile(r io.ReaderAt) (*File, error)
		NewFile creates a new [File] for accessing a Plan 9 binary in an underlying reader.
		The Plan 9 binary is expected to start at position 0 in the ReaderAt.

	 func Open(name string) (*File, error)
		Open opens the named file using [os.Open] and prepares it for use as a Plan 9 a.out binary.


Package-Level Variables (only one)

	  var ErrNoSymbols error
		ErrNoSymbols is returned by [File.Symbols] if there is no such section
		in the File.


Package-Level Constants (total 4)

	const Magic386 = 491
	const Magic64 = 32768 // 64-bit expanded header
	const MagicAMD64 = 35479
	const MagicARM = 1607

The pages are generated with Golds v0.6.9-preview. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.