Expand description
Windows Cloud Files bindings for the product-neutral Forge cloud-files core.
This crate owns CFAPI-specific item/sync-root identity encoding, placeholder metadata, filename
validation, persistent registration policies, active connection/session fencing, owned
FETCH_DATA/CANCEL_FETCH_DATA snapshots, bounded callback ingress, active hydration waiter
cancellation, and native calls. Product authentication, remote DTOs, account policy,
persistence adapters, and user-visible error mapping remain in product crates.
Structs§
- Windows
Callback Info Snapshot - Owned common data copied from
CF_CALLBACK_INFObefore the callback returns. - Windows
Callback Lease - Non-cloneable ownership proof for one callback accepted before the closing fence.
- Windows
Callback Queue Metrics - Bounded callback-ingress counters for one native connection generation.
- Windows
Callback Range - Owned CFAPI callback range preserving the native
CF_EOFdistinction. - Windows
Cancel Fetch Data Flags - Bitset copied from
CF_CALLBACK_CANCEL_FLAGS. - Windows
Cancel Fetch Data Request - Accepted cancellation notification plus its non-cloneable active-session lease.
- Windows
Cancel Fetch Data Snapshot - Owned
CANCEL_FETCH_DATAcallback snapshot. - Windows
Connection Key - Opaque native connection key returned by
CfConnectSyncRoot. - Windows
Connection Session - Shareable lifecycle fence for one active native connection generation.
- Windows
Fetch Data Cancellation Outcome - Per-callback result of matching one CFAPI cancellation range to active hydration waiters.
- Windows
Fetch Data Correlation - Compact scalar correlation needed by waiter lookup and
CfReportProviderProgress. - Windows
Fetch Data Flags - Bitset copied from
CF_CALLBACK_FETCH_DATA_FLAGS. - Windows
Fetch Data Progress - One provider progress sample for a pending CFAPI transfer.
- Windows
Fetch Data Progress Reporter - Cloneable correlation handle for reporting progress while the request itself is awaiting hydration. It owns no terminal completion authority.
- Windows
Fetch Data Request - Accepted hydration request plus its non-cloneable active-session lease.
- Windows
Fetch Data Snapshot - Owned
FETCH_DATAcallback snapshot. - Windows
Fetch Data Transfer - Owned logical bytes ready for one synchronous CFAPI transfer call.
- Windows
Fetch Data Waiter Metrics - Monotonic process-local counters for active fetch waiters and cancellation matching.
- Windows
Fetch Data Waiter Registry - Shareable active-waiter registry for one or more CFAPI connection generations.
- Windows
Fetch Data Watchdog - Deadline state for one pending fetch. The host supplies
Instantvalues, making tests deterministic without a Tokio timer or a background thread in the native callback path. - Windows
Fetch Data Watchdog Config - Host-controlled watchdog configuration for one pending fetch.
- Windows
Fetch Data Watchdog Outcome - Result of one host watchdog poll.
- Windows
File Identity - Owned, validated CFAPI file identity for one exact Forge item key.
- Windows
File Times - Windows file times expressed as signed 100-nanosecond intervals since the Windows epoch.
- Windows
Hydration Policy - Primary hydration behavior plus independently negotiated CFAPI modifiers.
- Windows
InSync Policy - Supported CFAPI in-sync tracking bits.
- Windows
Placeholder - Owned input for one
CfCreatePlaceholdersentry. - Windows
Placeholder Management Policy - Permissions granted to non-provider processes while the sync root is active.
- Windows
Placeholder Metadata - Owned CFAPI filesystem metadata for one placeholder.
- Windows
Placeholder Options - CFAPI placeholder creation options kept independent from windows-rs types.
- Windows
Platform Version - Detected CFAPI platform version used for gated policy validation.
- Windows
Preflight Request - Accepted preflight request with exactly one native acknowledgement responsibility.
- Windows
Process Info Snapshot - Owned process information requested through
CF_CONNECT_FLAG_REQUIRE_PROCESS_INFO. - Windows
Provider Id - Stable provider telemetry identity shared by every version and sync root of one provider.
- Windows
Request Key - Opaque request key used by newer CFAPI operation correlation.
- Windows
Restart Hydration - Product-neutral metadata replacement for one CFAPI
RESTART_HYDRATIONoperation. - Windows
Sync Root Connect Options - Additional callback metadata and implicit-hydration behavior requested at connect time.
- Windows
Sync Root Identity - Owned, versioned CFAPI sync-root identity for one exact Forge namespace/root scope.
- Windows
Sync Root Policies - Complete CFAPI sync-root policy set.
- Windows
Sync Root Registration - Owned persistent sync-root registration request.
- Windows
Sync Root Registration Options - Persistent registration flags independent from windows-rs values.
- Windows
Transfer Key - Opaque transfer key used by CFAPI to correlate hydration operations.
Enums§
- Windows
Callback Range Length - CFAPI callback range length.
- Windows
Callback Request - One immutable callback snapshot accepted by a specific connection generation.
- Windows
Cloud Files Error - Product-neutral classifications for Windows-specific mapping and native-call failures.
- Windows
Fetch Data Failure - Structured failure classifications accepted by the minimal fetch terminal path.
- Windows
Fetch Data Preparation - Portable outcome of waiting for one cancellation-registered CFAPI hydration request.
- Windows
Hard Link Policy - Whether placeholder hard links are permitted.
- Windows
Hydration Policy Primary - Hydration behavior requested from CFAPI.
- Windows
Observed Notification - Owned notification that CFAPI has already completed a local filesystem effect.
- Windows
Population Policy - Supported namespace population behavior.
- Windows
Preflight Snapshot - Owned CFAPI operation that blocks a local filesystem effect until the provider acknowledges it.
Constants§
- CFAPI_
FILE_ IDENTITY_ MAX_ BYTES - Maximum
FileIdentitysize accepted by Windows Cloud Files. - CFAPI_
MAX_ PRIORITY_ HINT - Maximum priority value documented by CFAPI.
- CFAPI_
SYNC_ ROOT_ IDENTITY_ MAX_ BYTES - Maximum
SyncRootIdentitysize accepted byCfRegisterSyncRoot. - CFAPI_
TRANSFER_ ALIGNMENT_ BYTES - Physical range alignment required by CFAPI transfer operations.
- FILE_
ATTRIBUTE_ DIRECTORY - Windows directory file-attribute bit.
- FILE_
ATTRIBUTE_ NORMAL - Windows normal-file attribute bit.
- WINDOWS_
CFAPI_ CALLBACK_ TIMEOUT - The fixed callback timeout documented by Windows CFAPI.
Type Aliases§
- Result
- Result type returned by the Windows cloud-files adapter.