diff options
author | Isis Lovecruft <isis@torproject.org> | 2018-03-27 02:41:25 +0000 |
---|---|---|
committer | Isis Lovecruft <isis@torproject.org> | 2018-04-02 19:20:36 +0000 |
commit | fc2a42cc49fdcab9bbc0d90212c3c7bebda238b8 (patch) | |
tree | 45666de3c52ded8e371426a4d8cd58e8f7b89bbf /src/test | |
parent | 9766d53cf990432f25fb70916fe9b165f1d4a36d (diff) | |
download | tor-fc2a42cc49fdcab9bbc0d90212c3c7bebda238b8.tar.gz tor-fc2a42cc49fdcab9bbc0d90212c3c7bebda238b8.zip |
rust: Refactor protover::compute_for_old_tor().
During code review and discussion with Chelsea Komlo, she pointed out
that protover::compute_for_old_tor() was a public function whose
return type was `&'static CStr`. We both agree that C-like parts of
APIs should:
1. not be exposed publicly (to other Rust crates),
2. only be called in the appropriate FFI code,
3. not expose types which are meant for FFI code (e.g. `*mut char`,
`CString`, `*const c_int`, etc.) to the pure-Rust code of other
crates.
4. FFI code (e.g. things in `ffi.rs` modules) should _never_ be called
from pure-Rust, not even from other modules in its own crate
(i.e. do not call `protover::ffi::*` from anywhere in
`protover::protoset::*`, etc).
With that in mind, this commit makes the following changes:
* CHANGE `protover::compute_for_old_tor()` to be
visible only at the `pub(crate)` level.
* RENAME `protover::compute_for_old_tor()` to
`protover::compute_for_old_tor_cstr()` to reflect the last change.
* ADD a new `protover::compute_for_old_tor()` function wrapper which
is public and intended for other Rust code to use, which returns a
`&str`.
Diffstat (limited to 'src/test')
0 files changed, 0 insertions, 0 deletions