read

Documentation

Index

• func New(root *file.Root) tool.Tool
• func Render(args Args) (string, string)
• type Args

Functions

func New

func New(root *file.Root) tool.Tool

New builds the read tool confined to root.

func Render

func Render(args Args) (string, string)

Render describes a read as the path, qualified by the lines it asks for.

Types

type Args

type Args struct {
	Path   string `json:"path"`   // the file to read
	Offset int    `json:"offset"` // the first line
	Limit  int    `json:"limit"`  // the most lines to return
}

Args is what a read takes. An absent offset or limit is zero, which means the whole file.