Expand description
Portable implementation of the Folderbase filesystem protocol.
The four functions exported here form the external seam used by the CLI and, later, the native Mac application. Filesystem traversal, protocol layout, preservation rules, and validation stay behind this interface.
Re-exports§
pub use folderbase_version::PathBindingKind;pub use transfer_source::ChunkTransferProfile;pub use transfer_source::ChunkTransferSource;pub use transfer_source::MANAGED_LARGE_PROFILE_THRESHOLD_BYTES;pub use transfer_source::TRANSFER_IO_BUFFER_BYTES;pub use transfer_source::TransferSourceError;pub use transfer_source::VerifiedChunk;
Modules§
- availability
- chunk_
transfer - folderbase_
version - Canonical, provider-neutral full state for one Folderbase boundary.
- guide_
policy - transfer_
manifest - Canonical, provider-neutral manifest for streaming immutable object bytes.
- transfer_
receiver - Durable, capability-rooted receipt and materialization of immutable objects.
- transfer_
source - Bounded-memory planning and streaming for immutable local versions.
Structs§
- Access
Decision - Access
Request - Analysis
Scope - Approved
History Transfer - Approved
Migration - An approval token tied to a specific immutable plan digest.
- Authorized
Path - Boundary
Hint - Capture
Ignored Path - One path omitted by ordered Folderbase ignore policy.
- Capture
Local Head - A device-local pointer observed while planning.
- Capture
Plan - An opaque, read-only metadata inventory bound to one physical root.
- Capture
Plan Entry - One metadata-only inventory entry.
- Capture
Plan Exclusion - One typed item that cannot become a v1 Path Binding.
- Capture
Result - Change
SetApply Result - Change
SetAssessment - Change
SetAttention - Change
SetAttention Detail - Change
SetConflict - Change
SetEnvelope - Change
SetPayload - Checkout
Receipt - Checkout
Request - Checkout
Result - Classified
Path - Consequential
Question - Content
Digest - Delta
Directory - Delta
Regular File - Delta
Symlink - Folderbase
Query Engine - A root-bound handle for read-only query and explicit disposable-index work.
- Folderbase
Registration - Folderbase
Root Attestation - Evidence that one exact path is a well-formed Folderbase root.
- Folderbase
Version Store - Read-only handle for planning Folderbase Version capture.
- History
Transfer Plan - History
Transfer Result - Initialization
Options - Initialization
Plan - A previewable initialization plan that can only be created by the core.
- Initialization
Plan Digest - An opaque, Core-owned commitment to every semantically relevant decision in an initialization plan.
- Initialization
Result - Inspection
Report - Inventory
Summary - Local
Object Record - Current materialization metadata for a tracked object.
- Local
Version Record - Immutable metadata for one captured version.
- Local
Version Store - Filesystem-backed local version storage for one folderbase root.
- Memory
Sync Cloud - In-memory implementation of the immutable cloud data-plane contract.
- Migration
Analysis - Migration
Answer - Migration
Answer Exception - Migration
Conflict - Migration
Copy Preview - Migration
Exclusion - Migration
Execution - The single semantic execution boundary for apply, recovery, and rollback.
- Migration
Option - Migration
Plan - Migration
Preview - Migration
Question - Migration
Result - Migration
Target - Nested
Boundary - Nested
Folderbase Boundary - Object
Delta - Object
Id - A stable object identity that does not depend on the object’s current path.
- Object
Journal Event - One append-only journal line.
- Planned
Directory - Planned
Template Addition - Planned
Write - Preserved
Path - Projection
Exclusion - Proposed
Boundary - Protocol
Upgrade Plan - Protocol
Upgrade Plan Digest - Protocol
Upgrade Result - Query
Entry - One query row.
- Query
Exclusion - One path omitted from ordinary query rows.
- Query
Explain - Read-only explanation of one normalized query plan.
- Query
Index Rebuild Result - Result of explicitly replacing the disposable private index.
- Query
Index Status - Result of inspecting the private index without changing it.
- Query
Page Result - Page metadata for a query result.
- Query
Request - One bounded query request.
- Query
Result - One successful query page.
- Reconstructable
Tree - Reorganization
Draft - Reorganization
Plan - Restore
Result - Restored
Tombstone - Result of restoring the exact bytes named by one current-Head Tombstone.
- Rollback
Result - Sealed
Capture - Result of sealing or converging on one durable device-local Folderbase Version.
- Share
Grant - Sharing
Control Plane - A deterministic authorization/control-plane model.
- Staged
Content - Staging
Index - Staging
Object - Sync
Conflict - Sync
Event - Sync
Replica - A deterministic logical device used by the native client and fault tests.
- Sync
Report - Sync
Version - Template
Application Created Path - Template
Application Preserved Target - Template
Application Record - Template
Application Result - Template
Artifact Precondition - Template
Descriptor - Template
Expansion Plan - A read-only preview of one template version’s guidance against a folderbase.
- Template
Package - Template
Plan Digest - Template
Question - Template
Render Plan - Template
Structural Change - Validation
Finding - Validation
Report - Version
Id - The identity of one immutable capture of an object’s bytes.
- Workspace
Document State - Workspace
Entry - Workspace
Listing - Workspace
Save Result - Workspace
Text Document
Enums§
- Access
Reason - Capture
Entry Kind - Metadata kind observed for a future live Path Binding.
- Capture
Exclusion Kind - Capture
Exclusion Reason - Capture
Plan Limit Kind - Change
SetApply Outcome - Change
SetAssessment Outcome - Change
SetError - Classification
- Conflict
Classification - Consequential
Answer - Consequential
Answer Type - Content
Kind - Content
Reference - Delta
State - Folderbase
Capture Error - Failures that prevent a trustworthy metadata-only capture plan.
- Folderbase
Error - Errors that prevent an operation from producing a trustworthy result.
- Folderbase
Kind - Folderbase
Root Marker - A closed identifier for every marker required by root attestation.
- History
Transfer State - Initialization
Inventory Limit Kind - Journal
Action - Local
Head Authority - The closed meaning of one Local Head authority digest.
- Migration
Command - Migration
Conflict Direction - Migration
Content Kind - Migration
Operation - Migration
Outcome - Migration
Question Kind - Migration
State - Migration
Target Kind - Nested
Folderbase State - Path
Profile - Projected
Entry - Query
Entry Kind - Filesystem kind exposed by query 0.1.
- Query
Error - Typed failures from query/index Core operations.
- Query
Exclusion Kind - Optional type attached to an explainable exclusion.
- Query
Execution - How the selected observation was evaluated.
- Query
Index State - Read-only state of the disposable private query index.
- Query
Lifecycle - Lifecycle exposed by query 0.1.
- Query
Source - Source observation from which a query row was projected.
- Reorganization
Operation - Root
Attestation Error - Failures produced while attesting one exact Folderbase root.
- Root
Claim - The caller-selected Folderbase root for one migration command.
- Scope
Entry - Share
Permission - Share
Scope - Structural
Changes Policy - Template
Answer Type - Template
Answer Value - Template
Application State - Template
Artifact Kind - Template
Comparison Source - Template
Structural Change Kind - Validation
Level - Validation
Severity - Workspace
Entry Kind
Constants§
- MAX_
CANONICAL_ JSON_ INTEGER - MAX_
CAPTURE_ PLAN_ RECORDS - MAX_
CHANGE_ SET_ BYTES - MAX_
FOLDERBASEIGNORE_ BYTES - MAX_
FOLDERBASE_ MANIFEST_ BYTES - Largest manifest accepted by the root-attestation seam.
- MAX_
LOCAL_ HEAD_ BYTES - MAX_
REORGANIZATION_ RECORD_ BYTES - MAX_
WORKSPACE_ TEXT_ BYTES - ROOT_
INSTANCE_ FORMAT_ V1 - Domain separator for the current device-local root-instance digest.
- ROOT_
INSTANCE_ FORMAT_ V2 - Domain separator for full Windows
FILE_ID_INFOroot identity.
Functions§
- analyze_
migration - Analyze a folder without changing it.
- apply_
change_ set - apply_
history_ transfer - apply_
migration - Compatibility adapter for applying an approved migration.
- apply_
protocol_ upgrade - apply_
template_ expansion - apply_
template_ expansion_ with_ expected_ plan_ digest - Re-plan and apply one exact data-only template package under Folderbase’s shared transaction lease.
- approve_
history_ transfer - approve_
migration - assess_
change_ set - attest_
folderbase_ root - Attest one exact Folderbase root without writing protocol or ordinary files.
- checkout_
change_ set_ projection - decode_
reorganization_ draft - decode_
reorganization_ draft_ slice - decode_
reorganization_ plan - decode_
reorganization_ plan_ slice - initialize
- Apply an approved initialization plan without overwriting user-owned files.
- initialize_
with_ expected_ plan_ digest - Apply the exact read-only Core plan only when its digest is the one the caller approved.
- inspect
- Inspect an unmanaged folder without reading user file contents or changing it.
- list_
templates - list_
workspace - Return a deterministic flat projection of an ordinary folderbase folder.
- load_
builtin_ template - Load one exact built-in template from bytes embedded in the core binary.
- load_
template - plan_
initialization - Produce a complete, read-only plan for adopting an existing folder.
- plan_
migration - Turn a read-only analysis and founder answers into an explicit proposal.
- plan_
protocol_ upgrade - plan_
template_ expansion - plan_
template_ initialization - Produce a complete, read-only plan for adopting an ordinary folder with a validated, exact-version template package and typed answers.
- preview_
migration - propose_
change_ set - read_
workspace_ text - Read one existing, regular UTF-8 document without changing the folderbase.
- render_
template - reorganization_
analysis_ scope_ sha256 - reorganization_
plan_ sha256 - rollback_
migration - Roll back only additive, unchanged paths recorded by a verified migration.
- save_
workspace_ text - Optimistically replace one existing UTF-8 file and durably version both sides of the accepted save.
- seal_
reorganization_ draft - template_
application_ history - template_
package_ sha256 - validate
- Validate a folderbase without modifying or repairing it.
- validate_
reorganization_ draft - validate_
reorganization_ plan