HostKit.Conventions (host_kit v0.1.0-beta.5)

Project-level naming and path conventions.

Summary

t()

Returns the root used for rollback backup payloads.

new(attrs \\ [])

Returns the root used for minimal HostKit run records.

Returns the HostKit state root, defaulting to /var/lib/hostkit.

Returns the root used for workspace service directories.

@type t() :: %HostKit.Conventions{
  prefixes: %{optional(atom()) => String.t()},
  roots: %{optional(atom()) => String.t()}
}

@spec backups_root(t() | map()) :: String.t()

Returns the root used for rollback backup payloads.

@spec new(keyword() | map()) :: t()

@spec prefixed(t() | map(), atom(), term()) :: String.t()

@spec put_prefix(t(), atom(), String.t()) :: t()

@spec put_root(t(), atom(), String.t()) :: t()

@spec root(t() | map(), atom(), String.t()) :: String.t()

@spec root!(t() | map(), atom()) :: String.t()

@spec runs_root(t() | map()) :: String.t()

Returns the root used for minimal HostKit run records.

@spec state_root(t() | map()) :: String.t()

Returns the HostKit state root, defaulting to /var/lib/hostkit.

@spec workspaces_root(t() | map()) :: String.t()

Returns the root used for workspace service directories.