files

Documentation

Overview

Package files is an internal package of twtr/cmd.

It provides helpers to access the file system.

Index

• func Create(file string) (io.ReadWriteCloser, error)
• func Edit(file string) error
• func Exists(file string) (bool, error)
• func Open(file string) (io.ReadWriteCloser, error)

Functions

func Create

func Create(file string) (io.ReadWriteCloser, error)

Create file with read/write permissions, useful for creating a new twtxt.txt file (or overwriting) to write to.

func Edit

func Edit(file string) error

Edit a file in the system EDITOR, uses VISUAL over EDITOR if set.

Equivalent to:

$ sh -c "${VISUAL:-$EDITOR} <file>"

Returns any errors that occur.

func Exists

func Exists(file string) (bool, error)

Exists reports if the given file exists, or any error that it encounters while checking.

func Open

func Open(file string) (io.ReadWriteCloser, error)

Open file with read/write permissions, useful for opening a twtxt.txt file to write to.