Enum CaptureError 

pub enum CaptureError {
    WindowsUnsupported,
    NoOutputs,
    EmptyRegion,
    RegionOffscreen,
    OutputNotFound(String),
    WindowNotFound(String),
    NoWindowMatches(String),
    AmbiguousWindow {
        selector: String,
        candidates: Vec<String>,
    },
    InvalidGeometry(String),
    CaptureTimeout,
    NoVideoEncoder,
    SourceTooSmall {
        w: u32,
        h: u32,
    },
    Backend {
        context: String,
        source: Option<Box<dyn StdError + Send + Sync + 'static>>,
    },
}

An error from the capture engine.

Variants

WindowsUnsupported

The compositor can’t capture individual windows: no foreign-toplevel image-capture source (wlroots < 0.20 / Sway < 1.12). Screen capture may still work.

NoOutputs

No outputs are available to capture.

EmptyRegion

The requested region has zero area.

RegionOffscreen

The requested region lies outside every output.

OutputNotFound(String)

No output matches the requested name.

WindowNotFound(String)

No window matches the requested id.

NoWindowMatches(String)

No window matches the requested app_id / title filter.

AmbiguousWindow

Several windows match the requested app_id / title filter, so the caller has to narrow it down. candidates describes the matches well enough to pick one.

Fields

selector: String

A human description of the filter that was too loose, e.g. app-id 'firefox'.

candidates: Vec<String>

One pre-formatted line per matching window.

InvalidGeometry(String)

A geometry string was not in X,Y WxH form.

CaptureTimeout

The capture produced no frame before the deadline.

NoVideoEncoder

Available on crate feature video only.

No usable H.264 encoder is available (NVENC, VAAPI or libx264).

SourceTooSmall

Available on crate feature video only.

The source is too small to encode.

Fields

w: u32

Source width in pixels.

h: u32

Source height in pixels.

Backend

A lower-level failure, with a human context and (when there is one) the underlying cause preserved so the error chain survives.

Fields

context: String

What was being attempted.

source: Option<Box<dyn StdError + Send + Sync + 'static>>

The underlying cause, if any.

Implementations

impl CaptureError

pub fn msg(context: impl Into<String>) -> Self

A message-only backend error (no underlying cause) — the typed replacement for a bare anyhow!("…") / bail!("…").

Trait Implementations

impl Debug for CaptureError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for CaptureError

fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for CaptureError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.