bash

Documentation

Index

• Variables
• type Decoder
  • func NewDecoder(r io.Reader) *Decoder
  • func (d *Decoder) Decode(v interface{}) error
• type Encoder
  • func NewEncoder(w io.Writer) *Encoder
  • func (e *Encoder) Encode(v interface{}) error
• type File
• type Line
• type LineError
  • func (le LineError) Error() string
• type LineType

Variables

var ErrInvalidReceiver = fmt.Errorf("receiver must be compatible with *File")

ErrInvalidReceiver is raised when an invalid receiver is provided

var ErrNullReceiver = fmt.Errorf("receiver must not be null")

ErrNullReceiver is raised when a null receiver is provided

Types

type Decoder

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

Decoder implements parser.Decoder

func NewDecoder

func NewDecoder(r io.Reader) *Decoder

NewDecoder implements parser.T

func (*Decoder) Decode

func (d *Decoder) Decode(v interface{}) error

Decode is the main function of the parser.Decoder interface

type Encoder

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

Encoder implements parser.Encoder

func NewEncoder

func NewEncoder(w io.Writer) *Encoder

NewEncoder implements parser.T

func (*Encoder) Encode

func (e *Encoder) Encode(v interface{}) error

Encode is the main function of the parser.Encoder interface

type File

type File struct {
	Lines []*Line
}

File represents a bash file

type Line

type Line struct {
	// Type of line
	Type LineType

	// Components of the line
	//
	// When Type = ASSIGNMENT :
	//  [0] = indentation (spaces and tabs)
	//  [1] = variable name
	//  [2] = variable value
	//  [3] = comment (optional)
	Components []string
}

Line represents a meaningful line

type LineError

type LineError struct {
	Line int
	Err  error
}

LineError wraps errors with a line index

func (LineError) Error

func (le LineError) Error() string

Error implements Error

type LineType

type LineType byte

LineType enumerates available line types

const (
	// ANY is the default line type (all except assignments)
	ANY LineType = iota
	// ASSIGNMENT line
	ASSIGNMENT
)