Enum EventBody

pub enum EventBody<'a> {
    Owned(EventBodyOwned),
    Borrowed(EventBodyBorrowed<'a>),
}

Common event body that can be either owned or borrowed.

This is useful for APIs that can return either owned or borrowed event bodies.
Having this type allows to be generic over the event body type.

Variants

Owned(EventBodyOwned)

Borrowed(EventBodyBorrowed<'a>)

Implementations

impl<'a> EventBody<'_>

pub fn as_owned(&self) -> Result<EventBodyOwned, AtspiError>

Non-consuming conversion to an owned event body.

Does cloning.

Errors

The borrowed variant will error if the following conditions are met:

1. the any_data field contains an [std::os::fd::OwnedFd] type, and
2. the maximum number of open files for the process is exceeded.

pub fn into_owned(self) -> Result<EventBodyOwned, AtspiError>

Consuming conversion to an owned event body.

Does cloning.

Errors

The borrowed variant will error if the following conditions are met:

1. the any_data field contains an [std::os::fd::OwnedFd] type, and
2. the maximum number of open files for the process is exceeded.

pub fn kind(&'a self) -> &'a str

The kind field as &str.

With both variants, this method returns a reference to the kind field.

pub fn take_kind(&mut self) -> String

Take or convert the kind field as String.

With the owned variant, this method takes the kind field and replaces it with an empty string. With the borrowed variant, this method clones and allocates the kind field.

pub fn detail1(&self) -> i32

pub fn detail2(&self) -> i32

pub fn any_data(&'a self) -> &'a Value<'a>

The any_data field as &Value. With both variants, this method returns a reference to the any_data field.

pub fn take_any_data(&mut self) -> OwnedValue

Take or convert the any_data field as OwnedValue. With the owned variant, this method takes the any_data field and replaces it with a default value. As Value does not have a default value, we will replace with 0_u32, a nbon-allocating value.

With the borrowed variant, this method clones and allocates the any_data field.

Panics

This method will panic if the any_data field contains an [std::os::fd::OwnedFd] type, and the maximum number of open files for the process is exceeded.

None of the types in crate::events use [std::os::fd::OwnedFd]. Events on the AT-SPI bus could, theoretically send a file descriptor, but nothing in the current specification describes that.

Trait Implementations

impl<'a> Clone for EventBody<'a>

fn clone(&self) -> EventBody<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for EventBody<'a>

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

Formats the value using the given formatter.

impl Default for EventBody<'_>

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EventBody<'de>

fn deserialize<D>(deserializer: D) -> Result<EventBody<'de>, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<EventBody<'_>> for EventBodyQtOwned

fn from(event: EventBody<'_>) -> Self

Converts to this type from the input type.

impl<'b> From<EventBodyBorrowed<'b>> for EventBody<'b>

fn from(borrowed: EventBodyBorrowed<'b>) -> Self

Converts to this type from the input type.

impl From<EventBodyOwned> for EventBody<'_>

fn from(owned: EventBodyOwned) -> Self

Converts to this type from the input type.

impl<'a> From<EventBodyQtBorrowed<'a>> for EventBody<'a>

fn from(qt_borrowed: EventBodyQtBorrowed<'a>) -> Self

Converts to this type from the input type.

impl From<EventBodyQtOwned> for EventBody<'_>

fn from(qt_owned: EventBodyQtOwned) -> Self

Converts to this type from the input type.

impl<'a> PartialEq for EventBody<'a>

fn eq(&self, other: &EventBody<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for EventBody<'_>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Type for EventBody<'_>

const SIGNATURE: &'static Signature = EventBodyOwned::SIGNATURE

The signature for the implementing type, in parsed format.

impl<'a> StructuralPartialEq for EventBody<'a>