extractor

Documentation

Overview

Package extractor is grouped around the Extractor component, extracting metadata from an AnnotatedResource.

Index

• Variables
• func ValidateMaxSize(ctx context.Context, r *t.AnnotatedResource, maxSize datasize.ByteSize) error
• type Extractor
• type Mock
  • func (m *Mock) Extract(ctx context.Context, r *t.AnnotatedResource, result interface{}) error

Variables

var (
	// ErrFileTooLarge is returned when the size of a file is larger than the configured `MaxFileSize`.
	ErrFileTooLarge = errors.New("file too large")
)

Functions

func ValidateMaxSize

func ValidateMaxSize(ctx context.Context, r *t.AnnotatedResource, maxSize datasize.ByteSize) error

ValidateMaxSize returns ErrFileTooLarge when the resource size is above maxSize.

Types

type Extractor

type Extractor interface {
	Extract(ctx context.Context, resource *t.AnnotatedResource, metadata interface{}) error
}

Extractor extracts metadata from an AnnotatedResource, updating the metadata interface or returning an error.

type Mock

type Mock struct {
	mock.Mock
}

Mock mocks the Extractor interface.

func (*Mock) Extract

func (m *Mock) Extract(ctx context.Context, r *t.AnnotatedResource, result interface{}) error

Extract implements the Extract method of the Extractor interface.