click

Documentation

Overview

Package click exposes some utilities related to click packages and wraps libclick to check if packages are installed.

Index

• Variables
• type AppId
  • func ParseAndVerifyAppId(id string, installedChecker InstalledChecker) (*AppId, error)
  • func ParseAppId(id string) (*AppId, error)
  • func (app *AppId) Base() string
  • func (app *AppId) DesktopId() string
  • func (app *AppId) DispatchPackage() string
  • func (app *AppId) Icon() string
  • func (app *AppId) InPackage(pkgname string) bool
  • func (app *AppId) MarshalJSON() ([]byte, error)
  • func (app *AppId) Original() string
  • func (app *AppId) String() string
  • func (app *AppId) SymbolicIcon() string
  • func (app *AppId) UnmarshalJSON(s []byte) error
  • func (app *AppId) Versioned() string
• type ClickUser
  • func User() (*ClickUser, error)
  • func (cu *ClickUser) Installed(app *AppId, setVersion bool) bool
• type InstalledChecker

Variables

var (
	ErrInvalidAppId = errors.New("invalid application id")
	ErrMissingApp   = errors.New("application not installed")
)

Types

type AppId

type AppId struct {
	Package     string
	Application string
	Version     string
	Click       bool
	// contains filtered or unexported fields
}

AppId holds a parsed application id.

func ParseAndVerifyAppId

func ParseAndVerifyAppId(id string, installedChecker InstalledChecker) (*AppId, error)

ParseAndVerifyAppId parses the given app id and checks if the corresponding app is installed, returning the parsed id or ErrInvalidAppId, or the parsed id and ErrMissingApp respectively.

func ParseAppId

func ParseAppId(id string) (*AppId, error)

func (*AppId) Base

func (app *AppId) Base() string

func (*AppId) DesktopId

func (app *AppId) DesktopId() string

func (*AppId) DispatchPackage

func (app *AppId) DispatchPackage() string

func (*AppId) Icon

func (app *AppId) Icon() string

func (*AppId) InPackage

func (app *AppId) InPackage(pkgname string) bool

func (*AppId) MarshalJSON

func (app *AppId) MarshalJSON() ([]byte, error)

func (*AppId) Original

func (app *AppId) Original() string

func (*AppId) String

func (app *AppId) String() string

func (*AppId) SymbolicIcon

func (app *AppId) SymbolicIcon() string

func (*AppId) UnmarshalJSON

func (app *AppId) UnmarshalJSON(s []byte) error

func (*AppId) Versioned

func (app *AppId) Versioned() string

type ClickUser

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

ClickUser exposes the click package registry for the user.

func User

func User() (*ClickUser, error)

User makes a new ClickUser object for the current user.

func (*ClickUser) Installed

func (cu *ClickUser) Installed(app *AppId, setVersion bool) bool

Installed checks if the appId is installed for user, optionally setting the version if it was absent.

type InstalledChecker

type InstalledChecker interface {
	Installed(app *AppId, setVersion bool) bool
}