Enum arboard::Error

pub enum Error {
    ContentNotAvailable,
    ClipboardOccupied,
    ConversionFailure,
    Unknown {
        description: String,
    },
}

An error that might happen during a clipboard operation.

Note that both the Display and the Debug trait is implemented for this type in such a way that they give a short human-readable description of the error; however the documentation gives a more detailed explanation for each error kind.

Variants

ContentNotAvailable

The clipboard contents were not available in the requested format. This could either be due to the clipboard being empty or the clipboard contents having an incompatible format to the requested one (eg when calling get_image on text)

ClipboardOccupied

The native clipboard is not accessible due to being held by an other party.

This “other party” could be a different process or it could be within the same program. So for example you may get this error when trying to interact with the clipboard from multiple threads at once.

Note that it’s OK to have multiple Clipboard instances. The underlying implementation will make sure that the native clipboard is only opened for transferring data and then closed as soon as possible.

ConversionFailure

This can happen in either of the following cases.

• When returned from set_image: the image going to the clipboard cannot be converted to the appropriate format.
• When returned from get_image: the image coming from the clipboard could not be converted into the ImageData struct.
• When returned from get_text: the text coming from the clipboard is not valid utf-8 or cannot be converted to utf-8.

Unknown

Any error that doesn’t fit the other error types.

The description field is only meant to help the developer and should not be relied on as a means to identify an error case during runtime.

Fields of Unknown

description: String

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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

The lower-level source of this error, if any.

pub fn backtrace(&self) -> Option<&Backtrace>

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

Returns a stack backtrace, if available, of where this error occurred.

pub fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

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

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting