object_inventory_format

Documentation

Index

• Constants
• Variables
• func GetShasForMetadata(m *Metadata) (shas map[string]*sha.Sha, err error)
• func WriteMetadataKeyTo(w io.Writer, c FormatterContext, key *catgut.String) (n int64, err error)
• type Format
  • func Default() Format
  • func FormatForVersion(sv interfaces.StoreVersion) Format
  • func FormatForVersions(write, read interfaces.StoreVersion) Format
  • func MakeBespoke(f Formatter, p Parser) Format
• type FormatGeneric
  • func FormatForKey(k string) FormatGeneric
  • func FormatForKeyError(k string) (fo FormatGeneric, err error)
  • func (f FormatGeneric) WriteMetadataTo(w io.Writer, c FormatterContext) (n int64, err error)
• type Formatter
• type FormatterContext
• type Metadata
• type Options
  • func (o Options) SansVerzeichnisse() Options
• type Parser
• type ParserContext
• type Sha
  • func GetShaForContext(f FormatGeneric, c FormatterContext) (sh *Sha, err error)
  • func GetShaForContextDebug(f FormatGeneric, c FormatterContext) (sh *Sha, err error)
  • func GetShaForMetadata(f FormatGeneric, m *Metadata) (sh *Sha, err error)
  • func WriteMetadata(w io.Writer, f FormatGeneric, c FormatterContext) (sh *Sha, err error)

Constants

const (
	KeyFormatV5Metadata               = "Metadatei"
	KeyFormatV5MetadataWithoutTai     = "MetadateiSansTai"
	KeyFormatV5MetadataObjectIdParent = "MetadateiKennungMutter"
	KeyFormatV6Metadata               = "Metadata"
	KeyFormatV6MetadataWithoutTai     = "MetadataWithoutTai"
	KeyFormatV6MetadataObjectIdParent = "MetadataObjectIdParent"
)

Variables

var (
	FormatKeys = []string{
		KeyFormatV5Metadata,
		KeyFormatV5MetadataWithoutTai,
		KeyFormatV5MetadataObjectIdParent,
		KeyFormatV6Metadata,
		KeyFormatV6MetadataWithoutTai,
		KeyFormatV6MetadataObjectIdParent,
	}

	FormatKeysV5 = []string{
		KeyFormatV5Metadata,
		KeyFormatV5MetadataWithoutTai,
		KeyFormatV5MetadataObjectIdParent,
	}

	FormatKeysV6 = []string{
		KeyFormatV6Metadata,
		KeyFormatV6MetadataWithoutTai,
		KeyFormatV6MetadataObjectIdParent,
	}
)

var ErrEmptyTai = errors.New("empty tai")

var (
	ErrV4ExpectedSpaceSeparatedKey = errors.New("expected space separated key")
)

var Formats formats

Functions

func GetShasForMetadata

func GetShasForMetadata(m *Metadata) (shas map[string]*sha.Sha, err error)

func WriteMetadataKeyTo

func WriteMetadataKeyTo(
	w io.Writer,
	c FormatterContext,
	key *catgut.String,
) (n int64, err error)

Types

type Format

type Format interface {
	Formatter
	Parser
}

func Default

func Default() Format

func FormatForVersion

func FormatForVersion(sv interfaces.StoreVersion) Format

func FormatForVersions

func FormatForVersions(write, read interfaces.StoreVersion) Format

func MakeBespoke

func MakeBespoke(f Formatter, p Parser) Format

type FormatGeneric

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

func FormatForKey

func FormatForKey(k string) FormatGeneric

func FormatForKeyError

func FormatForKeyError(k string) (fo FormatGeneric, err error)

func (FormatGeneric) WriteMetadataTo

func (f FormatGeneric) WriteMetadataTo(
	w io.Writer,
	c FormatterContext,
) (n int64, err error)

type Formatter

type Formatter interface {
	FormatPersistentMetadata(
		io.Writer,
		FormatterContext,
		Options,
	) (int64, error)
}

type FormatterContext

type FormatterContext interface {
	object_metadata.PersistentFormatterContext
	GetObjectId() *ids.ObjectId
}

type Metadata

type Metadata = object_metadata.Metadata

type Options

type Options struct {
	Tai           bool
	ExcludeMutter bool
	Verzeichnisse bool
	PrintFinalSha bool
}

func (Options) SansVerzeichnisse

func (o Options) SansVerzeichnisse() Options

type Parser

type Parser interface {
	ParsePersistentMetadata(
		*catgut.RingBuffer,
		ParserContext,
		Options,
	) (int64, error)
}

type ParserContext

type ParserContext interface {
	object_metadata.PersistentParserContext
	SetObjectIdLike(ids.IdLike) error
}

type Sha

type Sha = sha.Sha

func GetShaForContext

func GetShaForContext(f FormatGeneric, c FormatterContext) (sh *Sha, err error)

func GetShaForContextDebug

func GetShaForContextDebug(
	f FormatGeneric,
	c FormatterContext,
) (sh *Sha, err error)

func GetShaForMetadata

func GetShaForMetadata(f FormatGeneric, m *Metadata) (sh *Sha, err error)

func WriteMetadata

func WriteMetadata(w io.Writer, f FormatGeneric, c FormatterContext) (sh *Sha, err error)