docs(client_core): 📝 Fix C API documentation #4566
Annotations
10 warnings
|
alvr/common/src/logging.rs#L217
warning: the borrowed expression implements the required traits
--> alvr/common/src/logging.rs:217:30
|
217 | .set_description(&w.to_string())
| ^^^^^^^^^^^^^^ help: change this to: `w.to_string()`
|
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#needless_borrows_for_generic_args
= note: `#[warn(clippy::needless_borrows_for_generic_args)]` on by default
|
|
alvr/xtask/src/packaging.rs#L20
warning: function `build_windows_installer` is never used
--> alvr/xtask/src/packaging.rs:20:4
|
20 | fn build_windows_installer() {
| ^^^^^^^^^^^^^^^^^^^^^^^
|
= note: `#[warn(dead_code)]` on by default
|
|
alvr/audio/src/linux.rs#L220
warning: this returns a `Result<_, ()>`
--> alvr/audio/src/linux.rs:220:1
|
220 | / pub fn record_audio_blocking_pipewire(
221 | | is_running: Arc<dyn Fn() -> bool + Send + Sync>,
222 | | sender: StreamSender<()>,
223 | | channels_count: u16,
224 | | sample_rate: u32,
225 | | ) -> Result<(), ()> {
| |___________________^
|
= help: use a custom `Error` type instead
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#result_unit_err
= note: `#[warn(clippy::result_unit_err)]` on by default
|
|
alvr/client_core/src/c_api.rs#L62
warning: fields `view_width`, `view_height`, `refresh_rate_hint`, `encoding_gamma`, `enable_foveated_encoding`, and `enable_hdr` are never read
--> alvr/client_core/src/c_api.rs:62:9
|
61 | StreamingStarted {
| ---------------- fields in this variant
62 | view_width: u32,
| ^^^^^^^^^^
63 | view_height: u32,
| ^^^^^^^^^^^
64 | refresh_rate_hint: f32,
| ^^^^^^^^^^^^^^^^^
65 | encoding_gamma: f32,
| ^^^^^^^^^^^^^^
66 | enable_foveated_encoding: bool,
| ^^^^^^^^^^^^^^^^^^^^^^^^
67 | enable_hdr: bool,
| ^^^^^^^^^^
|
= note: `#[warn(dead_code)]` on by default
|
|
alvr/client_core/src/c_api.rs#L71
warning: fields `device_id`, `duration_s`, `frequency`, and `amplitude` are never read
--> alvr/client_core/src/c_api.rs:71:9
|
70 | Haptics {
| ------- fields in this variant
71 | device_id: u64,
| ^^^^^^^^^
72 | duration_s: f32,
| ^^^^^^^^^^
73 | frequency: f32,
| ^^^^^^^^^
74 | amplitude: f32,
| ^^^^^^^^^
|
|
alvr/client_core/src/c_api.rs#L78
warning: field `codec` is never read
--> alvr/client_core/src/c_api.rs:78:9
|
77 | DecoderConfig {
| ------------- field in this variant
78 | codec: AlvrCodec,
| ^^^^^
|
|
alvr/client_core/src/c_api.rs#L869
warning: variants `Float`, `Int32`, `Int64`, and `String` are never constructed
--> alvr/client_core/src/c_api.rs:869:5
|
868 | pub enum AlvrMediacodecPropType {
| ---------------------- variants in this enum
869 | Float,
| ^^^^^
870 | Int32,
| ^^^^^
871 | Int64,
| ^^^^^
872 | String,
| ^^^^^^
|
|
alvr/client_core/src/connection.rs#L65
warning: very complex type used. Consider factoring parts into `type` definitions
--> alvr/client_core/src/connection.rs:65:27
|
65 | pub decoder_callback: Mutex<Option<Box<dyn FnMut(Duration, &[u8]) -> bool + Send>>>,
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#type_complexity
= note: `#[warn(clippy::type_complexity)]` on by default
|
|
alvr/client_core/src/lib.rs#L312
warning: very complex type used. Consider factoring parts into `type` definitions
--> alvr/client_core/src/lib.rs:312:19
|
312 | callback: Box<dyn FnMut(Duration, &[u8]) -> bool + Send>,
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#type_complexity
|
|
alvr/client_core/src/lib.rs#L364
warning: returning the result of a `let` binding from a block
--> alvr/client_core/src/lib.rs:364:9
|
353 | / let view_params = [
354 | | ViewParams {
355 | | pose: head_pose * view_params[0].pose,
356 | | fov: view_params[0].fov,
... |
361 | | },
362 | | ];
| |__________- unnecessary `let` binding
363 |
364 | view_params
| ^^^^^^^^^^^
|
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#let_and_return
= note: `#[warn(clippy::let_and_return)]` on by default
help: return the expression directly
|
353 ~
354 |
355 ~ [
356 + ViewParams {
357 + pose: head_pose * view_params[0].pose,
358 + fov: view_params[0].fov,
359 + },
360 + ViewParams {
361 + pose: head_pose * view_params[1].pose,
362 + fov: view_params[1].fov,
363 + },
364 + ]
|
|
This job succeeded
Loading