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;
8mod change_set;
9pub mod chunk_transfer;
10mod error;
11mod folder_analysis;
12mod folderbase_capture;
13mod folderbase_restore_authority;
14mod folderbase_seal;
15mod folderbase_state;
16pub mod folderbase_version;
17#[cfg(test)]
18mod folderbase_version_producer_tests;
19pub mod guide_policy;
20mod initialization;
21mod inspection;
22mod local_versions;
23mod migration;
24#[cfg(test)]
25mod migration_execution_contract_red_tests;
26mod migration_filesystem;
27mod model;
28mod physical_identity;
29mod portable_wire_path;
30mod protocol_upgrade;
31mod query;
32mod reorganization;
33mod root_attestation;
34mod sharing;
35mod sync;
36mod template;
37mod template_expansion;
38pub mod transfer_manifest;
39pub mod transfer_receiver;
40pub mod transfer_source;
41mod traversal_policy;
42mod validation;
43mod workspace;
44
45pub use change_set::{
46    AuthorizedPath, ChangeSetApplyOutcome, ChangeSetApplyResult, ChangeSetAssessment,
47    ChangeSetAssessmentOutcome, ChangeSetAttention, ChangeSetAttentionDetail, ChangeSetConflict,
48    ChangeSetEnvelope, ChangeSetError, ChangeSetPayload, CheckoutReceipt, CheckoutRequest,
49    CheckoutResult, ContentReference, DeltaDirectory, DeltaRegularFile, DeltaState, DeltaSymlink,
50    MAX_CHANGE_SET_BYTES, ObjectDelta, ProjectedEntry, ProjectionExclusion, StagedContent,
51    StagingIndex, StagingObject, apply_change_set, assess_change_set,
52    checkout_change_set_projection, propose_change_set,
53};
54pub use error::{FolderbaseError, InitializationInventoryLimitKind, Result};
55pub use folderbase_capture::{
56    CaptureEntryKind, CaptureExclusionKind, CaptureExclusionReason, CaptureIgnoredPath,
57    CaptureLocalHead, CapturePlan, CapturePlanEntry, CapturePlanExclusion, CapturePlanLimitKind,
58    FolderbaseCaptureError, FolderbaseVersionStore, LocalHeadAuthority, MAX_CAPTURE_PLAN_RECORDS,
59    MAX_FOLDERBASEIGNORE_BYTES, MAX_LOCAL_HEAD_BYTES,
60};
61pub use folderbase_seal::{RestoredTombstone, SealedCapture};
62pub use folderbase_version::PathBindingKind;
63pub use initialization::{
64    initialize, initialize_with_expected_plan_digest, plan_initialization,
65    plan_template_initialization,
66};
67pub use inspection::inspect;
68pub use local_versions::{
69    ApprovedHistoryTransfer, CaptureResult, ContentDigest, HistoryTransferPlan,
70    HistoryTransferResult, HistoryTransferState, JournalAction, LocalObjectRecord,
71    LocalVersionRecord, LocalVersionStore, ObjectId, ObjectJournalEvent, RestoreResult, VersionId,
72    apply_history_transfer, approve_history_transfer,
73};
74pub use migration::{
75    ApprovedMigration, MigrationAnalysis, MigrationAnswer, MigrationAnswerException,
76    MigrationCommand, MigrationConflict, MigrationConflictDirection, MigrationContentKind,
77    MigrationCopyPreview, MigrationExclusion, MigrationExecution, MigrationOperation,
78    MigrationOption, MigrationOutcome, MigrationPlan, MigrationPreview, MigrationQuestion,
79    MigrationQuestionKind, MigrationResult, MigrationState, MigrationTarget, MigrationTargetKind,
80    ProposedBoundary, RollbackResult, RootClaim, analyze_migration, apply_migration,
81    approve_migration, plan_migration, preview_migration, rollback_migration,
82};
83pub use model::{
84    BoundaryHint, Classification, ClassifiedPath, FolderbaseKind, InitializationOptions,
85    InitializationPlan, InitializationPlanDigest, InitializationResult, InspectionReport,
86    InventorySummary, NestedFolderbaseBoundary, NestedFolderbaseState, PlannedDirectory,
87    PlannedTemplateAddition, PlannedWrite, PreservedPath, ReconstructableTree, TemplateAnswerType,
88    TemplateAnswerValue, TemplateApplicationCreatedPath, TemplateApplicationPreservedTarget,
89    TemplateApplicationRecord, TemplateApplicationResult, TemplateApplicationState,
90    TemplateArtifactKind, TemplateArtifactPrecondition, TemplateComparisonSource,
91    TemplateDescriptor, TemplateExpansionPlan, TemplatePackage, TemplatePlanDigest,
92    TemplateQuestion, TemplateRenderPlan, TemplateStructuralChange, TemplateStructuralChangeKind,
93    ValidationFinding, ValidationLevel, ValidationReport, ValidationSeverity,
94};
95pub use protocol_upgrade::{
96    ProtocolUpgradePlan, ProtocolUpgradePlanDigest, ProtocolUpgradeResult, apply_protocol_upgrade,
97    plan_protocol_upgrade,
98};
99pub use query::{
100    FolderbaseQueryEngine, QueryEntry, QueryEntryKind, QueryError, QueryExclusion,
101    QueryExclusionKind, QueryExecution, QueryExplain, QueryIndexRebuildResult, QueryIndexState,
102    QueryIndexStatus, QueryLifecycle, QueryPageResult, QueryRequest, QueryResult, QuerySource,
103};
104pub use reorganization::{
105    AnalysisScope, ConsequentialAnswer, ConsequentialAnswerType, ConsequentialQuestion,
106    MAX_CANONICAL_JSON_INTEGER, MAX_REORGANIZATION_RECORD_BYTES, NestedBoundary, PathProfile,
107    ReorganizationDraft, ReorganizationOperation, ReorganizationPlan, ScopeEntry,
108    StructuralChangesPolicy, decode_reorganization_draft, decode_reorganization_draft_slice,
109    decode_reorganization_plan, decode_reorganization_plan_slice,
110    reorganization_analysis_scope_sha256, reorganization_plan_sha256, seal_reorganization_draft,
111    validate_reorganization_draft, validate_reorganization_plan,
112};
113pub use root_attestation::{
114    FolderbaseRootAttestation, FolderbaseRootMarker, MAX_FOLDERBASE_MANIFEST_BYTES,
115    ROOT_INSTANCE_FORMAT_V1, ROOT_INSTANCE_FORMAT_V2, RootAttestationError, attest_folderbase_root,
116};
117pub use sharing::{
118    AccessDecision, AccessReason, AccessRequest, FolderbaseRegistration, ShareGrant,
119    SharePermission, ShareScope, SharingControlPlane,
120};
121pub use sync::{
122    ConflictClassification, ContentKind, MemorySyncCloud, SyncConflict, SyncEvent, SyncReplica,
123    SyncReport, SyncVersion,
124};
125pub use template::{
126    list_templates, load_builtin_template, load_template, render_template, template_package_sha256,
127};
128pub use template_expansion::{
129    apply_template_expansion, apply_template_expansion_with_expected_plan_digest,
130    plan_template_expansion, template_application_history,
131};
132pub use transfer_source::{
133    ChunkTransferProfile, ChunkTransferSource, MANAGED_LARGE_PROFILE_THRESHOLD_BYTES,
134    TRANSFER_IO_BUFFER_BYTES, TransferSourceError, VerifiedChunk,
135};
136pub use validation::validate;
137pub use workspace::{
138    MAX_WORKSPACE_TEXT_BYTES, WorkspaceDocumentState, WorkspaceEntry, WorkspaceEntryKind,
139    WorkspaceListing, WorkspaceSaveResult, WorkspaceTextDocument, list_workspace,
140    read_workspace_text, save_workspace_text,
141};