adder-codec-core 0.3.5

Core library for encoding/decoding ADΔER events
Documentation
Build #2354742 2025-07-27 08:59:55
# rustc version
rustc 1.90.0-nightly (ce5fdd7d4 2025-07-26)# docs.rs version
docsrs 0.6.0 (4b4a3779 2025-07-22)# build log
[INFO] running `Command { std: "docker" "create" "-v" "/home/cratesfyi/workspace/builds/adder-codec-core-0.3.5/target:/opt/rustwide/target:rw,Z" "-v" "/home/cratesfyi/workspace/builds/adder-codec-core-0.3.5/source:/opt/rustwide/workdir:ro,Z" "-v" "/home/cratesfyi/workspace/cargo-home:/opt/rustwide/cargo-home:ro,Z" "-v" "/home/cratesfyi/workspace/rustup-home:/opt/rustwide/rustup-home:ro,Z" "-e" "SOURCE_DIR=/opt/rustwide/workdir" "-e" "CARGO_TARGET_DIR=/opt/rustwide/target" "-e" "DOCS_RS=1" "-e" "CARGO_HOME=/opt/rustwide/cargo-home" "-e" "RUSTUP_HOME=/opt/rustwide/rustup-home" "-w" "/opt/rustwide/workdir" "-m" "6442450944" "--cpus" "6" "--user" "1001:1001" "--network" "none" "ghcr.io/rust-lang/crates-build-env/linux@sha256:cf8efcab8866f2cf4285301c7418e2f4f2a9b088c91ba69c40d5b659f81557f7" "/opt/rustwide/cargo-home/bin/cargo" "+nightly" "rustdoc" "--lib" "-Zrustdoc-map" "--config" "build.rustdocflags=[\"--cfg\", \"docsrs\", \"-Z\", \"unstable-options\", \"--emit=invocation-specific\", \"--resource-suffix\", \"-20250726-1.90.0-nightly-ce5fdd7d4\", \"--static-root-path\", \"/-/rustdoc.static/\", \"--cap-lints\", \"warn\", \"--extern-html-root-takes-precedence\"]" "--offline" "-Zunstable-options" "--config=doc.extern-map.registries.crates-io=\"https://docs.rs/{pkg_name}/{version}/x86_64-unknown-linux-gnu\"" "-Zrustdoc-scrape-examples" "-j6" "--target" "x86_64-unknown-linux-gnu", kill_on_drop: false }`
[INFO] [stderr] WARNING: Your kernel does not support swap limit capabilities or the cgroup is not mounted. Memory limited without swap.
[INFO] [stdout] 7a2d8ba05e0c37acfc7511ede8d7e64b173ff8d7e954e463ef42cff8d3e05f61
[INFO] running `Command { std: "docker" "start" "-a" "7a2d8ba05e0c37acfc7511ede8d7e64b173ff8d7e954e463ef42cff8d3e05f61", kill_on_drop: false }`
[INFO] [stderr] warning: target filter specified, but no targets matched; this is a no-op
[INFO] [stderr]  Documenting adder-codec-core v0.3.5 (/opt/rustwide/workdir)
[INFO] [stderr] warning: missing documentation for an enum
[INFO] [stderr]    --> src/lib.rs:196:1
[INFO] [stderr]     |
[INFO] [stderr] 196 | pub enum Mode {
[INFO] [stderr]     | ^^^^^^^^^^^^^
[INFO] [stderr]     |
[INFO] [stderr] note: the lint level is defined here
[INFO] [stderr]    --> src/lib.rs:1:9
[INFO] [stderr]     |
[INFO] [stderr] 1   | #![warn(missing_docs)]
[INFO] [stderr]     |         ^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing documentation for an enum
[INFO] [stderr]    --> src/lib.rs:208:1
[INFO] [stderr]     |
[INFO] [stderr] 208 | pub enum PixelMultiMode {
[INFO] [stderr]     | ^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing documentation for a variant
[INFO] [stderr]    --> src/lib.rs:209:5
[INFO] [stderr]     |
[INFO] [stderr] 209 |     Normal,
[INFO] [stderr]     |     ^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing documentation for a variant
[INFO] [stderr]    --> src/lib.rs:212:5
[INFO] [stderr]     |
[INFO] [stderr] 212 |     Collapse,
[INFO] [stderr]     |     ^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing documentation for a struct field
[INFO] [stderr]    --> src/codec/mod.rs:272:5
[INFO] [stderr]     |
[INFO] [stderr] 272 |     pub crf: Crf,
[INFO] [stderr]     |     ^^^^^^^^^^^^
[INFO] [stderr]     |
[INFO] [stderr] note: the lint level is defined here
[INFO] [stderr]    --> src/codec/mod.rs:1:9
[INFO] [stderr]     |
[INFO] [stderr] 1   | #![warn(missing_docs)]
[INFO] [stderr]     |         ^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing documentation for an associated function
[INFO] [stderr]    --> src/codec/mod.rs:276:5
[INFO] [stderr]     |
[INFO] [stderr] 276 |     pub fn default(plane: PlaneSize) -> Self {
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing documentation for a struct field
[INFO] [stderr]    --> src/codec/mod.rs:294:9
[INFO] [stderr]     |
[INFO] [stderr] 294 |         target_event_rate: f64,
[INFO] [stderr]     |         ^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing documentation for a constant
[INFO] [stderr]  --> src/codec/compressed/mod.rs:6:1
[INFO] [stderr]   |
[INFO] [stderr] 6 | pub const BLOCK_SIZE_BIG: usize = 64;
[INFO] [stderr]   | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing documentation for a constant
[INFO] [stderr]  --> src/codec/compressed/mod.rs:8:1
[INFO] [stderr]   |
[INFO] [stderr] 8 | pub const BLOCK_SIZE_BIG_AREA: usize = BLOCK_SIZE_BIG * BLOCK_SIZE_BIG;
[INFO] [stderr]   | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing documentation for a type alias
[INFO] [stderr]   --> src/codec/compressed/mod.rs:10:1
[INFO] [stderr]    |
[INFO] [stderr] 10 | pub type DResidual = i16;
[INFO] [stderr]    | ^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing documentation for a constant
[INFO] [stderr]   --> src/codec/compressed/mod.rs:11:1
[INFO] [stderr]    |
[INFO] [stderr] 11 | pub const DRESIDUAL_NO_EVENT: DResidual = 256;
[INFO] [stderr]    | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing documentation for a constant
[INFO] [stderr]   --> src/codec/compressed/mod.rs:12:1
[INFO] [stderr]    |
[INFO] [stderr] 12 | pub const DRESIDUAL_SKIP_CUBE: DResidual = 257;
[INFO] [stderr]    | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing documentation for a type alias
[INFO] [stderr]   --> src/codec/compressed/mod.rs:13:1
[INFO] [stderr]    |
[INFO] [stderr] 13 | pub type TResidual = i16;
[INFO] [stderr]    | ^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing documentation for an associated function
[INFO] [stderr]   --> src/codec/compressed/fenwick/mod.rs:18:5
[INFO] [stderr]    |
[INFO] [stderr] 18 |     pub fn new(n: usize) -> Self {
[INFO] [stderr]    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing documentation for a method
[INFO] [stderr]   --> src/codec/compressed/fenwick/mod.rs:76:5
[INFO] [stderr]    |
[INFO] [stderr] 76 |     pub fn len(&self) -> usize {
[INFO] [stderr]    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing documentation for a struct
[INFO] [stderr]    --> src/codec/compressed/fenwick/mod.rs:112:1
[INFO] [stderr]     |
[INFO] [stderr] 112 | pub struct ValueError(pub usize);
[INFO] [stderr]     | ^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing documentation for a struct
[INFO] [stderr]   --> src/codec/compressed/fenwick/context_switching.rs:10:1
[INFO] [stderr]    |
[INFO] [stderr] 10 | pub struct FenwickModel {
[INFO] [stderr]    | ^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing documentation for a method
[INFO] [stderr]   --> src/codec/compressed/fenwick/context_switching.rs:48:5
[INFO] [stderr]    |
[INFO] [stderr] 48 |     pub fn set_context(&mut self, context: usize) {
[INFO] [stderr]    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing documentation for a method
[INFO] [stderr]    --> src/codec/decoder.rs:260:5
[INFO] [stderr]     |
[INFO] [stderr] 260 |     pub fn get_compression_type(&self) -> EncoderType {
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing documentation for a struct field
[INFO] [stderr]   --> src/codec/encoder.rs:35:5
[INFO] [stderr]    |
[INFO] [stderr] 35 |     pub options: EncoderOptions,
[INFO] [stderr]    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing documentation for a method
[INFO] [stderr]    --> src/codec/encoder.rs:298:5
[INFO] [stderr]     |
[INFO] [stderr] 298 |     pub fn get_options(&self) -> EncoderOptions {
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing documentation for a struct
[INFO] [stderr]   --> src/codec/rate_controller.rs:24:1
[INFO] [stderr]    |
[INFO] [stderr] 24 | pub struct Crf {
[INFO] [stderr]    | ^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing documentation for a struct field
[INFO] [stderr]   --> src/codec/rate_controller.rs:34:5
[INFO] [stderr]    |
[INFO] [stderr] 34 |     pub plane: PlaneSize,
[INFO] [stderr]    |     ^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing documentation for a struct
[INFO] [stderr]   --> src/codec/rate_controller.rs:40:1
[INFO] [stderr]    |
[INFO] [stderr] 40 | pub struct CrfParameters {
[INFO] [stderr]    | ^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing documentation for an associated function
[INFO] [stderr]   --> src/codec/rate_controller.rs:56:5
[INFO] [stderr]    |
[INFO] [stderr] 56 |     pub fn new(crf: Option<u8>, plane: PlaneSize) -> Self {
[INFO] [stderr]    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing documentation for a method
[INFO] [stderr]   --> src/codec/rate_controller.rs:72:5
[INFO] [stderr]    |
[INFO] [stderr] 72 |     pub fn update_quality(&mut self, crf: u8) {
[INFO] [stderr]    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing documentation for a method
[INFO] [stderr]   --> src/codec/rate_controller.rs:81:5
[INFO] [stderr]    |
[INFO] [stderr] 81 |     pub fn override_c_thresh_baseline(&mut self, baseline: u8) {
[INFO] [stderr]    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing documentation for a method
[INFO] [stderr]   --> src/codec/rate_controller.rs:86:5
[INFO] [stderr]    |
[INFO] [stderr] 86 |     pub fn override_c_thresh_max(&mut self, max: u8) {
[INFO] [stderr]    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing documentation for a method
[INFO] [stderr]   --> src/codec/rate_controller.rs:91:5
[INFO] [stderr]    |
[INFO] [stderr] 91 |     pub fn override_c_increase_velocity(&mut self, velocity: u8) {
[INFO] [stderr]    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing documentation for a method
[INFO] [stderr]   --> src/codec/rate_controller.rs:96:5
[INFO] [stderr]    |
[INFO] [stderr] 96 |     pub fn override_feature_c_radius(&mut self, radius: u16) {
[INFO] [stderr]    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing documentation for a method
[INFO] [stderr]    --> src/codec/rate_controller.rs:101:5
[INFO] [stderr]     |
[INFO] [stderr] 101 |     pub fn get_parameters(&self) -> &CrfParameters {
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing documentation for a method
[INFO] [stderr]    --> src/codec/rate_controller.rs:105:5
[INFO] [stderr]     |
[INFO] [stderr] 105 |     pub fn get_parameters_mut(&mut self) -> &mut CrfParameters {
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing documentation for a method
[INFO] [stderr]    --> src/codec/rate_controller.rs:109:5
[INFO] [stderr]     |
[INFO] [stderr] 109 |     pub fn get_quality(&self) -> Option<u8> {
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: unresolved link to `crate::Model`
[INFO] [stderr]  --> src/codec/compressed/fenwick/mod.rs:2:16
[INFO] [stderr]   |
[INFO] [stderr] 2 | //! [`Models`](crate::Model) implemented using Fenwick trees
[INFO] [stderr]   |                ^^^^^^^^^^^^ no item named `Model` in module `adder_codec_core`
[INFO] [stderr]   |
[INFO] [stderr]   = note: `#[warn(rustdoc::broken_intra_doc_links)]` on by default
[INFO] [stderr] 
[INFO] [stderr] warning: `adder-codec-core` (lib doc) generated 34 warnings
[INFO] [stderr]     Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.69s
[INFO] [stderr]    Generated /opt/rustwide/target/x86_64-unknown-linux-gnu/doc/adder_codec_core/index.html
[INFO] running `Command { std: "docker" "inspect" "7a2d8ba05e0c37acfc7511ede8d7e64b173ff8d7e954e463ef42cff8d3e05f61", kill_on_drop: false }`
[INFO] running `Command { std: "docker" "rm" "-f" "7a2d8ba05e0c37acfc7511ede8d7e64b173ff8d7e954e463ef42cff8d3e05f61", kill_on_drop: false }`
[INFO] [stdout] 7a2d8ba05e0c37acfc7511ede8d7e64b173ff8d7e954e463ef42cff8d3e05f61