linkfile

package

v0.10.0 Latest Latest Go to latest Published: May 7, 2021 License: GPL-3.0 Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

View Source

const RefLinkHiddenFilename = ".qri-ref"

RefLinkHiddenFilename is the filename for a hidden reference linkfile

View Source

const RefLinkTextFilename = "qri-ref.txt"

RefLinkTextFilename is the filename for a reference linkfile

This section is empty.

func ExistsInDir(dir string) bool

ExistsInDir returns whether a linkfile exists in the directory

func Read(filename string) (dsref.Ref, error)

Read reads a reference from a linkfile with the given filename

func WriteHiddenInDir(dir string, ref dsref.Ref) (string, error)

WriteHiddenInDir writes a reference to a hidden linkfile in the given directory

func WriteRef(w io.Writer, ref dsref.Ref)

WriteRef writes a reference to the given io.Writer

func WriteTextInDir(dir string, ref dsref.Ref) (string, error)

WriteTextInDir writes a reference to a visible linkfile in the given directory

This section is empty.