Documentation
Build #577892 2022-06-17 19:58:30
# rustc version
rustc 1.63.0-nightly (cacc75c82 2022-06-16)# docs.rs version
docsrs 0.6.0 (c280b04 2022-05-30)# build log
[INFO] running `Command { std: "docker" "create" "-v" "/home/cratesfyi/workspace/builds/apyee-0.2.1/target:/opt/rustwide/target:rw,Z" "-v" "/home/cratesfyi/workspace/builds/apyee-0.2.1/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" "3221225472" "--cpus" "3" "--user" "1001:1001" "--network" "none" "ghcr.io/rust-lang/crates-build-env/linux@sha256:d190cb871061d98bc6d0581d85cb2ecb09a0f8a142ba5463de30be9999fc3251" "/opt/rustwide/cargo-home/bin/cargo" "+nightly" "rustdoc" "--lib" "-Zrustdoc-map" "-Z" "unstable-options" "--config" "build.rustdocflags=[\"-Z\", \"unstable-options\", \"--emit=invocation-specific\", \"--resource-suffix\", \"-20220616-1.63.0-nightly-cacc75c82\", \"--static-root-path\", \"/\", \"--cap-lints\", \"warn\", \"--disable-per-crate-search\", \"--extern-html-root-takes-precedence\"]" "-Zunstable-options" "--config=doc.extern-map.registries.crates-io=\"https://docs.rs/{pkg_name}/{version}/x86_64-unknown-linux-gnu\"" "-j3" "--target" "x86_64-unknown-linux-gnu", kill_on_drop: false }`
[INFO] [stdout] 62eedc16e752b5deaac31a932088f728d06f0a86572f749b37d367ad83f627b0
[INFO] [stderr] WARNING: Your kernel does not support swap limit capabilities or the cgroup is not mounted. Memory limited without swap.
[INFO] running `Command { std: "docker" "start" "-a" "62eedc16e752b5deaac31a932088f728d06f0a86572f749b37d367ad83f627b0", kill_on_drop: false }`
[INFO] [stderr]  Documenting apyee v0.2.1 (/opt/rustwide/workdir)
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]  --> src/lib.rs:4:1
[INFO] [stderr]   |
[INFO] [stderr] 4 | //! Yeelight API
[INFO] [stderr]   | ^^^^^^^^^^^^^^^^
[INFO] [stderr]   |
[INFO] [stderr] note: the lint level is defined here
[INFO] [stderr]  --> src/lib.rs:2:9
[INFO] [stderr]   |
[INFO] [stderr] 2 | #![deny(rustdoc::missing_doc_code_examples)]
[INFO] [stderr]   |         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]  --> src/lib.rs:6:1
[INFO] [stderr]   |
[INFO] [stderr] 6 | /// Commands and their responses which are sent and received from the [`crate::device::Device`].
[INFO] [stderr]   | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]   --> src/command.rs:13:1
[INFO] [stderr]    |
[INFO] [stderr] 13 | / /// A command to be sent to a device, containing a unique ID which is echoed back by the response.
[INFO] [stderr] 14 | | /// The command is serialized to JSON and sent to the device.
[INFO] [stderr] 15 | | ///
[INFO] [stderr] 16 | | /// [`Command`]s are created using the [`Command::new`] function.
[INFO] [stderr]    | |_________________________________________________________________^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]   --> src/command.rs:29:1
[INFO] [stderr]    |
[INFO] [stderr] 29 | / impl Command {
[INFO] [stderr] 30 | |     /// Creates a new command with a unique ID and a [`Method`].
[INFO] [stderr] 31 | |     pub fn new(id: usize, method: Method) -> Self {
[INFO] [stderr] 32 | |         Self {
[INFO] [stderr] ...  |
[INFO] [stderr] 37 | |     }
[INFO] [stderr] 38 | | }
[INFO] [stderr]    | |_^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]   --> src/command.rs:30:5
[INFO] [stderr]    |
[INFO] [stderr] 30 |     /// Creates a new command with a unique ID and a [`Method`].
[INFO] [stderr]    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]   --> src/command.rs:40:1
[INFO] [stderr]    |
[INFO] [stderr] 40 | /// A response from a device, containing the echoed ID of the Command, a result and optional Error.
[INFO] [stderr]    | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]   --> src/command.rs:51:1
[INFO] [stderr]    |
[INFO] [stderr] 51 | /// The result of a [`Command`].
[INFO] [stderr]    | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]   --> src/command.rs:59:1
[INFO] [stderr]    |
[INFO] [stderr] 59 | /// The error of a [`Command`], containing a error code and a description.
[INFO] [stderr]    | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]  --> src/lib.rs:8:1
[INFO] [stderr]   |
[INFO] [stderr] 8 | /// The [`crate::device::Device`] itself, used to interact with the Yeelight device.
[INFO] [stderr]   | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]   --> src/device.rs:21:1
[INFO] [stderr]    |
[INFO] [stderr] 21 | /// Errors that can occur when interacting with a Yeelight Bulb
[INFO] [stderr]    | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]   --> src/device.rs:87:1
[INFO] [stderr]    |
[INFO] [stderr] 87 | /// A Yeelight device.
[INFO] [stderr]    | ^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/device.rs:102:1
[INFO] [stderr]     |
[INFO] [stderr] 102 | / impl Device {
[INFO] [stderr] 103 | |     /// Creates a new device with ip and port.
[INFO] [stderr] 104 | |     /// The device will connect to the device at the given IP address and port.
[INFO] [stderr] 105 | |     /// If the connection fails, the function will return an error.
[INFO] [stderr] ...   |
[INFO] [stderr] 286 | |     }
[INFO] [stderr] 287 | | }
[INFO] [stderr]     | |_^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/device.rs:169:5
[INFO] [stderr]     |
[INFO] [stderr] 169 | /     /// Converts u8 RGB values into the i32 RGB format used by the Yeelight device.\
[INFO] [stderr] 170 | |     /// The i32 RGB format is a 24-bit integer with the red, green, and blue values packed into a single integer.
[INFO] [stderr] 171 | |     ///
[INFO] [stderr] 172 | |     /// # Arguments
[INFO] [stderr] 173 | |     /// * `r` - The red value.
[INFO] [stderr] 174 | |     /// * `g` - The green value.
[INFO] [stderr] 175 | |     /// * `b` - The blue value.
[INFO] [stderr]     | |_______________________________^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/device.rs:180:5
[INFO] [stderr]     |
[INFO] [stderr] 180 | /     /// Sets the color of the device, given as separate u8 RGB values.
[INFO] [stderr] 181 | |     ///
[INFO] [stderr] 182 | |     /// # Arguments
[INFO] [stderr] 183 | |     /// * `r` - The red value.
[INFO] [stderr] 184 | |     /// * `g` - The green value.
[INFO] [stderr] 185 | |     /// * `b` - The blue value.
[INFO] [stderr]     | |_______________________________^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/device.rs:191:5
[INFO] [stderr]     |
[INFO] [stderr] 191 | /     /// Sets the background color of the device, given as separate u8 RGB values.
[INFO] [stderr] 192 | |     ///
[INFO] [stderr] 193 | |     /// # Arguments
[INFO] [stderr] 194 | |     /// * `r` - The red value.
[INFO] [stderr] 195 | |     /// * `g` - The green value.
[INFO] [stderr] 196 | |     /// * `b` - The blue value.
[INFO] [stderr]     | |_______________________________^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/device.rs:202:5
[INFO] [stderr]     |
[INFO] [stderr] 202 | /     /// Toggles the devices power state.
[INFO] [stderr] 203 | |     /// If the device is on, it will be turned off.
[INFO] [stderr] 204 | |     /// If the device is off, it will be turned on.
[INFO] [stderr]     | |___________________________________________________^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/device.rs:209:5
[INFO] [stderr]     |
[INFO] [stderr] 209 |     /// Sets the power state of the device to on.
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/device.rs:214:5
[INFO] [stderr]     |
[INFO] [stderr] 214 |     /// Sets the power state of the device to off.
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/device.rs:219:5
[INFO] [stderr]     |
[INFO] [stderr] 219 |     /// Executes a given [`Method`] on the device by creating a new command with a unique id.
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/device.rs:226:5
[INFO] [stderr]     |
[INFO] [stderr] 226 |     /// Executes a given [`Command`] on the device.
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]   --> src/lib.rs:10:1
[INFO] [stderr]    |
[INFO] [stderr] 10 | /// The [`crate::method::Method`]s which are called on the Yeelight device.
[INFO] [stderr]    | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]  --> src/method.rs:5:1
[INFO] [stderr]   |
[INFO] [stderr] 5 | /// Methods to be called on a device.
[INFO] [stderr]   | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/method.rs:125:1
[INFO] [stderr]     |
[INFO] [stderr] 125 | /// The effect to use when setting a certain property.
[INFO] [stderr]     | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]   --> src/lib.rs:12:1
[INFO] [stderr]    |
[INFO] [stderr] 12 | /// The [`crate::property::Property`]s which are queried from the Yeelight device.
[INFO] [stderr]    | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]  --> src/property.rs:4:1
[INFO] [stderr]   |
[INFO] [stderr] 4 | /// Properties of a device.
[INFO] [stderr]   | ^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: `apyee` (lib doc) generated 25 warnings
[INFO] [stderr]     Finished dev [unoptimized + debuginfo] target(s) in 1.14s
[INFO] running `Command { std: "docker" "inspect" "62eedc16e752b5deaac31a932088f728d06f0a86572f749b37d367ad83f627b0", kill_on_drop: false }`
[INFO] running `Command { std: "docker" "rm" "-f" "62eedc16e752b5deaac31a932088f728d06f0a86572f749b37d367ad83f627b0", kill_on_drop: false }`
[INFO] [stdout] 62eedc16e752b5deaac31a932088f728d06f0a86572f749b37d367ad83f627b0