Module rocfl::ocfl[][src]

Expand description

This library is a storage agnostic abstraction over OCFL repositories.

Create a new OcflRepo as follows:

use rocfl::ocfl::OcflRepo;

let repo = OcflRepo::fs_repo("path/to/ocfl/storage/root", None);

Structs

Optional meta that may be associated with a commit

Represents a path within a version’s content directory. This path must be relative the object root.

Details about a file in an OCFL object

Lazily validates every object in the repository. Each call to next() validates another object.

Represents the logical path to a file in an object.

The results of validating an OCFL object

Represents a version of an OCFL object

Similar to ObjectVersion, except it does not contain the state map.

OCFL repository

The storage layout maps object IDs to locations within the storage root

The results of validating the structure of an OCFL repository

Metadata about a version

Enums

Represents a change to a file

Enum of all valid digest algorithms

OCFL validation codes for errors: https://ocfl.io/1.0/spec/validation-codes.html

Enum of known storage layout extensions

Application errors

Represents either a specific version number or whatever the current head version is

OCFL validation codes for warnings: https://ocfl.io/1.0/spec/validation-codes.html

Traits

Lazily validates every object in the repository. Each call to next() validates another object.

Type Definitions