rustwlc 0.7.0

wlc Wayland library bindings for Rust
Documentation
Build #2147252 2025-05-24 01:44:33
# rustc version
rustc 1.89.0-nightly (3e674b06b 2025-05-23)# docs.rs version
docsrs 0.6.0 (107722ec 2025-05-23)# build log
[INFO] running `Command { std: "docker" "create" "-v" "/home/cratesfyi/workspace-builder/builds/rustwlc-0.7.0/target:/opt/rustwide/target:rw,Z" "-v" "/home/cratesfyi/workspace-builder/builds/rustwlc-0.7.0/source:/opt/rustwide/workdir:ro,Z" "-v" "/home/cratesfyi/workspace-builder/cargo-home:/opt/rustwide/cargo-home:ro,Z" "-v" "/home/cratesfyi/workspace-builder/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:eea15d5475069c3ef791f10c2c6b5af2ee421ef2da1e680ecce1cba46243983b" "/opt/rustwide/cargo-home/bin/cargo" "+nightly" "rustdoc" "--lib" "-Zrustdoc-map" "--config" "build.rustdocflags=[\"--cfg\", \"docsrs\", \"-Z\", \"unstable-options\", \"--emit=invocation-specific\", \"--resource-suffix\", \"-20250523-1.89.0-nightly-3e674b06b\", \"--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" "--config" "build.rustdocflags=[\"-Zmetrics-dir=/opt/rustwide/target/metrics\"]", 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] 37a9f0d42f81f28c03d65e42ea1a924c5b19901ad9a2e88c2a21a3f17990a326
[INFO] running `Command { std: "docker" "start" "-a" "37a9f0d42f81f28c03d65e42ea1a924c5b19901ad9a2e88c2a21a3f17990a326", kill_on_drop: false }`
[INFO] [stderr] warning: no edition set: defaulting to the 2015 edition while the latest is 2024
[INFO] [stderr] warning: Rustdoc did not scrape the following examples because they require dev-dependencies: simple
[INFO] [stderr]     If you want Rustdoc to scrape these examples, then add `doc-scrape-examples = true`
[INFO] [stderr]     to the [[example]] target configuration of at least one example.
[INFO] [stderr] warning: target filter specified, but no targets matched; this is a no-op
[INFO] [stderr]  Documenting rustwlc v0.7.0 (/opt/rustwide/workdir)
[INFO] [stderr] warning: variant `WLC_RGBA8888` should have an upper camel case name
[INFO] [stderr]   --> src/render.rs:15:5
[INFO] [stderr]    |
[INFO] [stderr] 15 |     WLC_RGBA8888
[INFO] [stderr]    |     ^^^^^^^^^^^^ help: convert the identifier to upper camel case: `WlcRgba8888`
[INFO] [stderr]    |
[INFO] [stderr]    = note: `#[warn(non_camel_case_types)]` on by default
[INFO] [stderr] 
[INFO] [stderr] warning: variant `WLC_RENDERER_GLES2` should have an upper camel case name
[INFO] [stderr]   --> src/render.rs:23:5
[INFO] [stderr]    |
[INFO] [stderr] 23 |     WLC_RENDERER_GLES2,
[INFO] [stderr]    |     ^^^^^^^^^^^^^^^^^^ help: convert the identifier to upper camel case: `WlcRendererGles2`
[INFO] [stderr] 
[INFO] [stderr] warning: variant `WLC_NO_RENDERER` should have an upper camel case name
[INFO] [stderr]   --> src/render.rs:25:5
[INFO] [stderr]    |
[INFO] [stderr] 25 |     WLC_NO_RENDERER
[INFO] [stderr]    |     ^^^^^^^^^^^^^^^ help: convert the identifier to upper camel case: `WlcNoRenderer`
[INFO] [stderr] 
[INFO] [stderr] warning: variant `SURFACE_RGB` should have an upper camel case name
[INFO] [stderr]   --> src/render.rs:32:5
[INFO] [stderr]    |
[INFO] [stderr] 32 |     SURFACE_RGB,
[INFO] [stderr]    |     ^^^^^^^^^^^ help: convert the identifier to upper camel case: `SurfaceRgb`
[INFO] [stderr] 
[INFO] [stderr] warning: variant `SURFACE_RGBA` should have an upper camel case name
[INFO] [stderr]   --> src/render.rs:33:5
[INFO] [stderr]    |
[INFO] [stderr] 33 |     SURFACE_RGBA,
[INFO] [stderr]    |     ^^^^^^^^^^^^ help: convert the identifier to upper camel case: `SurfaceRgba`
[INFO] [stderr] 
[INFO] [stderr] warning: variant `SURFACE_EGL` should have an upper camel case name
[INFO] [stderr]   --> src/render.rs:34:5
[INFO] [stderr]    |
[INFO] [stderr] 34 |     SURFACE_EGL,
[INFO] [stderr]    |     ^^^^^^^^^^^ help: convert the identifier to upper camel case: `SurfaceEgl`
[INFO] [stderr] 
[INFO] [stderr] warning: variant `SURFACE_Y_UV` should have an upper camel case name
[INFO] [stderr]   --> src/render.rs:35:5
[INFO] [stderr]    |
[INFO] [stderr] 35 |     SURFACE_Y_UV,
[INFO] [stderr]    |     ^^^^^^^^^^^^ help: convert the identifier to upper camel case: `SurfaceYUv`
[INFO] [stderr] 
[INFO] [stderr] warning: variant `SURFACE_Y_U_V` should have an upper camel case name
[INFO] [stderr]   --> src/render.rs:36:5
[INFO] [stderr]    |
[INFO] [stderr] 36 |     SURFACE_Y_U_V,
[INFO] [stderr]    |     ^^^^^^^^^^^^^ help: convert the identifier to upper camel case: `SurfaceYUV`
[INFO] [stderr] 
[INFO] [stderr] warning: variant `SURFACE_Y_XUXV` should have an upper camel case name
[INFO] [stderr]   --> src/render.rs:37:5
[INFO] [stderr]    |
[INFO] [stderr] 37 |     SURFACE_Y_XUXV,
[INFO] [stderr]    |     ^^^^^^^^^^^^^^ help: convert the identifier to upper camel case: `SurfaceYXuxv`
[INFO] [stderr] 
[INFO] [stderr] warning: missing documentation for a function
[INFO] [stderr]    --> src/callback.rs:630:1
[INFO] [stderr]     |
[INFO] [stderr] 630 | pub fn positioner_get_gravity(view: WlcView) -> PositionerGravityBit {
[INFO] [stderr]     | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]     |
[INFO] [stderr] note: the lint level is defined here
[INFO] [stderr]    --> src/lib.rs:59:9
[INFO] [stderr]     |
[INFO] [stderr] 59  | #![warn(missing_docs)]
[INFO] [stderr]     |         ^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing documentation for a function
[INFO] [stderr]    --> src/callback.rs:636:1
[INFO] [stderr]     |
[INFO] [stderr] 636 | / pub fn positioner_get_constraint_adjustment(view: WlcView)
[INFO] [stderr] 637 | |                                             -> PositionerConstraintAdjustmentBits {
[INFO] [stderr]     | |_________________________________________________________________________________^
[INFO] [stderr] 
[INFO] [stderr] warning: missing documentation for a struct
[INFO] [stderr]    --> src/types.rs:166:1
[INFO] [stderr]     |
[INFO] [stderr] 166 | / bitflags! {
[INFO] [stderr] 167 | |     #[repr(C)]
[INFO] [stderr] 168 | |     pub flags PositionerAnchorBit: u32 {
[INFO] [stderr] 169 | |         const WLC_BIT_ANCHOR_NONE = 0,
[INFO] [stderr] ...   |
[INFO] [stderr] 175 | | }
[INFO] [stderr]     | |_^
[INFO] [stderr]     |
[INFO] [stderr]     = note: this warning originates in the macro `bitflags` (in Nightly builds, run with -Z macro-backtrace for more info)
[INFO] [stderr] 
[INFO] [stderr] warning: missing documentation for a constant
[INFO] [stderr]    --> src/types.rs:166:1
[INFO] [stderr]     |
[INFO] [stderr] 166 | / bitflags! {
[INFO] [stderr] 167 | |     #[repr(C)]
[INFO] [stderr] 168 | |     pub flags PositionerAnchorBit: u32 {
[INFO] [stderr] 169 | |         const WLC_BIT_ANCHOR_NONE = 0,
[INFO] [stderr] ...   |
[INFO] [stderr] 175 | | }
[INFO] [stderr]     | |_^
[INFO] [stderr]     |
[INFO] [stderr]     = note: this warning originates in the macro `bitflags` (in Nightly builds, run with -Z macro-backtrace for more info)
[INFO] [stderr] 
[INFO] [stderr] warning: missing documentation for a struct
[INFO] [stderr]    --> src/types.rs:177:1
[INFO] [stderr]     |
[INFO] [stderr] 177 | / bitflags! {
[INFO] [stderr] 178 | |     #[repr(C)]
[INFO] [stderr] 179 | |     pub flags PositionerGravityBit: u32 {
[INFO] [stderr] 180 | |         const WLC_BIT_GRAVITY_NONE = 0,
[INFO] [stderr] ...   |
[INFO] [stderr] 187 | | }
[INFO] [stderr]     | |_^
[INFO] [stderr]     |
[INFO] [stderr]     = note: this warning originates in the macro `bitflags` (in Nightly builds, run with -Z macro-backtrace for more info)
[INFO] [stderr] 
[INFO] [stderr] warning: missing documentation for a constant
[INFO] [stderr]    --> src/types.rs:177:1
[INFO] [stderr]     |
[INFO] [stderr] 177 | / bitflags! {
[INFO] [stderr] 178 | |     #[repr(C)]
[INFO] [stderr] 179 | |     pub flags PositionerGravityBit: u32 {
[INFO] [stderr] 180 | |         const WLC_BIT_GRAVITY_NONE = 0,
[INFO] [stderr] ...   |
[INFO] [stderr] 187 | | }
[INFO] [stderr]     | |_^
[INFO] [stderr]     |
[INFO] [stderr]     = note: this warning originates in the macro `bitflags` (in Nightly builds, run with -Z macro-backtrace for more info)
[INFO] [stderr] 
[INFO] [stderr] warning: missing documentation for a struct
[INFO] [stderr]    --> src/types.rs:189:1
[INFO] [stderr]     |
[INFO] [stderr] 189 | / bitflags! {
[INFO] [stderr] 190 | |     #[repr(C)]
[INFO] [stderr] 191 | |     pub flags PositionerConstraintAdjustmentBits: u32 {
[INFO] [stderr] 192 | |         const WLC_BIT_CONSTRAINT_ADJUSTMENT_NONE = 0,
[INFO] [stderr] ...   |
[INFO] [stderr] 200 | | }
[INFO] [stderr]     | |_^
[INFO] [stderr]     |
[INFO] [stderr]     = note: this warning originates in the macro `bitflags` (in Nightly builds, run with -Z macro-backtrace for more info)
[INFO] [stderr] 
[INFO] [stderr] warning: missing documentation for a constant
[INFO] [stderr]    --> src/types.rs:189:1
[INFO] [stderr]     |
[INFO] [stderr] 189 | / bitflags! {
[INFO] [stderr] 190 | |     #[repr(C)]
[INFO] [stderr] 191 | |     pub flags PositionerConstraintAdjustmentBits: u32 {
[INFO] [stderr] 192 | |         const WLC_BIT_CONSTRAINT_ADJUSTMENT_NONE = 0,
[INFO] [stderr] ...   |
[INFO] [stderr] 200 | | }
[INFO] [stderr]     | |_^
[INFO] [stderr]     |
[INFO] [stderr]     = note: this warning originates in the macro `bitflags` (in Nightly builds, run with -Z macro-backtrace for more info)
[INFO] [stderr] 
[INFO] [stderr] warning: missing documentation for a function
[INFO] [stderr]   --> src/render.rs:47:5
[INFO] [stderr]    |
[INFO] [stderr] 47 | /     pub fn wlc_pixels_read(format: wlc_pixel_format,
[INFO] [stderr] 48 | |                            geometry: *const Geometry,
[INFO] [stderr] 49 | |                            out_geo: *mut Geometry,
[INFO] [stderr] 50 | |                            data: *mut c_void);
[INFO] [stderr]    | |______________________________________________^
[INFO] [stderr] 
[INFO] [stderr] warning: missing documentation for a function
[INFO] [stderr]   --> src/render.rs:76:5
[INFO] [stderr]    |
[INFO] [stderr] 76 | /     pub fn wlc_output_set_gamma(output: uintptr_t,
[INFO] [stderr] 77 | |                                 size: u16,
[INFO] [stderr] 78 | |                                 red: *mut u16,
[INFO] [stderr] 79 | |                                 green: *mut u16,
[INFO] [stderr] 80 | |                                 blue: *mut u16);
[INFO] [stderr]    | |________________________________________________^
[INFO] [stderr] 
[INFO] [stderr] warning: missing documentation for a function
[INFO] [stderr]   --> src/render.rs:82:5
[INFO] [stderr]    |
[INFO] [stderr] 82 |     pub fn wlc_output_get_gamma_size(output: uintptr_t) -> u16 ;
[INFO] [stderr]    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: unresolved link to `wlc`
[INFO] [stderr]  --> src/lib.rs:1:33
[INFO] [stderr]   |
[INFO] [stderr] 1 | //! `rustwlc` is a wrapper for [wlc][], a library for writing a window
[INFO] [stderr]   |                                 ^^^ no item named `wlc` in scope
[INFO] [stderr]   |
[INFO] [stderr]   = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
[INFO] [stderr]   = note: `#[warn(rustdoc::broken_intra_doc_links)]` on by default
[INFO] [stderr] 
[INFO] [stderr] warning: unresolved link to `wayland`
[INFO] [stderr]  --> src/lib.rs:2:24
[INFO] [stderr]   |
[INFO] [stderr] 2 | //! manager using the [wayland][] protocol. Compositors using rustwlc will
[INFO] [stderr]   |                        ^^^^^^^ no item named `wayland` in scope
[INFO] [stderr]   |
[INFO] [stderr]   = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
[INFO] [stderr] 
[INFO] [stderr] warning: unresolved link to `wlc`
[INFO] [stderr]  --> src/lib.rs:7:6
[INFO] [stderr]   |
[INFO] [stderr] 7 | //! [wlc][] is a library written in C which acts as a wayland compositor. It
[INFO] [stderr]   |      ^^^ no item named `wlc` in scope
[INFO] [stderr]   |
[INFO] [stderr]   = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
[INFO] [stderr] 
[INFO] [stderr] warning: unresolved link to `wlc`
[INFO] [stderr]   --> src/lib.rs:53:6
[INFO] [stderr]    |
[INFO] [stderr] 53 | //! [wlc]: https://github.com/Cloudef/wlc
[INFO] [stderr]    |      ^^^ no item named `wlc` in scope
[INFO] [stderr]    |
[INFO] [stderr]    = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
[INFO] [stderr] 
[INFO] [stderr] warning: unresolved link to `wayland`
[INFO] [stderr]   --> src/lib.rs:54:6
[INFO] [stderr]    |
[INFO] [stderr] 54 | //! [wayland]: https://wayland.freedesktop.org/
[INFO] [stderr]    |      ^^^^^^^ no item named `wayland` in scope
[INFO] [stderr]    |
[INFO] [stderr]    = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
[INFO] [stderr] 
[INFO] [stderr] warning: this URL is not a hyperlink
[INFO] [stderr]   --> src/lib.rs:53:12
[INFO] [stderr]    |
[INFO] [stderr] 53 | //! [wlc]: https://github.com/Cloudef/wlc
[INFO] [stderr]    |            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]    |
[INFO] [stderr]    = note: bare URLs are not automatically turned into clickable links
[INFO] [stderr]    = note: `#[warn(rustdoc::bare_urls)]` on by default
[INFO] [stderr] help: use an automatic link instead
[INFO] [stderr]    |
[INFO] [stderr] 53 | //! [wlc]: <https://github.com/Cloudef/wlc>
[INFO] [stderr]    |            +                              +
[INFO] [stderr] 
[INFO] [stderr] warning: this URL is not a hyperlink
[INFO] [stderr]   --> src/lib.rs:54:16
[INFO] [stderr]    |
[INFO] [stderr] 54 | //! [wayland]: https://wayland.freedesktop.org/
[INFO] [stderr]    |                ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]    |
[INFO] [stderr]    = note: bare URLs are not automatically turned into clickable links
[INFO] [stderr] help: use an automatic link instead
[INFO] [stderr]    |
[INFO] [stderr] 54 | //! [wayland]: <https://wayland.freedesktop.org/>
[INFO] [stderr]    |                +                                +
[INFO] [stderr] 
[INFO] [stderr] warning: this URL is not a hyperlink
[INFO] [stderr]   --> src/lib.rs:55:28
[INFO] [stderr]    |
[INFO] [stderr] 55 | //! [the example program]: https://github.com/Immington-Industries/rust-wlc/blob/master/example/src/main.rs
[INFO] [stderr]    |                            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]    |
[INFO] [stderr]    = note: bare URLs are not automatically turned into clickable links
[INFO] [stderr] help: use an automatic link instead
[INFO] [stderr]    |
[INFO] [stderr] 55 | //! [the example program]: <https://github.com/Immington-Industries/rust-wlc/blob/master/example/src/main.rs>
[INFO] [stderr]    |                            +                                                                                +
[INFO] [stderr] 
[INFO] [stderr] warning: this URL is not a hyperlink
[INFO] [stderr]   --> src/lib.rs:56:24
[INFO] [stderr]    |
[INFO] [stderr] 56 | //! [our GitHub page]: https://github.com/Immington-Industries/rustwlc
[INFO] [stderr]    |                        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]    |
[INFO] [stderr]    = note: bare URLs are not automatically turned into clickable links
[INFO] [stderr] help: use an automatic link instead
[INFO] [stderr]    |
[INFO] [stderr] 56 | //! [our GitHub page]: <https://github.com/Immington-Industries/rustwlc>
[INFO] [stderr]    |                        +                                               +
[INFO] [stderr] 
[INFO] [stderr] warning: this URL is not a hyperlink
[INFO] [stderr]   --> src/lib.rs:57:19
[INFO] [stderr]    |
[INFO] [stderr] 57 | //! [way-cooler]: https://github.com/Immington-Industries/way-cooler
[INFO] [stderr]    |                   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]    |
[INFO] [stderr]    = note: bare URLs are not automatically turned into clickable links
[INFO] [stderr] help: use an automatic link instead
[INFO] [stderr]    |
[INFO] [stderr] 57 | //! [way-cooler]: <https://github.com/Immington-Industries/way-cooler>
[INFO] [stderr]    |                   +                                                  +
[INFO] [stderr] 
[INFO] [stderr] warning: this URL is not a hyperlink
[INFO] [stderr]    --> src/xkb/mod.rs:118:5
[INFO] [stderr]     |
[INFO] [stderr] 118 | /// http://www.x.org/releases/X11R7.7/doc/xproto/x11protocol.html#keysym_encoding
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]     |
[INFO] [stderr]     = note: bare URLs are not automatically turned into clickable links
[INFO] [stderr] help: use an automatic link instead
[INFO] [stderr]     |
[INFO] [stderr] 118 | /// <http://www.x.org/releases/X11R7.7/doc/xproto/x11protocol.html#keysym_encoding>
[INFO] [stderr]     |     +                                                                             +
[INFO] [stderr] 
[INFO] [stderr] warning: unclosed HTML tag `codepoint`
[INFO] [stderr]    --> src/xkb/mod.rs:126:51
[INFO] [stderr]     |
[INFO] [stderr] 126 | /// 0x0110FFFF.  The name of Unicode keysyms is "U<codepoint>", e.g. "UA1B2".
[INFO] [stderr]     |                                                   ^^^^^^^^^^^
[INFO] [stderr]     |
[INFO] [stderr]     = note: `#[warn(rustdoc::invalid_html_tags)]` on by default
[INFO] [stderr] help: try marking as source code
[INFO] [stderr]     |
[INFO] [stderr] 126 | /// 0x0110FFFF.  The name of Unicode keysyms is "`U<codepoint>`", e.g. "UA1B2".
[INFO] [stderr]     |                                                  +            +
[INFO] [stderr] 
[INFO] [stderr] warning: `rustwlc` (lib doc) generated 32 warnings (run `cargo fix --lib -p rustwlc` to apply 6 suggestions)
[INFO] [stderr]     Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.65s
[INFO] [stderr] warning: the following packages contain code that will be rejected by a future version of Rust: bitflags v0.7.0
[INFO] [stderr] note: to see what the problems were, use the option `--future-incompat-report`, or run `cargo report future-incompatibilities --id 1`
[INFO] [stderr]    Generated /opt/rustwide/target/x86_64-unknown-linux-gnu/doc/rustwlc/index.html
[INFO] running `Command { std: "docker" "inspect" "37a9f0d42f81f28c03d65e42ea1a924c5b19901ad9a2e88c2a21a3f17990a326", kill_on_drop: false }`
[INFO] running `Command { std: "docker" "rm" "-f" "37a9f0d42f81f28c03d65e42ea1a924c5b19901ad9a2e88c2a21a3f17990a326", kill_on_drop: false }`
[INFO] [stdout] 37a9f0d42f81f28c03d65e42ea1a924c5b19901ad9a2e88c2a21a3f17990a326