objekte_format

Documentation

Index

• Variables
• func GetShasForMetadatei(m *Metadatei) (shas map[string]*sha.Sha, err error)
• func WriteMetadateiKeyTo(w io.Writer, c FormatterContext, key *catgut.String) (n int64, err error)
• type Format
  • func Default() Format
  • func FormatForVersion(sv schnittstellen.StoreVersion) Format
  • func FormatForVersions(write, read schnittstellen.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) WriteMetadateiTo(w io.Writer, c FormatterContext) (n int64, err error)
• type Formatter
• type FormatterContext
• type Getter
• type Metadatei
• 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 GetShaForMetadatei(f FormatGeneric, m *Metadatei) (sh *Sha, err error)
  • func WriteMetadatei(w io.Writer, f FormatGeneric, c FormatterContext) (sh *Sha, err error)

Variables

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

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

var Formats formats

var FormatsGeneric = map[string][]*catgut.String{

	"MetadateiSansTai":       {keyAkte, keyBezeichnung, keyEtikett, keyTyp},
	"Metadatei":              {keyAkte, keyBezeichnung, keyEtikett, keyTyp, keyTai},
	"MetadateiKennungMutter": {keyAkte, keyBezeichnung, keyEtikett, keyKennung, keyTyp, keyTai, keyShasMutterMetadateiKennungMutter},
}

Functions

func GetShasForMetadatei

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

func WriteMetadateiKeyTo

func WriteMetadateiKeyTo(
	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 schnittstellen.StoreVersion) Format

func FormatForVersions

func FormatForVersions(write, read schnittstellen.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) WriteMetadateiTo

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

type Formatter

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

type FormatterContext

type FormatterContext interface {
	metadatei.PersistentFormatterContext
	GetKennung() kennung.Kennung
}

type Getter

type Getter interface {
	GetPersistentMetadateiFormat() Format
}

type Metadatei

type Metadatei = metadatei.Metadatei

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 {
	ParsePersistentMetadatei(
		*catgut.RingBuffer,
		ParserContext,
		Options,
	) (int64, error)
}

type ParserContext

type ParserContext interface {
	metadatei.PersistentParserContext
	SetKennungLike(kennung.Kennung) 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 GetShaForMetadatei

func GetShaForMetadatei(f FormatGeneric, m *Metadatei) (sh *Sha, err error)

func WriteMetadatei

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