mirrors/arti.git/crates/arti-rpc-client-core/arti-rpc-client-core.h, branch arti-v1.2.6mirror of https://gitlab.torproject.org/tpo/core/arti
http://git.dilluti0n.com/mirrors/arti.git/atom?h=arti-v1.2.62024-07-31T17:57:03Zffi: Re-run cbindgen.2024-07-31T17:57:03ZNick Mathewsonnickm@torproject.org2024-07-31T17:57:03Zurn:sha1:4497317f07df7a0f13bddc4e7a7727dbe12532b9rpclib: Suggestions from @diziet for improving safety docs.2024-07-31T17:54:16ZNick Mathewsonnickm@torproject.org2024-07-25T17:27:04Zurn:sha1:dcea09531b9e4b5e272001a5ebd8592e9d47ab3frpclib ffi: Grand identifier renaming2024-07-31T17:54:16ZNick Mathewsonnickm@torproject.org2024-07-25T15:06:54Zurn:sha1:851cd0a7032b7bcc2689c36afed7a5ef1b820326
In brief: Everything now starts with ARTI_RPC, arti_rpc, or ArtiRpc.
rpclib: Revise/condense "safety" docs for C functions2024-07-31T17:54:16ZNick Mathewsonnickm@torproject.org2024-07-25T14:40:04Zurn:sha1:a9334b3cb2a60387ede0c3a83bb348ecd25f5cc9
These documents are no longer called "safety". They are now mostly
collected as a big list of "correctness requirements" at the start
of the cbindgen header. Because of these requirements, most
functions no longer need their own "safety" sections.
I am explicitly using `#[allow(clippy::missing_safety_doc)]` on each
function, rather than adding a blanket exception:
- There are other unsafe functions in this code, to which we
wouldn't want an exception to apply.
- Documenting the safety^W correctness requirements of a function
is important enough to make sure that we aren't skipping out on
it unintentionally.
rpclib: Grand error refactoring: outparam, not thread-local2024-07-31T17:54:16ZNick Mathewsonnickm@torproject.org2024-07-25T13:52:56Zurn:sha1:6b1f266a8405d7c07b10e5cf2b153c575e6f2288
Per discussion, we'd rather have an optional output parameter for error
objects rather than mess with thread-local variables.
This is possibly less convenient for direct usage from C,
but likely more convenient for wrapper functions in other languages.
rpclib: _Sketch_ of string API.2024-07-31T17:54:16ZNick Mathewsonnickm@torproject.org2024-07-24T19:13:40Zurn:sha1:5265d6c1aa3c14ef09d908c9695eb1f003253d33
In this API, borrowed strings are `const char *`, and owned strings
are `ArtiRpcStr *`. You can get the former from the latter with
`arti_rpc_str_get()`, which returns a `const char *` in hopes that
you will neither modify nor free() that `const char *`
(Note that there are no places where string ownership needs to be
passed into this library; and at present, there is only one case
where it is passed out. I do not anticipate that we will need to do
intake of owned strings. We will probably need to return these in a
few more cases as we add more API surface.)
rpclib: Add "STATUS" to status codes.2024-07-31T17:54:16ZNick Mathewsonnickm@torproject.org2024-07-24T16:15:42Zurn:sha1:dff5ea987108214fe2b5fd66aab2742a5167204drpc: Improve documentation and strings for FFI status codes.2024-07-31T17:54:16ZNick Mathewsonnickm@torproject.org2024-07-24T16:10:59Zurn:sha1:ae026e5db079e595872bbab974b238aeb18b4945rpclib: Tweaks from review to header documentation.2024-07-31T17:54:16ZNick Mathewsonnickm@torproject.org2024-07-24T15:54:10Zurn:sha1:d2ed3d0ad0ed5bf7c0a45f722798cd54ab02b200rpc ffi: Try a more reference-driven approach to pointer handling.2024-07-31T17:54:16ZNick Mathewsonnickm@torproject.org2024-07-17T18:49:55Zurn:sha1:7e48f725dd665c5ff6eb07f16bd4957274767f6c