objectimpl

package
v3.0.9 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 10, 2026 License: Apache-2.0 Imports: 30 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewExtractor

func NewExtractor(ctx context.Context, factory factory.FactoryObject, config any, logger ocfllogger.OCFLLogger) object.Extractor

func NewExtractor20 added in v3.0.5

func NewExtractor20(ctx context.Context, fact factory.FactoryObject, conf any, logger ocfllogger.OCFLLogger) object.Extractor

func NewInitializer

func NewInitializer(ctx context.Context, factory factory.FactoryObject, config any, logger ocfllogger.OCFLLogger) object.Initializer

func NewObject20 added in v3.0.5

func NewObject20(ctx context.Context, fact factory.FactoryObject, extensionFactory extension.Factory[object.ExtensionManager], config any, logger ocfllogger.OCFLLogger) object.Object

func NewObjectBase

func NewObjectBase(ctx context.Context, fact factory.FactoryObject, defaultVersion version.OCFLVersion, extensionFactory extension.Factory[object.ExtensionManager], config any, logger ocfllogger.OCFLLogger) object.Object

NewObjectBase creates an empty ObjectBase structure

func NewObjectBaseValidator added in v3.0.5

func NewObjectBaseValidator(ctx context.Context, factory factory.FactoryObject, config any, logger ocfllogger.OCFLLogger) object.Validator

NewObjectBaseValidator creates a new instance of an object validator.

func NewObjectBaseValidator20 added in v3.0.5

func NewObjectBaseValidator20(ctx context.Context, fact factory.FactoryObject, conf any, logger ocfllogger.OCFLLogger) object.Validator

NewObjectBaseValidator20 creates a new instance of an OCFL 2.0 object validator. It supports zipped version folders by overriding the getVersionFS mechanism.

func NewVersionFSMap added in v3.0.5

func NewVersionFSMap(logger ocfllogger.OCFLLogger) object.VersionFSMap

func NewVersionFSMap20 added in v3.0.5

func NewVersionFSMap20(logger ocfllogger.OCFLLogger) object.VersionFSMap

func NewVersionWriter20 added in v3.0.4

func NewVersionWriter20(ctx context.Context, fact factory.FactoryObject, conf any, logger ocfllogger.OCFLLogger) object.VersionWriter

func NewVersionWriterBase added in v3.0.2

func NewVersionWriterBase(ctx context.Context, fact factory.FactoryObject, conf any, logger ocfllogger.OCFLLogger) object.VersionWriter

Types

type Extractor20Config added in v3.0.5

type Extractor20Config struct{}

type ExtractorConfig added in v3.0.3

type ExtractorConfig struct{}

type Loader

type Loader struct {
	// contains filtered or unexported fields
}

func NewLoader

func NewLoader(ctx context.Context, factory factory.FactoryObject, config any, logger ocfllogger.OCFLLogger) *Loader

func (*Loader) Close added in v3.0.6

func (loader *Loader) Close() error

func (*Loader) GetFS

func (loader *Loader) GetFS() fs.FS

func (*Loader) Load

func (loader *Loader) Load() error

func (*Loader) SetExtensionFactory added in v3.0.2

func (loader *Loader) SetExtensionFactory(factory extension.Factory[object.ExtensionManager]) object.Loader

func (*Loader) WithObject

func (loader *Loader) WithObject(o object.Object) object.Loader

type Loader20 added in v3.0.5

type Loader20 struct {
	*Loader
}

func NewLoader20 added in v3.0.5

func NewLoader20(ctx context.Context, factory factory.FactoryObject, config any, logger ocfllogger.OCFLLogger) *Loader20

func (*Loader20) WithObject added in v3.0.5

func (l *Loader20) WithObject(o object.Object) object.Loader

type LoaderConfig added in v3.0.3

type LoaderConfig struct{}

type Object20 added in v3.0.5

type Object20 struct {
	*ObjectBase
}

func (*Object20) WithExtensionManager added in v3.0.5

func (f *Object20) WithExtensionManager(manager object.ExtensionManager) object.Object

func (*Object20) WithInventory added in v3.0.5

func (f *Object20) WithInventory(inv inventory.Inventory) object.Object

func (*Object20) WithReadFS added in v3.0.5

func (f *Object20) WithReadFS(fsys fs.FS) object.Object

func (*Object20) WithWriteFS added in v3.0.5

func (f *Object20) WithWriteFS(fsys appendfs.FS) object.Object

type ObjectBase

type ObjectBase struct {
	// contains filtered or unexported fields
}

func (*ObjectBase) Close added in v3.0.4

func (objectBase *ObjectBase) Close() error

func (*ObjectBase) CreateInventory

func (objectBase *ObjectBase) CreateInventory(id string, digestAlg checksum.DigestAlgorithm, fixityAlgs []checksum.DigestAlgorithm) (inventory.Inventory, error)

func (*ObjectBase) GetDigestAlgorithm

func (objectBase *ObjectBase) GetDigestAlgorithm() checksum.DigestAlgorithm

func (*ObjectBase) GetExtensionManager

func (objectBase *ObjectBase) GetExtensionManager() object.ExtensionManager

func (*ObjectBase) GetExtractor

func (objectBase *ObjectBase) GetExtractor() object.Extractor

func (*ObjectBase) GetFactory

func (objectBase *ObjectBase) GetFactory() factory.FactoryObject

func (*ObjectBase) GetID

func (objectBase *ObjectBase) GetID() string

func (*ObjectBase) GetInitializer

func (objectBase *ObjectBase) GetInitializer() object.Initializer

func (*ObjectBase) GetInventory

func (objectBase *ObjectBase) GetInventory() inventory.Inventory

func (*ObjectBase) GetLoader

func (objectBase *ObjectBase) GetLoader() object.Loader

func (*ObjectBase) GetOCFLVersion

func (objectBase *ObjectBase) GetOCFLVersion() version.OCFLVersion

func (*ObjectBase) GetReadFS added in v3.0.2

func (objectBase *ObjectBase) GetReadFS() fs.FS

func (*ObjectBase) GetValidator added in v3.0.5

func (objectBase *ObjectBase) GetValidator() object.Validator

func (*ObjectBase) GetWriteFS added in v3.0.2

func (objectBase *ObjectBase) GetWriteFS() appendfs.FS

func (*ObjectBase) IsModified

func (objectBase *ObjectBase) IsModified() bool

func (*ObjectBase) StartUpdate

func (objectBase *ObjectBase) StartUpdate(msg string, UserName string, UserAddress string, echo bool) (object.VersionWriter, error)

func (*ObjectBase) Stat

func (objectBase *ObjectBase) Stat(w io.Writer, statInfo []object.StatInfo) error

func (*ObjectBase) WithExtensionManager

func (objectBase *ObjectBase) WithExtensionManager(manager object.ExtensionManager) object.Object

func (*ObjectBase) WithInventory

func (objectBase *ObjectBase) WithInventory(inv inventory.Inventory) object.Object

func (*ObjectBase) WithReadFS added in v3.0.2

func (objectBase *ObjectBase) WithReadFS(fsys fs.FS) object.Object

func (*ObjectBase) WithWriteFS added in v3.0.2

func (objectBase *ObjectBase) WithWriteFS(fsys appendfs.FS) object.Object

type ObjectBaseConfig added in v3.0.3

type ObjectBaseConfig struct{}

type Validator20Config added in v3.0.5

type Validator20Config struct{}

Validator20Config holds the configuration for the OCFL 2.0 validator.

type ValidatorConfig added in v3.0.5

type ValidatorConfig struct{}

ValidatorConfig holds the configuration for the validator.

type VersionWriter20Config added in v3.0.4

type VersionWriter20Config struct{}

type VersionWriterConfig added in v3.0.3

type VersionWriterConfig struct{}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL