donut

Documentation

Index

• func BytesFromConfig(srcFile string, config *donut.DonutConfig) (*bytes.Buffer, error)
• func GetDonutConfig(options map[string]string) (*donut.DonutConfig, error)
• func GetDonutDefaultConfig() *donut.DonutConfig
• func Parse(options map[string]string) ([]string, error)

Functions

func BytesFromConfig

func BytesFromConfig(srcFile string, config *donut.DonutConfig) (*bytes.Buffer, error)

BytesFromConfig takes a donut configuration and a file path to an executable as inputs and returns the donut payload as a bytes buffer

func GetDonutConfig

func GetDonutConfig(options map[string]string) (*donut.DonutConfig, error)

GetDonutConfig parses a map of options and returns a donut config structure

func GetDonutDefaultConfig

func GetDonutDefaultConfig() *donut.DonutConfig

GetDonutDefaultConfig returns a default DonutConfig structure

func Parse

func Parse(options map[string]string) ([]string, error)

Parse is the initial entry point for all extended modules. All validation checks and processing will be performed here The function input types are limited to strings and therefore require additional processing