snap

Documentation

Index

• func RegisterFormat(magic []byte, open func(fn string) (File, error))
• func ValidateName(name string) error
• type File
  • func Open(path string) (File, error)
• type Info
  • func InfoFromSnapYaml(yamlData []byte) (*Info, error)
• type Type
  • func (m Type) MarshalJSON() ([]byte, error)
  • func (m *Type) UnmarshalJSON(data []byte) error

Functions

func RegisterFormat

func RegisterFormat(magic []byte, open func(fn string) (File, error))

RegisterFormat registers a snap file format to the system

func ValidateName

func ValidateName(name string) error

ValidateName checks if a string can be used as a snap name.

Types

type File

type File interface {
	Install(targetDir string) error

	// MetaMember returns data from a meta/ directory file member
	MetaMember(name string) ([]byte, error)

	//Unpack unpacks the src parts to the dst directory
	Unpack(src, dst string) error

	// Info returns information about the given snap file
	Info() (*Info, error)
}

File is the interface to interact with the low-level snap files

func Open

func Open(path string) (File, error)

Open opens a given snap file with the right backend

type Info

type Info struct {
	Name    string
	Version string
	Type    Type
}

Info provides information about packages

func InfoFromSnapYaml

func InfoFromSnapYaml(yamlData []byte) (*Info, error)

InfoFromSnapYaml creates a new info based on the given snap.yaml data

type Type

type Type string

Type represents the kind of snap (app, core, frameworks, gadget)

const (
	TypeApp       Type = "app"
	TypeCore      Type = "core"
	TypeFramework Type = "framework"
	TypeGadget    Type = "gadget"
	TypeOS        Type = "os"
	TypeKernel    Type = "kernel"
)

The various types of snap parts we support

func (Type) MarshalJSON

func (m Type) MarshalJSON() ([]byte, error)

MarshalJSON returns *m as the JSON encoding of m.

func (*Type) UnmarshalJSON

func (m *Type) UnmarshalJSON(data []byte) error

UnmarshalJSON sets *m to a copy of data.