cosmos: add experimental c wrapper around cosmos sdk #2906
Conversation
Cargo.toml
Outdated
| @@ -20,7 +20,7 @@ members = [ | |||
| "sdk/template/azure_template_core", | |||
| "sdk/template/azure_template", | |||
| "sdk/storage/azure_storage_common", | |||
| "sdk/storage/azure_storage_blob", | |||
| "sdk/storage/azure_storage_blob", "sdk/cosmos/cosmosclient", | |||
There was a problem hiding this comment.
Cargo new just sticks it on the end. Disappointing. Will fix!
There was a problem hiding this comment.
Make sure you install Even Better Toml and there are formatting instructions in the repo. Granted, you have to re-save it in VSCode.
analogrelay
requested review from
Pilchie,
kirankumarkolli,
tvaron3,
FabianMeiswinkel,
kundadebdatta,
nehrao1,
kushagraThapar,
RickWinter,
ronniegeraghty and
LarryOsterman
as code owners
There was a problem hiding this comment.
Pull Request Overview
This PR adds an experimental C wrapper around the Azure Cosmos DB SDK for Rust, introducing a new cosmosclient package that exports a C-compatible API. The goal is to explore publishing a C library version of the Cosmos DB SDK.
Key changes:
- New
cosmosclientcrate that builds both static and dynamic C libraries - C header generation using cbindgen with version information
- Basic C test infrastructure using CMake for validation
Reviewed Changes
Copilot reviewed 10 out of 11 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
sdk/cosmos/cosmosclient/src/lib.rs |
Core library implementation with C-compatible API and version function |
sdk/cosmos/cosmosclient/Cargo.toml |
Package configuration for building C libraries (cdylib/staticlib) |
sdk/cosmos/cosmosclient/build.rs |
Build script for generating C headers and build identifiers |
sdk/cosmos/cosmosclient/CMakeLists.txt |
CMake configuration for C test compilation and linking |
sdk/cosmos/cosmosclient/c_tests/version.c |
C test program to validate version consistency |
sdk/cosmos/azure_data_cosmos/Cargo.toml |
Added "c" feature for exposing additional types to C wrapper |
Cargo.toml |
Added cosmosclient to workspace members |
analogrelay
force-pushed
the
ashleyst/c-bindings
branch
from
b636a92 to
a663837
Compare
| @@ -0,0 +1,22 @@ | |||
| [package] | |||
| name = "cosmosclient" | |||
There was a problem hiding this comment.
possibly cosmos_c_client for disambiguation?
|
|
||
| const VERSION: &CStr = c_str!(env!("CARGO_PKG_VERSION")); | ||
|
|
||
| #[no_mangle] |
There was a problem hiding this comment.
This is a 100% style nit, but I generally prefer putting attributes after the rustdoc comment - since the attributes bind to the function I like putting them as close to the function declaration as I can.
Putting them before the rustdoc comment leads me to forget they exist :).
This is a bit of an experiment, but I'm game to merge it if @heaths and other Cosmos folks like it.
We want to explore the option of publishing a C library of the Azure Cosmos DB SDK for Rust. This PR adds the basic framework to start that effort:
cosmosclientthat depends onazure_data_cosmos. This package builds acdylibandstaticlibtarget (libcosmosclient.a/libcosmosclient.so/cosmosclient.dll/etc.) that exports a C-compatible API. For now, that API is extremely simple (cosmosclient_version).sdk/cosmos/cosmosclient/c_teststhat will be built and linked against the cosmosclient library. The tests are simple pass/fail programs. If the test returns a0exit code, it passed, otherwise, it failed.build.rsscript incosmosclientto producesdk/cosmos/cosmosclient/include/cosmosclient.h, which is a C header file defining the API surface ofcosmosclient. We should publish this as an artifact at some point, but for now it's there to be used by tests.