arch

Documentation

Overview

Package arch provides information about the currently CPU architecture.

Index

• Constants
• Variables
• func BitnessNames() []string
• type Bitness
  • func ParseBitness(name string) (Bitness, error)
  • func (x Bitness) MarshalText() ([]byte, error)
  • func (b Bitness) Short() string
  • func (x Bitness) String() string
  • func (x *Bitness) UnmarshalText(text []byte) error
• type ErrNotImplemented
  • func (e *ErrNotImplemented) Error() string
• type T
  • func Native() T
  • func (t T) Bitness() Bitness

Constants

const (
	// Invalid describes an unknown architecture or an invalid enum value.
	Invalid T = "invalid"
	// AMD64 describes the amd64 architecture.
	AMD64 = "amd64"
	// I386 describes the i386 architecture.
	I386 = "i386"
)

Variables

var ErrInvalidBitness = fmt.Errorf("not a valid Bitness, try [%s]", strings.Join(_BitnessNames, ", "))

Functions

func BitnessNames

func BitnessNames() []string

BitnessNames returns a list of possible string values of Bitness.

Types

type Bitness

type Bitness int

Bitness describes the bitness of an architecture.

ENUM( invalid 32Bit = 32 64Bit = 64 )

const (
	// BitnessInvalid is a Bitness of type Invalid.
	BitnessInvalid Bitness = iota
	// Bitness32Bit is a Bitness of type 32Bit.
	Bitness32Bit Bitness = iota + 31
	// Bitness64Bit is a Bitness of type 64Bit.
	Bitness64Bit Bitness = iota + 62
)

func ParseBitness

func ParseBitness(name string) (Bitness, error)

ParseBitness attempts to convert a string to a Bitness.

func (Bitness) MarshalText

func (x Bitness) MarshalText() ([]byte, error)

MarshalText implements the text marshaller method.

func (Bitness) Short

func (b Bitness) Short() string

Short returns a short, human readable representation of a Bitness.

func (Bitness) String

func (x Bitness) String() string

String implements the Stringer interface.

func (*Bitness) UnmarshalText

func (x *Bitness) UnmarshalText(text []byte) error

UnmarshalText implements the text unmarshaller method.

type ErrNotImplemented

type ErrNotImplemented struct {
	Message string
}

func (*ErrNotImplemented) Error

func (e *ErrNotImplemented) Error() string

type T

type T string

T describes a CPU architecture.

func Native

func Native() T

Native returns the native architecture T of the running process.

func (T) Bitness

func (t T) Bitness() Bitness

Bitness returns the Bitness of the architecture.