pronom

Documentation

Overview

Define custom patterns (implementing the siegfried.Pattern interface) for the different patterns allowed by the PRONOM spec.

Package pronom implements the TNA's PRONOM signatures as a siegfried identifier

Index

• func ExtensionSet(path string) error
• func GetReleases(path string) error
• func Harvest() []error
• func Load(ls *persist.LoadSaver) core.Identifier
• func LoadReleases(path string) (*mappings.Releases, error)
• func New(opts ...config.Option) (core.Identifier, error)
• func NewPronom() (identifier.Parseable, error)
• func ReleaseSet(path string, releases *mappings.Releases) error
• func Releases(releases *mappings.Releases) ([]string, []string, map[string]map[string]int)
• func TypeSets(p1, p2, p3 string) error
• type Identification
  • func (id Identification) Archive() config.Archive
  • func (id Identification) Known() bool
  • func (id Identification) String() string
  • func (id Identification) Values() []string
  • func (id Identification) Warn() string
• type Identifier
  • func (i *Identifier) Fields() []string
  • func (i *Identifier) Recorder() core.Recorder
  • func (i *Identifier) Save(ls *persist.LoadSaver)
• type Range
  • func (r Range) Equals(pat patterns.Pattern) bool
  • func (r Range) Length() (int, int)
  • func (r Range) NumSequences() int
  • func (r Range) Save(ls *persist.LoadSaver)
  • func (r Range) Sequences() []patterns.Sequence
  • func (r Range) String() string
  • func (r Range) Test(b []byte) (bool, int)
  • func (r Range) TestR(b []byte) (bool, int)
• type Recorder
  • func (r *Recorder) Active(m core.MatcherType)
  • func (r *Recorder) Record(m core.MatcherType, res core.Result) bool
  • func (r *Recorder) Report() []core.Identification
  • func (r *Recorder) Satisfied(mt core.MatcherType) (bool, core.Hint)

Functions

func ExtensionSet

func ExtensionSet(path string) error

Extension set writes a sets file that links extensions to IDs.

func GetReleases

func GetReleases(path string) error

func Harvest

func Harvest() []error

UTILS Harvest fetches PRONOM reports listed in the DROID file

func Load

func Load(ls *persist.LoadSaver) core.Identifier

func LoadReleases

func LoadReleases(path string) (*mappings.Releases, error)

func New

func New(opts ...config.Option) (core.Identifier, error)

func NewPronom

func NewPronom() (identifier.Parseable, error)

Pronom creates a pronom object

func ReleaseSet

func ReleaseSet(path string, releases *mappings.Releases) error

ReleaseSet writes a changes sets file based on the latest PRONOM release file

func Releases

func Releases(releases *mappings.Releases) ([]string, []string, map[string]map[string]int)

func TypeSets

func TypeSets(p1, p2, p3 string) error

TypeSets writes three sets files based on PRONOM reports: an all sets files, with all PUIDs; a families sets file with FormatFamilies; and a types sets file with FormatTypes.

Types

type Identification

type Identification struct {
	Namespace string
	ID        string
	Name      string
	Version   string
	MIME      string
	Basis     []string
	Warning   string
	// contains filtered or unexported fields
}

func (Identification) Archive

func (id Identification) Archive() config.Archive

func (Identification) Known

func (id Identification) Known() bool

func (Identification) String

func (id Identification) String() string

func (Identification) Values

func (id Identification) Values() []string

func (Identification) Warn

func (id Identification) Warn() string

type Identifier

type Identifier struct {
	*identifier.Base
	// contains filtered or unexported fields
}

func (*Identifier) Fields

func (i *Identifier) Fields() []string

func (*Identifier) Recorder

func (i *Identifier) Recorder() core.Recorder

func (*Identifier) Save

func (i *Identifier) Save(ls *persist.LoadSaver)

type Range

type Range struct {
	From, To []byte
}

func (Range) Equals

func (r Range) Equals(pat patterns.Pattern) bool

func (Range) Length

func (r Range) Length() (int, int)

func (Range) NumSequences

func (r Range) NumSequences() int

func (Range) Save

func (r Range) Save(ls *persist.LoadSaver)

func (Range) Sequences

func (r Range) Sequences() []patterns.Sequence

func (Range) String

func (r Range) String() string

func (Range) Test

func (r Range) Test(b []byte) (bool, int)

func (Range) TestR

func (r Range) TestR(b []byte) (bool, int)

type Recorder

type Recorder struct {
	*Identifier
	// contains filtered or unexported fields
}

func (*Recorder) Active

func (r *Recorder) Active(m core.MatcherType)

func (*Recorder) Record

func (r *Recorder) Record(m core.MatcherType, res core.Result) bool

func (*Recorder) Report

func (r *Recorder) Report() []core.Identification

func (*Recorder) Satisfied

func (r *Recorder) Satisfied(mt core.MatcherType) (bool, core.Hint)