system

package

v1.6.3-v1.27.5-k3s1 Latest Latest Go to latest Published: Oct 30, 2023 License: Apache-2.0 Imports: 7 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

Repository

github.com/1898andCo/HAOS

Documentation ¶

Overview ¶

Package system abstracts the filesystem layout of the system and exposes functions to copy and move files

Index ¶

Constants
Variables
func CopyComponent(src, dst string, remount bool, key string) (bool, error)
func DataPath(elem ...string) string
func LocalPath(elem ...string) string
func RootPath(elem ...string) string
func StatComponentVersion(root, key string, alias VersionName) (os.FileInfo, error)
func StatePath(elem ...string) string
type VersionName

Constants ¶

View Source

const (
	// DefaultRootDir represents where persistent installations are located
	DefaultRootDir = "/HAOS/system"
	// DefaultDataDir represents where persistent state is located
	DefaultDataDir = "/HAOS/data"
	// DefaultLocalDir represents where local, persistent configuration is located
	DefaultLocalDir = "/var/lib/1898andCo/haos"
	// DefaultStateDir represents where ephemeral state is located
	DefaultStateDir = "/run/HAOS"
)

Variables ¶

View Source

var (
	AppFs = afero.NewOsFs()
)

Functions ¶

func CopyComponent ¶

func CopyComponent(src, dst string, remount bool, key string) (bool, error)

CopyComponent will copy the component identified by `key` from `src` to `dst`, moving the `current` symlink to the version from `src` (after renaming `current` to `previous`).

func DataPath ¶

func DataPath(elem ...string) string

DataPath joins any number of elements into a single path underneath the persistent state root, by default `DefaultDataDir`

func LocalPath ¶

func LocalPath(elem ...string) string

LocalPath joins any number of elements into a single path underneath the persistent configuration root, by default `DefaultLocalDir`

func RootPath ¶

func RootPath(elem ...string) string

RootPath joins any number of elements into a single path underneath the persistent installation root, by default `DefaultRootDir`

func StatComponentVersion ¶

func StatComponentVersion(root, key string, alias VersionName) (os.FileInfo, error)

StatComponentVersion will de-reference the version symlink for the component.

func StatePath ¶

func StatePath(elem ...string) string

StatePath joins any number of elements into a single path underneath the ephemeral state root, by default `DefaultStateDir`

Types ¶

type VersionName ¶

type VersionName string

const (
	VersionCurrent  VersionName = "current"
	VersionPrevious VersionName = "previous"
)

Source Files ¶

View all Source files

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