indexscanner

Documentation

Index

• func LoadPluginByName(pluginsDir, pluginName string) (index.Plugin, error)
• func LoadPluginListFromFS(indexDir string) ([]index.Plugin, error)
• func ReadPlugin(f io.ReadCloser) (index.Plugin, error)
• func ReadPluginFromFile(path string) (index.Plugin, error)
• func ReadReceiptFromFile(path string) (index.Receipt, error)

Functions

func LoadPluginByName

func LoadPluginByName(pluginsDir, pluginName string) (index.Plugin, error)

LoadPluginByName loads a plugins index file by its name. When plugin file not found, it returns an error that can be checked with os.IsNotExist.

func LoadPluginListFromFS

func LoadPluginListFromFS(indexDir string) ([]index.Plugin, error)

LoadPluginListFromFS will parse and retrieve all plugin files.

func ReadPlugin

func ReadPlugin(f io.ReadCloser) (index.Plugin, error)

func ReadPluginFromFile

func ReadPluginFromFile(path string) (index.Plugin, error)

ReadPluginFromFile loads a file from the FS. When plugin file not found, it returns an error that can be checked with os.IsNotExist.

func ReadReceiptFromFile

func ReadReceiptFromFile(path string) (index.Receipt, error)

ReadReceiptFromFile loads a file from the FS. When receipt file not found, it returns an error that can be checked with os.IsNotExist.