utils

package

v0.0.3 Latest Latest Go to latest Published: Aug 24, 2021 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation ¶

This section is empty.

This section is empty.

This section is empty.

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

InputParam is a parameter used for input. If the name is a "-" it will use the commands stdin.

func NewInputParam() InputParam

NewInputParam creates a new InputParam.

func (o InputParam) AddFlag(cmd *cobra.Command, name, defaultVal, description string)

AddFlag will add the param to a command

func (o InputParam) Close() error

Close will close the param's input source if applicable.

func (o InputParam) FromFile() error

FromFile initializes the param from a filepath using o.Name

func (o InputParam) Init(cmd *cobra.Command, args []string) error

Init is a function that sets up the parameter with the intended source.

func (o *InputParam) Read(p []byte) (int, error)

Read reads from the parameters's source

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

OutputParam is a parameter used for output. If the name is a "-" it will use the commands stdout.

func NewOutputParam() OutputParam

NewOutputParam creates a new InputParam.

func (o OutputParam) AddFlag(cmd *cobra.Command, name, defaultVal, description string)

AddFlag will add the param to a command

func (o OutputParam) Close() error

Close will close the param's input source if applicable.

func (o OutputParam) FromFile() error

FromFile initializes the param from a filepath using o.Name

func (o OutputParam) Init(cmd *cobra.Command, args []string) error

Init is a function that sets up the parameter with the intended source.

func (o *OutputParam) Write(p []byte) (int, error)

Write writes to the parameters's source.