Improve metadata annotations
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 58/100
Research direction
Start by tracing how the DirectStorage API metadata represents IDStorageFactory::SetDebugFlags::flags and the IDStorageQueue output pointers. Apply the three mappings shown in the issue, then compare generated windows-rs signatures with the direct-storage-rs commit to confirm the enum and returned-object annotations are reflected.
Written by the indexing model from the issue text.
Description
It's great to have winmd metadata available 🎉 but a few type annotations are missing.
IDStorageFactory::SetDebugFlags::flags should be DSTORAGE_DEBUG. And IDStorageQueue has non-optional output pointers, that don't seem to be properly represented in the metadata and cause windows-rs to generate a by-mutable-reference getter rather than allocating and returning the object.
All of that is solved with the following mapping.
--memberRemap
IDStorageFactory::SetDebugFlags::flags=[AssociatedEnum("DSTORAGE_DEBUG")]
IDStorageQueue::RetrieveErrorRecord::record=[RetVal]
IDStorageQueue::Query::info=[RetVal]
https://github.com/Tsukisoft/direct-storage-rs/commit/6a7f8c5d7e8b744bcf6f744ae661f8018528b6bf
- Dominant language
- C++
- Stars
- 897
- Forks
- 111
- Avg merge
- 13h 58m
- Merged PRs (30d)
- 12
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from microsoft/DirectStorage
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
microsoft/DirectStorage#137 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
microsoft/DirectStorage#101 ·
-
can't compile? Open
Difficulty 4/5 3-5 days Newbie friendliness 20/100
microsoft/DirectStorage#58 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 42/100
microsoft/DirectStorage#56 · 1 comment ·
-
Difficulty 4/5 3-5 days Newbie friendliness 45/100
microsoft/DirectStorage#52 · 7 comments ·
All issues in microsoft/DirectStorage
Similar issues
-
ai_reviewed
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
ydb-platform/ydb#53869 · 3 comments ·
-
bug cert blocker needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
project-chip/connectedhomeip#74373 ·
-
upstream update
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
conan-io/conan-center-index#31035 ·
-
Bug
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
documentation
Difficulty 1/5 Under an hour Newbie friendliness 85/100
vllm-project/vllm-ascend#17329 ·