sysenc

Documentation

Overview

Package sysenc provides efficient conversion of Go values to system call interfaces.

Index

• func Unmarshal(data interface{}, buf []byte) error
• type Buffer
  • func Marshal(data any, size int) (Buffer, error)
  • func SyscallOutput(dst any, size int) Buffer
  • func UnsafeBuffer(ptr unsafe.Pointer) Buffer
  • func (b Buffer) AppendTo(dst []byte) []byte
  • func (b Buffer) CopyTo(dst []byte) int
  • func (b Buffer) Pointer() sys.Pointer
  • func (b Buffer) Unmarshal(data any) error

Functions

func Unmarshal

func Unmarshal(data interface{}, buf []byte) error

Unmarshal a byte slice in the system's native endianness into data.

Returns an error if buf can't be unmarshalled according to the behaviour of binary.Read.

Types

type Buffer

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

func Marshal

func Marshal(data any, size int) (Buffer, error)

Marshal turns data into a byte slice using the system's native endianness.

If possible, avoids allocations by directly using the backing memory of data. This means that the variable must not be modified for the lifetime of the returned Buffer.

Returns an error if the data can't be turned into a byte slice according to the behaviour of binary.Write.

func SyscallOutput

func SyscallOutput(dst any, size int) Buffer

SyscallOutput prepares a Buffer for a syscall to write into.

size is the length of the desired buffer in bytes. The buffer may point at the underlying memory of dst, in which case Unmarshal becomes a no-op.

The contents of the buffer are undefined and may be non-zero.

func UnsafeBuffer

func UnsafeBuffer(ptr unsafe.Pointer) Buffer

UnsafeBuffer constructs a Buffer for zero-copy unmarshaling.

[Pointer] is the only valid method to call on such a Buffer. Use [SyscallBuffer] instead if possible.

func (Buffer) AppendTo

func (b Buffer) AppendTo(dst []byte) []byte

AppendTo appends the buffer onto dst.

func (Buffer) CopyTo

func (b Buffer) CopyTo(dst []byte) int

CopyTo copies the buffer into dst.

Returns the number of copied bytes.

func (Buffer) Pointer

func (b Buffer) Pointer() sys.Pointer

Pointer returns the location where a syscall should write.

func (Buffer) Unmarshal

func (b Buffer) Unmarshal(data any) error

Unmarshal the buffer into the provided value.