pids

Documentation

Overview

Package pids provides a typed process identifier.

Index

• type Pid
  • func ConvertToPid[T constraints.Integer](pid T) (typedPid Pid, err error)
  • func NewPid(u32 uint32) (pid Pid)
  • func NewPid1[T constraints.Integer](pid T) (typedPid Pid)
  • func (pid Pid) Int() (pidInt int)
  • func (pid Pid) IsNonZero() (isValid bool)
  • func (pid Pid) String() (s string)
  • func (pid Pid) Uint32() (pidUint32 uint32)

Types

type Pid

type Pid uint32

Pid is a unique named type for process identifiers

• Pid implements fmt.Stringer
• Pid is constraints.Ordered
• Pid has Pid.IsNonZero Pid.Int Pid.Uint32 methods

func ConvertToPid

func ConvertToPid[T constraints.Integer](pid T) (typedPid Pid, err error)

ConvertToPid returns a typed value process identifier from any Integer type

func NewPid

func NewPid(u32 uint32) (pid Pid)

NewPid returns a process identifier based on a 32-bit integer

func NewPid1

func NewPid1[T constraints.Integer](pid T) (typedPid Pid)

NewPid1 returns a typed value process identifier panicking on error

func (Pid) Int

func (pid Pid) Int() (pidInt int)

Int converts a process identifier to a platform-specific sized int

func (Pid) IsNonZero

func (pid Pid) IsNonZero() (isValid bool)

IsNonZero returns whether trhe process identifier contains a valid process ID

func (Pid) String

func (pid Pid) String() (s string)

func (Pid) Uint32

func (pid Pid) Uint32() (pidUint32 uint32)

Uint32 converts a process identifier to a 32-bit unsigned integer