Skip to main content

folderbase_core/
lib.rs

1//! Portable implementation of the Folderbase filesystem protocol.
2//!
3//! The four functions exported here form the external seam used by the CLI
4//! and, later, the native Mac application. Filesystem traversal, protocol
5//! layout, preservation rules, and validation stay behind this interface.
6
7pub mod availability;
8pub mod chunk_transfer;
9mod error;
10mod folder_analysis;
11mod folderbase_capture;
12mod folderbase_restore_authority;
13mod folderbase_seal;
14mod folderbase_state;
15pub mod folderbase_version;
16#[cfg(test)]
17mod folderbase_version_producer_tests;
18pub mod guide_policy;
19mod initialization;
20mod inspection;
21mod local_versions;
22mod migration;
23#[cfg(test)]
24mod migration_execution_contract_red_tests;
25mod migration_filesystem;
26mod model;
27mod physical_identity;
28mod portable_wire_path;
29mod protocol_upgrade;
30mod reorganization;
31mod root_attestation;
32mod sharing;
33mod sync;
34mod template;
35mod template_expansion;
36pub mod transfer_manifest;
37pub mod transfer_receiver;
38pub mod transfer_source;
39mod traversal_policy;
40mod validation;
41mod workspace;
42
43pub use error::{FolderbaseError, InitializationInventoryLimitKind, Result};
44pub use folderbase_capture::{
45    CaptureEntryKind, CaptureExclusionKind, CaptureExclusionReason, CaptureIgnoredPath,
46    CaptureLocalHead, CapturePlan, CapturePlanEntry, CapturePlanExclusion, CapturePlanLimitKind,
47    FolderbaseCaptureError, FolderbaseVersionStore, LocalHeadAuthority, MAX_CAPTURE_PLAN_RECORDS,
48    MAX_FOLDERBASEIGNORE_BYTES, MAX_LOCAL_HEAD_BYTES,
49};
50pub use folderbase_seal::{RestoredTombstone, SealedCapture};
51pub use folderbase_version::PathBindingKind;
52pub use initialization::{
53    initialize, initialize_with_expected_plan_digest, plan_initialization,
54    plan_template_initialization,
55};
56pub use inspection::inspect;
57pub use local_versions::{
58    ApprovedHistoryTransfer, CaptureResult, ContentDigest, HistoryTransferPlan,
59    HistoryTransferResult, HistoryTransferState, JournalAction, LocalObjectRecord,
60    LocalVersionRecord, LocalVersionStore, ObjectId, ObjectJournalEvent, RestoreResult, VersionId,
61    apply_history_transfer, approve_history_transfer,
62};
63pub use migration::{
64    ApprovedMigration, MigrationAnalysis, MigrationAnswer, MigrationAnswerException,
65    MigrationCommand, MigrationConflict, MigrationConflictDirection, MigrationContentKind,
66    MigrationCopyPreview, MigrationExclusion, MigrationExecution, MigrationOperation,
67    MigrationOption, MigrationOutcome, MigrationPlan, MigrationPreview, MigrationQuestion,
68    MigrationQuestionKind, MigrationResult, MigrationState, MigrationTarget, MigrationTargetKind,
69    ProposedBoundary, RollbackResult, RootClaim, analyze_migration, apply_migration,
70    approve_migration, plan_migration, preview_migration, rollback_migration,
71};
72pub use model::{
73    BoundaryHint, Classification, ClassifiedPath, FolderbaseKind, InitializationOptions,
74    InitializationPlan, InitializationPlanDigest, InitializationResult, InspectionReport,
75    InventorySummary, NestedFolderbaseBoundary, NestedFolderbaseState, PlannedDirectory,
76    PlannedTemplateAddition, PlannedWrite, PreservedPath, ReconstructableTree, TemplateAnswerType,
77    TemplateAnswerValue, TemplateApplicationCreatedPath, TemplateApplicationPreservedTarget,
78    TemplateApplicationRecord, TemplateApplicationResult, TemplateApplicationState,
79    TemplateArtifactKind, TemplateArtifactPrecondition, TemplateComparisonSource,
80    TemplateDescriptor, TemplateExpansionPlan, TemplatePackage, TemplatePlanDigest,
81    TemplateQuestion, TemplateRenderPlan, TemplateStructuralChange, TemplateStructuralChangeKind,
82    ValidationFinding, ValidationLevel, ValidationReport, ValidationSeverity,
83};
84pub use protocol_upgrade::{
85    ProtocolUpgradePlan, ProtocolUpgradePlanDigest, ProtocolUpgradeResult, apply_protocol_upgrade,
86    plan_protocol_upgrade,
87};
88pub use reorganization::{
89    AnalysisScope, ConsequentialAnswer, ConsequentialAnswerType, ConsequentialQuestion,
90    MAX_CANONICAL_JSON_INTEGER, MAX_REORGANIZATION_RECORD_BYTES, NestedBoundary, PathProfile,
91    ReorganizationDraft, ReorganizationOperation, ReorganizationPlan, ScopeEntry,
92    StructuralChangesPolicy, decode_reorganization_draft, decode_reorganization_draft_slice,
93    decode_reorganization_plan, decode_reorganization_plan_slice,
94    reorganization_analysis_scope_sha256, reorganization_plan_sha256, seal_reorganization_draft,
95    validate_reorganization_draft, validate_reorganization_plan,
96};
97pub use root_attestation::{
98    FolderbaseRootAttestation, FolderbaseRootMarker, MAX_FOLDERBASE_MANIFEST_BYTES,
99    ROOT_INSTANCE_FORMAT_V1, ROOT_INSTANCE_FORMAT_V2, RootAttestationError, attest_folderbase_root,
100};
101pub use sharing::{
102    AccessDecision, AccessReason, AccessRequest, FolderbaseRegistration, ShareGrant,
103    SharePermission, ShareScope, SharingControlPlane,
104};
105pub use sync::{
106    ConflictClassification, ContentKind, MemorySyncCloud, SyncConflict, SyncEvent, SyncReplica,
107    SyncReport, SyncVersion,
108};
109pub use template::{
110    list_templates, load_builtin_template, load_template, render_template, template_package_sha256,
111};
112pub use template_expansion::{
113    apply_template_expansion, plan_template_expansion, template_application_history,
114};
115pub use transfer_source::{
116    ChunkTransferProfile, ChunkTransferSource, MANAGED_LARGE_PROFILE_THRESHOLD_BYTES,
117    TRANSFER_IO_BUFFER_BYTES, TransferSourceError, VerifiedChunk,
118};
119pub use validation::validate;
120pub use workspace::{
121    MAX_WORKSPACE_TEXT_BYTES, WorkspaceDocumentState, WorkspaceEntry, WorkspaceEntryKind,
122    WorkspaceListing, WorkspaceSaveResult, WorkspaceTextDocument, list_workspace,
123    read_workspace_text, save_workspace_text,
124};