gocontracts

Documentation

Index

• func Process(text string, filename string, remove bool) (updated string, err error)
• func ProcessFile(pth string, remove bool) (updated string, err error)
• func ProcessInPlace(pth string, remove bool) (err error)

Functions

func Process

func Process(text string, filename string, remove bool) (updated string, err error)

Process automatically adds (or updates) the blocks for checking the pre and postconditions. If remove is set, the code to check the conditions is removed, but the conditions are left untouched in the comment.

func ProcessFile

func ProcessFile(pth string, remove bool) (updated string, err error)

ProcessFile loads the Go file and processes it. If remove is set, the code to check the conditions is removed, but the conditions are left untouched in the comment.

func ProcessInPlace

func ProcessInPlace(pth string, remove bool) (err error)

ProcessInPlace loads the Go file in memory, proesses it and writes atomically back to the file. If remove is set, the code to check the conditions is removed, but the conditions are left untouched in the comment.