Struct x11rb_protocol::protocol::xproto::ChangePropertyRequest

pub struct ChangePropertyRequest<'input> {
    pub mode: PropMode,
    pub window: Window,
    pub property: Atom,
    pub type_: Atom,
    pub format: u8,
    pub data_len: u32,
    pub data: Cow<'input, [u8]>,
}

Changes a window property.

Sets or updates a property on the specified window. Properties are for example the window title (WM_NAME) or its minimum size (WM_NORMAL_HINTS). Protocols such as EWMH also use properties - for example EWMH defines the window title, encoded as UTF-8 string, in the _NET_WM_NAME property.

Fields

• window - The window whose property you want to change.
• mode -
• property - The property you want to change (an atom).
• type - The type of the property you want to change (an atom).
• format - Specifies whether the data should be viewed as a list of 8-bit, 16-bit or 32-bit quantities. Possible values are 8, 16 and 32. This information allows the X server to correctly perform byte-swap operations as necessary.
• data_len - Specifies the number of elements (see format).
• data - The property data.

Errors

• Match - TODO: reasons?
• Value - TODO: reasons?
• Window - The specified window does not exist.
• Atom - property or type do not refer to a valid atom.
• Alloc - The X server could not store the property (no memory?).

See

• InternAtom: request
• xprop: program

Example

/*
 * Sets the WM_NAME property of the window to "XCB Example".
 *
 */
void my_example(xcb_connection_t *conn, xcb_window_t window) {
    xcb_change_property(conn,
        XCB_PROP_MODE_REPLACE,
        window,
        XCB_ATOM_WM_NAME,
        XCB_ATOM_STRING,
        8,
        strlen("XCB Example"),
        "XCB Example");
    xcb_flush(conn);
}

Fields

mode: PropMode

window: Window

property: Atom

type_: Atom

format: u8

data_len: u32

data: Cow<'input, [u8]>

Implementations

impl<'input> ChangePropertyRequest<'input>

pub fn serialize(self) -> BufWithFds<PiecewiseBuf<'input>>

Serialize this request into bytes for the provided connection

pub fn try_parse_request(
    header: RequestHeader,
    value: &'input [u8]
) -> Result<Self, ParseError>

Parse this request given its header, its body, and any fds that go along with it

pub fn into_owned(self) -> ChangePropertyRequest<'static>

Clone all borrowed data in this ChangePropertyRequest.

Trait Implementations

impl<'input> Clone for ChangePropertyRequest<'input>

fn clone(&self) -> ChangePropertyRequest<'input>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'input> Debug for ChangePropertyRequest<'input>

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

Formats the value using the given formatter.

impl<'input> Default for ChangePropertyRequest<'input>

fn default() -> ChangePropertyRequest<'input>

Returns the “default value” for a type.

impl<'input> Hash for ChangePropertyRequest<'input>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<'input> Ord for ChangePropertyRequest<'input>

fn cmp(&self, other: &ChangePropertyRequest<'input>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<'input> PartialEq<ChangePropertyRequest<'input>> for ChangePropertyRequest<'input>

fn eq(&self, other: &ChangePropertyRequest<'input>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ChangePropertyRequest<'input>) -> bool

This method tests for !=.

impl<'input> PartialOrd<ChangePropertyRequest<'input>> for ChangePropertyRequest<'input>

fn partial_cmp(&self, other: &ChangePropertyRequest<'input>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'input> Request for ChangePropertyRequest<'input>

const EXTENSION_NAME: Option<&'static str> = None

The protocol name of the extension that this request belongs to, or None for core requests

fn serialize(self, _major_opcode: u8) -> BufWithFds<Vec<u8>>

Serialize this request into its X11 protocol wire representation.

impl<'input> Eq for ChangePropertyRequest<'input>

impl<'input> StructuralEq for ChangePropertyRequest<'input>

impl<'input> StructuralPartialEq for ChangePropertyRequest<'input>

impl<'input> VoidRequest for ChangePropertyRequest<'input>