Skip to content

README.md

Latest commit

 

History

History
111 lines (83 loc) · 5.67 KB

README.md

File metadata and controls

111 lines (83 loc) · 5.67 KB

Dhara Storage

dhara_storage on crates.io dhara_storage_dal on crates.io License: Apache-2.0

Dhara Storage is a Rust-first storage runtime with a Windows-first delivery story. It combines definition-driven file analysis, path-based file and directory operations, debounced watching, a FlatBuffers-backed definitions data layer, and a managed .NET wrapper over the native core.

Rust crates and the Dhara.Storage NuGet package are versioned together from shared release metadata. The current publish target is 0.7.0.

Workspace

Project Purpose
src/core/dhara_storage_dal FlatBuffers data access layer; runtime defs at tooling/output/filedefs.dat
src/core/dhara_storage Rust-native runtime for analysis, metadata, operations, navigation, and watching
src/dharastorage Thin C ABI over dhara_storage for managed and native hosts
src/bindings/Dhara.Storage net10.0 wrapper over dharastorage
tooling/dhara_tool Operator CLI for verification, packaging, release, and defs workflows

Highlights

  • Rust-native public API in dhara_storage, not a class-for-class port of the legacy C# model
  • Bundled filedefs.dat runtime package for content-based file analysis
  • File and directory operations that keep the simple path fast and opt into progress only when needed
  • Debounced directory watching for stable change notifications
  • Structured logging with tracing in Rust, native log forwarding through dharastorage, and host integration through Microsoft.Extensions.Logging
  • Multi-runtime NuGet packaging for Windows win-x64 and win-arm64

Quick Start

Rust runtime:

[dependencies]
dhara_storage = "0.7.0"
use dhara_storage::{FileStorage, analyze_path};

let report = analyze_path("sample.pdf")?;
let bytes = FileStorage::from_existing("sample.pdf")?.read()?;
# Ok::<(), dhara_storage::StorageError>(())

.NET wrapper:

dotnet add package Dhara.Storage --version 0.7.0
using Microsoft.Extensions.Logging;
using Dhara.Storage;

using var loggerFactory = LoggerFactory.Create(builder => builder.AddConsole());
DharaStorage.UseLoggerFactory(loggerFactory);

var file = DharaStorage.File(@"C:\data\sample.pdf");
var analysis = file.Analyze();
var bytes = await file.ReadBytesAsync();

Tooling:

cargo run -p dhara_tool -- verify ci
cargo run -p dhara_tool -- verify package
cargo run -p dhara_tool -- release run --dry-run

Support Matrix

Surface Status
dhara_storage_dal Shared FlatBuffers definitions DAL
dhara_storage Windows-first runtime; portable where the underlying functionality naturally is
dharastorage Windows-first native ABI
Dhara.Storage NuGet package Windows win-x64 and win-arm64 only

The NuGet package now fails clearly during package consumption for unsupported RIDs such as win-x86, and the managed wrapper also throws a PlatformNotSupportedException when loaded outside Windows x64 or arm64.

Logging

  • Rust crates emit structured tracing events for analysis, metadata loading, operations, watching, package verification, and release flows.
  • dharastorage exposes a native logger registration API that forwards JSON log records across the ABI.
  • Dhara.Storage forwards both managed wrapper logs and native runtime logs into a host ILoggerFactory.
  • dhara_tool now emits richer command, configuration, transfer, and verification logs for release diagnostics.

Release Flow

  • Shared release metadata lives in dhara.config.toml.
  • Local secrets belong in .env.local, created from the example file.
  • tooling/dhara_tool is the supported operator surface for config sync, verification, packaging, and publish flows.
  • cargo run -p dhara_tool -- release run --dry-run validates the Cargo-first release flow without publishing.
  • cargo run -p dhara_tool -- release run publishes dhara_storage_dal and dhara_storage first, then publishes the Dhara.Storage NuGet package.
  • cargo run -p dhara_tool -- release run --skip-cargo publishes only the NuGet package when the Rust crates for the current version already exist.
  • NuGet verification checks that both runtimes/win-x64/native/dharastorage.dll and runtimes/win-arm64/native/dharastorage.dll are present in the package.

Docs