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

• Constants
• func ExtensionSet(path string) error
• func FormatPRONOM(id string, ps []PROCompatSequence) (frames.Signature, 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 NoClassIdentification
  • func (nc NoClassIdentification) Values() []string
• type PROCompatSequence
• 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) ([]int, int)
  • func (r Range) TestR(b []byte) ([]int, 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)

Constants

const BeginningOfFile = pronombof

BeginningOfFile provides access to PRONOM's BOF const.

const EndOfFile = pronomeof

EndOfFile provides access to PRONOM's EOF const.

Functions

func ExtensionSet

func ExtensionSet(path string) error

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

func FormatPRONOM

func FormatPRONOM(id string, ps []PROCompatSequence) (frames.Signature, error)

FormatPRONOM is an external helper function for enabling the processing of a significant number of signature types compatible with the PRONOM standard from plain-old hex, to more complex PRONOM regex.

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

Load reads PRONOM information back from the persist byte format into the Identifier's FormatInfo struct.

func LoadReleases

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

func New

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

New creates a new PRONOM Identifier

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
	Class     string
	Basis     []string
	Warning   string
	// contains filtered or unexported fields
}

Identification records format related metadata.

func (Identification) Archive

func (id Identification) Archive() config.Archive

Archive returns the archive value for a given identification.

func (Identification) Known

func (id Identification) Known() bool

Known outputs true if the identification result isn't UNKNOWN.

func (Identification) String

func (id Identification) String() string

func (Identification) Values

func (id Identification) Values() []string

Values returns the Identification result information to the caller.

func (Identification) Warn

func (id Identification) Warn() string

Warn returns the associated warning for a given identification.

type Identifier

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

Identifier is the PRONOM implementation of the Identifier interface It wraps the base Identifier implementation with a formatinfo map

func (*Identifier) Fields

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

Fields returns the user-facing fields used in the Identifier's reports.

func (*Identifier) Recorder

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

Recorder provides a new recorder for identification results.

func (*Identifier) Save

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

Save persists the PRONOM Identifier to disk

type NoClassIdentification

type NoClassIdentification struct {
	Identification
}

NoClassIdentification wraps Identification to implement the noclass option

func (NoClassIdentification) Values

func (nc NoClassIdentification) Values() []string

type PROCompatSequence

type PROCompatSequence = mappings.ByteSequence

PROCompatSequence (compatibility) provides access to the PRONON primitive mappings.ByteSequence for custom identifier types that want to make use of PRONOM's level of expression.

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) ([]int, int)

func (Range) TestR

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

type Recorder

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

Recorder stores information about match results.

func (*Recorder) Active

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

Active sets the flags for the recorder's active matchers.

func (*Recorder) Record

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

Record builds possible results sets associated with an identification.

func (*Recorder) Report

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

Report organizes the results output and lists the highest priority results first.

func (*Recorder) Satisfied

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

Satisfied determines whether we should continue running identification with a given matcher type.