platform

Documentation

Overview

Package platform defines known platforms

Package platform handles stdin processing

Index

• Variables
• func ConfirmYesNoPrompt(prompt string) (bool, error)
• func GetUserInputPassword(interactive bool) ([]byte, error)
• func IsInputFromPipe() bool
• func PathExists(file string) bool
• func ReadInteractivePassword() (string, error)
• func Stdin(one bool) (string, error)
• type System
  • func NewSystem(candidate string) (System, error)
• type SystemTypes
  • func (p SystemTypes) List() []string

Variables

var Systems = SystemTypes{
	MacOSSystem:        "macos",
	LinuxWaylandSystem: "linux-wayland",
	LinuxXSystem:       "linux-x",
	WindowsLinuxSystem: "wsl",
}

Systems are the known platforms for lockbox

Functions

func ConfirmYesNoPrompt

func ConfirmYesNoPrompt(prompt string) (bool, error)

ConfirmYesNoPrompt will ask a yes/no question.

func GetUserInputPassword

func GetUserInputPassword(interactive bool) ([]byte, error)

GetUserInputPassword will read the user's input from stdin via multiple means.

func IsInputFromPipe

func IsInputFromPipe() bool

IsInputFromPipe will indicate if connected to stdin pipe.

func PathExists

func PathExists(file string) bool

PathExists indicates whether a path exists (true) or not (false)

func ReadInteractivePassword

func ReadInteractivePassword() (string, error)

ReadInteractivePassword will prompt for a single password for unlocking

func Stdin

func Stdin(one bool) (string, error)

Stdin will get one (or more) lines of stdin as a string.

Types

type System

type System string

System represents the platform lockbox is running on.

func NewSystem

func NewSystem(candidate string) (System, error)

NewSystem gets a new system platform.

type SystemTypes

type SystemTypes struct {
	MacOSSystem        System
	LinuxWaylandSystem System
	LinuxXSystem       System
	WindowsLinuxSystem System
}

SystemTypes defines systems lockbox is known to run on or can run on

func (SystemTypes) List

func (p SystemTypes) List() []string

List will list the platform types on the struct