Struct x11rb::properties::WmClass

source ·
pub struct WmClass(GetPropertyReply, usize);
Expand description

The value of a window’s WM_CLASS property.

Usage example:

use x11rb::connection::Connection;
use x11rb::errors::ConnectionError;
use x11rb::properties::WmClass;
use x11rb::protocol::xproto::Window;

fn print_class_instance(
    conn: &impl Connection,
    window: Window,
) -> Result<bool, ConnectionError> {
    let wm_class = match WmClass::get(conn, window)?.reply_unchecked()? {
        Some(wm_class) => wm_class,
        None => return Ok(false), // Getting the property failed
    };
    // Note that the WM_CLASS property is not actually encoded in utf8.
    // ASCII values are most common and for these from_utf8() should be fine.
    let class = std::str::from_utf8(wm_class.class());
    let instance = std::str::from_utf8(wm_class.instance());
    println!(
        "For window {:x}, class is '{:?}' and instance is '{:?}'",
        window, class, instance,
    );
    Ok(true)
}

Tuple Fields§

§0: GetPropertyReply§1: usize

Implementations§

source§

impl WmClass

source

pub fn get<C: RequestConnection>( conn: &C, window: Window, ) -> Result<WmClassCookie<'_, C>, ConnectionError>

Send a GetProperty request for the WM_CLASS property of the given window

source

pub fn from_reply(reply: GetPropertyReply) -> Result<Option<Self>, ParseError>

Construct a new WmClass instance from a GetPropertyReply.

The original GetProperty request must have been for a WM_CLASS property for this function to return sensible results.

source

pub fn instance(&self) -> &[u8]

Get the instance contained in this WM_CLASS property

source

pub fn class(&self) -> &[u8]

Get the class contained in this WM_CLASS property

Trait Implementations§

source§

impl Debug for WmClass

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.