capabilities

Documentation

Overview

Package capabilities maintain global capabilities

Scan() use registered scanners functions to update capabilities list, then store this capabilities list on filesystem.

Has(cap) use capabilities file to verify if cap exists

A global list of registered scanner functions may be Registered to scanner list. Registered scanners are called to refresh capabilities during Scan()

Index

• Variables
• func Has(cap string) bool
• func Register(s scanner)
• func Scan() error
• func SetCacheFile(s string)
• type L
  • func Data() L
  • func Load() (loadedCaps L, err error)
  • func (t L) Render() string

Variables

var (
	// ErrorNeedScan error mean capabilities needs scan
	ErrorNeedScan = errors.New("capabilities not yet scanned")
)

Functions

func Has

func Has(cap string) bool

Has return true if capability cap exists

func Register

func Register(s scanner)

Register add new s scanner function to scanners list

func Scan

func Scan() error

Scan refresh capabilities from the scanners function calls, then it update capabilities list stored on file system

func SetCacheFile

func SetCacheFile(s string)

Types

type L

type L []string

L is a list of capabilities expressed as strings

func Data

func Data() L

Data return copy of capabilities

func Load

func Load() (loadedCaps L, err error)

Load fetch existing capabilities from its backend file

func (L) Render

func (t L) Render() string

Render is a human rendered for node capabilities