README
¶
Package Documentation
This directory contains the core packages of the gocfl project. Each sub-package provides specific functionality for handling OCFL (Oxford Common Filesystem Layout) storage roots, objects, and related metadata.
Overview of Packages
ocfl
The main package for OCFL operations. It includes several sub-packages for different aspects of the OCFL specification.
- extension: OCFL extension management.
- factory: Factory for creating OCFL objects and storage roots.
- inventory: Handling of OCFL inventory files.
- object: OCFL object management.
- storageroot: OCFL storage root management.
- validation: OCFL validation logic.
- version: OCFL version definitions and specifications (v1.0, v1.1).
extensions
Contains various extensions for the gocfl tool.
ocfllogger
A specialized logger package used throughout the gocfl project to ensure consistent logging and error reporting.
util
General utility functions used across the project, including file system helpers and program detection.
For more general information about the project, please refer to the main README.md in the root directory.
Directories
¶
| Path | Synopsis |
|---|---|
|
extensions
|
|
|
ext_NNNN_gocfl_extension_manager
Package ext_NNNN_gocfl_extension_manager implements the OCFL "NNNN-gocfl-extension-manager" extension.
|
Package ext_NNNN_gocfl_extension_manager implements the OCFL "NNNN-gocfl-extension-manager" extension. |
|
ext_initial
Package ext_initial implements the OCFL "initial" extension.
|
Package ext_initial implements the OCFL "initial" extension. |
|
Package ocfl provides high-level functions for interacting with OCFL objects.
|
Package ocfl provides high-level functions for interacting with OCFL objects. |
|
extension
Package extension provides the basic interfaces and structures for OCFL extensions.
|
Package extension provides the basic interfaces and structures for OCFL extensions. |
|
factory
Package factory provides unified factory interfaces for creating OCFL objects and storage roots.
|
Package factory provides unified factory interfaces for creating OCFL objects and storage roots. |
|
inventory
Package inventory defines the structures and interfaces for the OCFL (Oxford Common File Layout) Inventory.
|
Package inventory defines the structures and interfaces for the OCFL (Oxford Common File Layout) Inventory. |
|
object
Package object contains the interfaces and implementations for OCFL objects.
|
Package object contains the interfaces and implementations for OCFL objects. |
|
storageroot
Package storageroot contains the interfaces and abstractions for managing OCFL (Oxford Common File Layout) storage roots.
|
Package storageroot contains the interfaces and abstractions for managing OCFL (Oxford Common File Layout) storage roots. |
|
validation
Package validation provides structures and functions for handling OCFL validation errors and warnings.
|
Package validation provides structures and functions for handling OCFL validation errors and warnings. |
|
version
Package version defines the supported OCFL versions and provides utilities for version comparison and specification access.
|
Package version defines the supported OCFL versions and provides utilities for version comparison and specification access. |
|
ocflloggerimpl
Package ocfllogger provides a logging interface for OCFL operations that integrates with the OCFL validation system.
|
Package ocfllogger provides a logging interface for OCFL operations that integrates with the OCFL validation system. |
Click to show internal directories.
Click to hide internal directories.