drmkit-dumb 0.1.2

DRM dumb buffers for drmkit: GPU-free, CPU-mappable scanout surfaces with lifetime mmaps.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

// SPDX-FileCopyrightText: (c) 2026 Joel Winarske
// SPDX-License-Identifier: MIT

//! Error type for `drmkit-dumb`.

use rustix::io::Errno;

/// Errors from dumb-buffer allocation and framebuffer registration.
#[derive(Debug, thiserror::Error)]
#[non_exhaustive]
pub enum DumbError {
    /// Zero or out-of-range dimensions, a zero format or bpp, or a `FourCC`
    /// the `drm` crate does not recognize.
    /// `errc::invalid_argument`.
    #[error("invalid dumb buffer configuration: {reason}")]
    InvalidConfig {
        /// What was wrong.
        reason: &'static str,
    },

    /// The `FourCC` is not one [`Buffer::create_planar`](crate::Buffer::create_planar)
    /// recognizes. `errc::not_supported`.
    ///
    /// Callers can fall back to [`Buffer::create`](crate::Buffer::create) for
    /// single-plane formats.
    #[error("format {fourcc:#010x} is not a supported semi-planar layout")]
    UnsupportedFormat {
        /// The requested `FourCC`.
        fourcc: u32,
    },

    /// A size computation would not fit the kernel's 32-bit field.
    /// `errc::value_too_large`.
    #[error("dumb buffer geometry overflows a 32-bit kernel field: {what}")]
    TooLarge {
        /// Which computation overflowed.
        what: &'static str,
    },

    /// An ioctl or mmap failed.
    #[error("dumb buffer operation failed: {0}")]
    Io(#[from] Errno),
}

/// Convenience alias.
pub type Result<T> = std::result::Result<T, DumbError>;