parsecond

Documentation

Overview

Package parsecond parses the condition from the function documentation.

Index

• type Condition
  • func ToCondition(text string) (cond *Condition, err error)

Types

type Condition

type Condition struct {
	Label string

	// InitStr corresponds to initialization statement in conditions,
	// e.g., given
	// 	_, ok := someMap[3]; ok
	//
	// , the initialization is:
	//	_, ok := someMap[3]
	//
	// See https://golang.org/ref/spec#If_statements
	InitStr string

	CondStr string
	Cond    ast.Expr
}

Condition defines a pre- or a post-condition of the function's contract.

func ToCondition

func ToCondition(text string) (cond *Condition, err error)

ToCondition tries to parse the condition from text.

If no condition could be matched, cond is nil. Err is set if the text matched the bullet format, but there was an error parsing the condition.