Skip to main content

Crate folderbase_core

Crate folderbase_core 

Source
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§

AccessDecision
AccessRequest
AnalysisScope
ApprovedHistoryTransfer
ApprovedMigration
An approval token tied to a specific immutable plan digest.
AuthorizedPath
BoundaryHint
CaptureIgnoredPath
One path omitted by ordered Folderbase ignore policy.
CaptureLocalHead
A device-local pointer observed while planning.
CapturePlan
An opaque, read-only metadata inventory bound to one physical root.
CapturePlanEntry
One metadata-only inventory entry.
CapturePlanExclusion
One typed item that cannot become a v1 Path Binding.
CaptureResult
ChangeSetApplyResult
ChangeSetAssessment
ChangeSetAttention
ChangeSetAttentionDetail
ChangeSetConflict
ChangeSetEnvelope
ChangeSetPayload
CheckoutReceipt
CheckoutRequest
CheckoutResult
ClassifiedPath
ConsequentialQuestion
ContentDigest
DeltaDirectory
DeltaRegularFile
DeltaSymlink
FolderbaseQueryEngine
A root-bound handle for read-only query and explicit disposable-index work.
FolderbaseRegistration
FolderbaseRootAttestation
Evidence that one exact path is a well-formed Folderbase root.
FolderbaseVersionStore
Read-only handle for planning Folderbase Version capture.
HistoryTransferPlan
HistoryTransferResult
InitializationOptions
InitializationPlan
A previewable initialization plan that can only be created by the core.
InitializationPlanDigest
An opaque, Core-owned commitment to every semantically relevant decision in an initialization plan.
InitializationResult
InspectionReport
InventorySummary
LocalObjectRecord
Current materialization metadata for a tracked object.
LocalVersionRecord
Immutable metadata for one captured version.
LocalVersionStore
Filesystem-backed local version storage for one folderbase root.
MemorySyncCloud
In-memory implementation of the immutable cloud data-plane contract.
MigrationAnalysis
MigrationAnswer
MigrationAnswerException
MigrationConflict
MigrationCopyPreview
MigrationExclusion
MigrationExecution
The single semantic execution boundary for apply, recovery, and rollback.
MigrationOption
MigrationPlan
MigrationPreview
MigrationQuestion
MigrationResult
MigrationTarget
NestedBoundary
NestedFolderbaseBoundary
ObjectDelta
ObjectId
A stable object identity that does not depend on the object’s current path.
ObjectJournalEvent
One append-only journal line.
PlannedDirectory
PlannedTemplateAddition
PlannedWrite
PreservedPath
ProjectionExclusion
ProposedBoundary
ProtocolUpgradePlan
ProtocolUpgradePlanDigest
ProtocolUpgradeResult
QueryEntry
One query row.
QueryExclusion
One path omitted from ordinary query rows.
QueryExplain
Read-only explanation of one normalized query plan.
QueryIndexRebuildResult
Result of explicitly replacing the disposable private index.
QueryIndexStatus
Result of inspecting the private index without changing it.
QueryPageResult
Page metadata for a query result.
QueryRequest
One bounded query request.
QueryResult
One successful query page.
ReconstructableTree
ReorganizationDraft
ReorganizationPlan
RestoreResult
RestoredTombstone
Result of restoring the exact bytes named by one current-Head Tombstone.
RollbackResult
SealedCapture
Result of sealing or converging on one durable device-local Folderbase Version.
ShareGrant
SharingControlPlane
A deterministic authorization/control-plane model.
StagedContent
StagingIndex
StagingObject
SyncConflict
SyncEvent
SyncReplica
A deterministic logical device used by the native client and fault tests.
SyncReport
SyncVersion
TemplateApplicationCreatedPath
TemplateApplicationPreservedTarget
TemplateApplicationRecord
TemplateApplicationResult
TemplateArtifactPrecondition
TemplateDescriptor
TemplateExpansionPlan
A read-only preview of one template version’s guidance against a folderbase.
TemplatePackage
TemplatePlanDigest
TemplateQuestion
TemplateRenderPlan
TemplateStructuralChange
ValidationFinding
ValidationReport
VersionId
The identity of one immutable capture of an object’s bytes.
WorkspaceDocumentState
WorkspaceEntry
WorkspaceListing
WorkspaceSaveResult
WorkspaceTextDocument

Enums§

AccessReason
CaptureEntryKind
Metadata kind observed for a future live Path Binding.
CaptureExclusionKind
CaptureExclusionReason
CapturePlanLimitKind
ChangeSetApplyOutcome
ChangeSetAssessmentOutcome
ChangeSetError
Classification
ConflictClassification
ConsequentialAnswer
ConsequentialAnswerType
ContentKind
ContentReference
DeltaState
FolderbaseCaptureError
Failures that prevent a trustworthy metadata-only capture plan.
FolderbaseError
Errors that prevent an operation from producing a trustworthy result.
FolderbaseKind
FolderbaseRootMarker
A closed identifier for every marker required by root attestation.
HistoryTransferState
InitializationInventoryLimitKind
JournalAction
LocalHeadAuthority
The closed meaning of one Local Head authority digest.
MigrationCommand
MigrationConflictDirection
MigrationContentKind
MigrationOperation
MigrationOutcome
MigrationQuestionKind
MigrationState
MigrationTargetKind
NestedFolderbaseState
PathProfile
ProjectedEntry
QueryEntryKind
Filesystem kind exposed by query 0.1.
QueryError
Typed failures from query/index Core operations.
QueryExclusionKind
Optional type attached to an explainable exclusion.
QueryExecution
How the selected observation was evaluated.
QueryIndexState
Read-only state of the disposable private query index.
QueryLifecycle
Lifecycle exposed by query 0.1.
QuerySource
Source observation from which a query row was projected.
ReorganizationOperation
RootAttestationError
Failures produced while attesting one exact Folderbase root.
RootClaim
The caller-selected Folderbase root for one migration command.
ScopeEntry
SharePermission
ShareScope
StructuralChangesPolicy
TemplateAnswerType
TemplateAnswerValue
TemplateApplicationState
TemplateArtifactKind
TemplateComparisonSource
TemplateStructuralChangeKind
ValidationLevel
ValidationSeverity
WorkspaceEntryKind

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_INFO root 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

Type Aliases§

Result