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 Harvest() []error
• func Load(ls *persist.LoadSaver) core.Identifier
• func New(opts ...config.Option) (core.Identifier, error)
• func NewPronom() (identifier.Parseable, error)
• type Identification
  • func (id Identification) Archive() config.Archive
  • func (id Identification) CSV() []string
  • func (id Identification) JSON() string
  • func (id Identification) Known() bool
  • func (id Identification) String() string
  • func (id Identification) Warn() string
  • func (id Identification) YAML() 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(res chan core.Identification)
  • func (r *Recorder) Satisfied(mt core.MatcherType) (bool, int)

Functions

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 New

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

func NewPronom

func NewPronom() (identifier.Parseable, error)

Pronom creates a pronom object

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) CSV

func (id Identification) CSV() []string

func (Identification) JSON

func (id Identification) JSON() string

func (Identification) Known

func (id Identification) Known() bool

func (Identification) String

func (id Identification) String() string

func (Identification) Warn

func (id Identification) Warn() string

func (Identification) YAML

func (id Identification) YAML() 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(res chan core.Identification)

func (*Recorder) Satisfied

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