platform

Documentation

Index

• func Platforms() []string
• type Platform
  • func Actual() Platform
  • func Parse(p string) Platform
  • func ParseFlag(p *flag.Flag) Platform
  • func (p Platform) String() string

Functions

func Platforms

func Platforms() []string

Platforms returns the string array of the available Platforms.

Types

type Platform

type Platform uint32

Platform holds the available TLDR page platforms.

const (
	// UNKNOWN is for unknown platform type
	UNKNOWN Platform = iota
	// COMMON is a reference to the common directory of the TLDR page assets.
	COMMON
	// LINUX is a reference to the linux directory of the TLDR page assets.
	LINUX
	// OSX is a reference to the osx directory of the TLDR page assets.
	OSX
	// SUNOS is a reference to the sunos directory of the TLDR page assets.
	SUNOS
	// WINDOWS is a reference to the windows directory of the TLDR page assets.
	WINDOWS
)

func Actual

func Actual() Platform

Actual returns the runtime platform. If a valid platform is not found it it returns COMMON.

func Parse

func Parse(p string) Platform

Parse returns the Platform if valid. If the provided platform is not valid it returns an UNKNOWN platform.

func ParseFlag

func ParseFlag(p *flag.Flag) Platform

ParseFlag parses the provided command line platform Flag

func (Platform) String

func (p Platform) String() string

Strings provides the string based representation of the Platform