atv

Documentation

Overview

Package atv functions to read, write and manipulate ATV files containing a mGuard configuration.

Index

• Variables
• type AccessModifier
  • func ParseAccessModifier(s string) (AccessModifier, error)
  • func (access AccessModifier) String() string
• type File
  • func FromFile(path string) (*File, error)
  • func FromReader(reader io.Reader) (*File, error)
  • func (file *File) Dupe() *File
  • func (file *File) GetAccess(name string) (*AccessModifier, error)
  • func (file *File) GetPragma(name string) (*string, error)
  • func (file *File) GetRowIDs() ([]RowID, error)
  • func (file *File) GetRowReferences() ([]RowRef, error)
  • func (file *File) GetSetting(settingName string) (string, error)
  • func (file *File) GetUUID(name string) (*UUID, error)
  • func (file *File) GetVersion() (Version, error)
  • func (file *File) Merge(other *File) (*File, error)
  • func (file *File) MergeSelectively(other *File, config *MergeConfiguration) (*File, error)
  • func (file *File) Migrate(targetVersion Version) (*File, error)
  • func (file *File) RemoveAccess(name string) error
  • func (file *File) RemoveUUID(name string) error
  • func (file *File) SetAccess(name string, access AccessModifier) error
  • func (file *File) SetPragma(name string, value string) error
  • func (file *File) SetUUID(name string, uuid UUID) error
  • func (file *File) SetVersion(version Version) error
  • func (file *File) String() string
  • func (file *File) ToFile(path string) error
  • func (file *File) ToWriter(writer io.Writer) error
• type MergeConfiguration
  • func LoadMergeConfiguration(path string) (*MergeConfiguration, error)
  • func (cfg *MergeConfiguration) ShouldMergeSetting(path documentSettingPath) bool
• type RowID
• type RowRef
• type UUID
• type Version
  • func (version Version) Compare(other Version) int
  • func (version Version) String() string

Variables

var ErrNilReceiver = fmt.Errorf("The receiver is nil")

ErrNilReceiver is an error that is issued if a function is called with a nil receiver.

Types

type AccessModifier

type AccessModifier int

AccessModifier influences the access of a setting in an ATV document.

const (
	// MustNotOverwrite indicates that a setting must not be overwritten.
	MustNotOverwrite AccessModifier = iota

	// MayOverwrite indicates that a setting may be overwritten.
	MayOverwrite

	// MustOverwrite indicates that a setting must be overwritten.
	MustOverwrite

	// MayAppend indicates that a setting can be extended by appending additional rows (table values only).
	MayAppend

	// DefaultAccessModifier is the access modifier that applys, if no access modifier is specified (for internal use only).
	DefaultAccessModifier
)

func ParseAccessModifier

func ParseAccessModifier(s string) (AccessModifier, error)

ParseAccessModifier parses the specified string as an access modifier.

func (AccessModifier) String

func (access AccessModifier) String() string

String returns the string representation of the access modifier.

type File

type File struct {
	// contains filtered or unexported fields
}

File represents a mGuard configuration file.

func FromFile

func FromFile(path string) (*File, error)

FromFile reads the specified ATV file from disk.

func FromReader

func FromReader(reader io.Reader) (*File, error)

FromReader reads an ATV document from the specified io.Reader.

func (*File) Dupe

func (file *File) Dupe() *File

Dupe returns a copy of the ATV document.

func (*File) GetAccess

func (file *File) GetAccess(name string) (*AccessModifier, error)

GetAccess gets the access modifier of the setting with the specified name.

func (*File) GetPragma

func (file *File) GetPragma(name string) (*string, error)

GetPragma returns the value of the pragma with the specified name.

func (*File) GetRowIDs

func (file *File) GetRowIDs() ([]RowID, error)

GetRowIDs returns all row ids recursively.

func (*File) GetRowReferences

func (file *File) GetRowReferences() ([]RowRef, error)

GetRowReferences returns all row references recursively.

func (*File) GetSetting

func (file *File) GetSetting(settingName string) (string, error)

GetSetting gets the setting with the specified name.

func (*File) GetUUID

func (file *File) GetUUID(name string) (*UUID, error)

GetUUID gets the UUID of the setting with the specified name.

func (*File) GetVersion

func (file *File) GetVersion() (Version, error)

GetVersion gets the version of the document.

func (*File) Merge

func (file *File) Merge(other *File) (*File, error)

Merge merges all settings from the specified ATV document into the current one.

func (*File) MergeSelectively

func (file *File) MergeSelectively(other *File, config *MergeConfiguration) (*File, error)

MergeSelectively merges the specified settings from the specified ATV document into the current one.

func (*File) Migrate

func (file *File) Migrate(targetVersion Version) (*File, error)

Migrate migrates the ATV file to the specified version (upwards only).

func (*File) RemoveAccess

func (file *File) RemoveAccess(name string) error

RemoveAccess removes the access modifier of the setting with the specified name.

func (*File) RemoveUUID

func (file *File) RemoveUUID(name string) error

RemoveUUID removes the UUID of the setting with the specified name.

func (*File) SetAccess

func (file *File) SetAccess(name string, access AccessModifier) error

SetAccess sets the access modifier of the setting with the specified name.

func (*File) SetPragma

func (file *File) SetPragma(name string, value string) error

SetPragma sets the value of the pragma with the specified name.

func (*File) SetUUID

func (file *File) SetUUID(name string, uuid UUID) error

SetUUID sets the UUID of the setting with the specified name.

func (*File) SetVersion

func (file *File) SetVersion(version Version) error

SetVersion sets the version of the document. This should only be done after a migration step to keep the document structure and the version number consistent.

func (*File) String

func (file *File) String() string

String returns a properly formatted string representation of the ATV document.

func (*File) ToFile

func (file *File) ToFile(path string) error

ToFile saves the ATV document to the specified file.

func (*File) ToWriter

func (file *File) ToWriter(writer io.Writer) error

ToWriter writes the ATV document to the specified io.Writer.

type MergeConfiguration

type MergeConfiguration struct {
	// contains filtered or unexported fields
}

MergeConfiguration defines which settings should be merged from one ATV document into another.

func LoadMergeConfiguration

func LoadMergeConfiguration(path string) (*MergeConfiguration, error)

LoadMergeConfiguration loads a merge configuration file.

func (*MergeConfiguration) ShouldMergeSetting

func (cfg *MergeConfiguration) ShouldMergeSetting(path documentSettingPath) bool

ShouldMergeSetting indicates whether the specified setting should be merged.

type RowID

type RowID string

RowID is the id of a table row in an ATV document.

type RowRef

type RowRef string

RowRef represents a reference to a table row.

type UUID

type UUID string

UUID represents a UUID associated with a setting.

type Version

type Version struct {
	Major  int
	Minor  int
	Patch  int
	Suffix string
}

Version represents the version of an ATV document.

func (Version) Compare

func (version Version) Compare(other Version) int

Compare compares the current version with the specified one. Returns -1, if the current version is less than the specified one. Returns 0, if the current version equals the current one. Returns +1, if the current version is greater than the specified one.

func (Version) String

func (version Version) String() string

String returns the version as a string.