catpogs

Documentation

Overview

Package catpogs provides Go struct equivalents of the Cap'n Proto catalog. These are primarily intended for constructing test inputs.

Index

• Constants
• type Catalog
  • func (c *Catalog) ToCapnp() (catalog.Catalog, error)
• type Command
• type EnvVar
• type Exec
• type ExecCondition
• type File
  • func Directory(path string, mode *FileMode) *File
  • func PlainFile(path string, content []byte) *File
  • func SymlinkFile(oldname, newname string) *File
• type FileMode
• type GroupRef
  • func GroupIDRef(gid int) *GroupRef
  • func GroupNameRef(name string) *GroupRef
• type Resource
• type UserRef
  • func UserIDRef(uid int) *UserRef
  • func UserNameRef(name string) *UserRef

Constants

const (
	ModeUnset  = catalog.File_Mode_unset
	ModePerm   = catalog.File_Mode_permMask
	ModeSticky = catalog.File_Mode_sticky
	ModeSetuid = catalog.File_Mode_setuid
	ModeSetgid = catalog.File_Mode_setgid
)

FileMode.Bits constants.

Types

type Catalog

type Catalog struct {
	Resources []*Resource
}

func (*Catalog) ToCapnp

func (c *Catalog) ToCapnp() (catalog.Catalog, error)

type Command

type Command struct {
	Which catalog.Exec_Command_Which
	Argv  []string
	Bash  string

	Env []EnvVar `capnp:"environment"`
	Dir string   `capnp:"workingDirectory"`
}

type EnvVar

type EnvVar struct {
	Name, Value string
}

type Exec

type Exec struct {
	Command   *Command
	Condition ExecCondition
}

type ExecCondition

type ExecCondition struct {
	Which         catalog.Exec_condition_Which
	OnlyIf        *Command
	Unless        *Command
	FileAbsent    string
	IfDepsChanged []uint64
}

type File

type File struct {
	Path string

	Which catalog.File_Which
	Plain struct {
		Content []byte
		Mode    *FileMode
	}
	Directory struct {
		Mode *FileMode
	}
	Symlink struct {
		Target string
	}
}

func Directory

func Directory(path string, mode *FileMode) *File

func PlainFile

func PlainFile(path string, content []byte) *File

func SymlinkFile

func SymlinkFile(oldname, newname string) *File

type FileMode

type FileMode struct {
	Bits  uint16
	User  *UserRef
	Group *GroupRef
}

type GroupRef

type GroupRef struct {
	Which catalog.GroupRef_Which
	ID    int32 `capnp:"id"`
	Name  string
}

func GroupIDRef

func GroupIDRef(gid int) *GroupRef

func GroupNameRef

func GroupNameRef(name string) *GroupRef

type Resource

type Resource struct {
	ID      uint64 `capnp:"id"`
	Comment string
	Deps    []uint64 `capnp:"dependencies"`

	Which catalog.Resource_Which
	File  *File
	Exec  *Exec
}

type UserRef

type UserRef struct {
	Which catalog.UserRef_Which
	ID    int32 `capnp:"id"`
	Name  string
}

func UserIDRef

func UserIDRef(uid int) *UserRef

func UserNameRef

func UserNameRef(name string) *UserRef