Skip to main content

Crate archival

Crate archival 

Source

Re-exports§

pub use fields::FieldConfig;
pub use fields::FieldType;
pub use fields::FieldValue;
pub use fields::RenderedFieldValue;
pub use fields::RenderedObjectValues;
pub use object::ObjectMap;
pub use object::RenderedObject;
pub use object::RenderedObjectMap;
pub use object::ValuePath;

Modules§

binary
events
fields
manifest
object
schemas
The JSON Schema files published to https://archival.dev/schemas/ and registered with SchemaStore, embedded so that dependents get the schemas belonging to the exact archival version they pin.

Structs§

Archival
ArchivalError
BuildOptions
DefinitionComments
Comments harvested from an archival_objects.toml source, shaped to mirror ObjectDefinition’s split between fields and children so it can be walked alongside one.
DistFile
FieldDefinition
A field’s type, plus whatever the schema author wrote about it.
MemoryFileSystem
ObjectDefinition
ObjectSchemaOptions
RenderedFile

Constants§

LEGACY_MANIFEST_FILE_NAME
Sites created before these files were given archival-specific names still use the generic ones. They are read (and written back to) when present, but the names above are canonical for anything archival creates.
LEGACY_OBJECT_DEFINITION_FILE_NAME
MANIFEST_FILE_NAME
MIN_COMPAT_VERSION
OBJECT_DEFINITION_FILE_NAME

Statics§

ARCHIVAL_VERSION

Traits§

FileSystemAPI

Functions§

generate_typescript_defs
Generates the full declaration file for a site.
sha_for_data
unpack_zip

Type Aliases§

ArchivalBuildId
FieldsMap
ObjectDefinitions
ObjectSchema