utils

package

v0.13.1 Latest Latest Go to latest Published: Mar 13, 2025 License: Apache-2.0 Imports: 10 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/256dpi/naos

Documentation ¶

Overview ¶

Package utils provides some small utility functions.

Index ¶

func Apply(repo, patch string, out io.Writer) error
func Clone(repo, path, commit string, ignoredSubmodules []string, out io.Writer) error
func Download(destination, source string) error
func Ensure(path, content string, force bool) error
func Exists(path string) (bool, error)
func Fetch(path, commit string, ignoredSubmodules []string, out io.Writer) error
func FindPort(out io.Writer) string
func IsDir(path string) (bool, error)
func Link(path, target string) error
func Log(out io.Writer, msg string)
func Original(path, name string) (string, error)
func Resolve(path, base string) (string, error)
func Sync(src, dst string) error
func Update(path, content string) error
type Port
- func ListPorts() ([]Port, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Apply ¶ added in v0.11.0

func Apply(repo, patch string, out io.Writer) error

Apply will apply the specified patch to the provided repository.

func Clone ¶

func Clone(repo, path, commit string, ignoredSubmodules []string, out io.Writer) error

Clone will check out the provided repository set it to the specified version and properly checkout all submodules.

func Download ¶

func Download(destination, source string) error

Download will download the specified source to the specified destination.

func Ensure ¶ added in v0.13.0

func Ensure(path, content string, force bool) error

Ensure will create a file with the provided content if it does not exist. If force is set to true, an existing file will be overwritten.

func Exists ¶

func Exists(path string) (bool, error)

Exists will check if the provided file or directory exists.

func Fetch ¶

func Fetch(path, commit string, ignoredSubmodules []string, out io.Writer) error

Fetch will update the remote repository and update all submodules accordingly.

func FindPort ¶ added in v0.8.2

func FindPort(out io.Writer) string

FindPort will return the fist known USB serial port or an empty string.

func IsDir ¶ added in v0.13.0

func IsDir(path string) (bool, error)

IsDir will check if the provided path is a directory.

func Link ¶ added in v0.8.4

func Link(path, target string) error

Link will ensure a link with the specified target at the provided path.

func Log ¶

func Log(out io.Writer, msg string)

Log will format and write the provided message to out if available.

func Original ¶ added in v0.10.0

func Original(path, name string) (string, error)

Original will return the original, unmodified contents of the specified file.

func Resolve ¶ added in v0.8.4

func Resolve(path, base string) (string, error)

Resolve will resolve a path and us the provided base for relative paths.

func Sync ¶ added in v0.8.3

func Sync(src, dst string) error

Sync will synchronize the two files. It will only copy if the destination is absent or differs.

func Update ¶ added in v0.10.1

func Update(path, content string) error

Update will write a file if the contents have changed.

Types ¶

type Port ¶ added in v0.13.0

type Port struct {
	Path string
}

Port represents a USB serial port.

func ListPorts ¶ added in v0.13.0

func ListPorts() ([]Port, error)

ListPorts will return a list of all known USB serial ports.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL