Struct x11rb_protocol::protocol::xproto::InternAtomRequest

pub struct InternAtomRequest<'input> {
    pub only_if_exists: bool,
    pub name: Cow<'input, [u8]>,
}

Get atom identifier by name.

Retrieves the identifier (xcb_atom_t TODO) for the atom with the specified name. Atoms are used in protocols like EWMH, for example to store window titles (_NET_WM_NAME atom) as property of a window.

If only_if_exists is 0, the atom will be created if it does not already exist. If only_if_exists is 1, XCB_ATOM_NONE will be returned if the atom does not yet exist.

Fields

• name - The name of the atom.
• only_if_exists - Return a valid atom id only if the atom already exists.

Errors

• Alloc - TODO: reasons?
• Value - A value other than 0 or 1 was specified for only_if_exists.

See

• xlsatoms: program
• GetAtomName: request

Example

/*
 * Resolves the _NET_WM_NAME atom.
 *
 */
void my_example(xcb_connection_t *c) {
    xcb_intern_atom_cookie_t cookie;
    xcb_intern_atom_reply_t *reply;

    cookie = xcb_intern_atom(c, 0, strlen("_NET_WM_NAME"), "_NET_WM_NAME");
    /* ... do other work here if possible ... */
    if ((reply = xcb_intern_atom_reply(c, cookie, NULL))) {
        printf("The _NET_WM_NAME atom has ID %u\n", reply->atom);
        free(reply);
    }
}

Fields

only_if_exists: bool

name: Cow<'input, [u8]>

Implementations

impl<'input> InternAtomRequest<'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) -> InternAtomRequest<'static>

Clone all borrowed data in this InternAtomRequest.

Trait Implementations

impl<'input> Clone for InternAtomRequest<'input>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'input> Debug for InternAtomRequest<'input>

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

Formats the value using the given formatter.

impl<'input> Default for InternAtomRequest<'input>

fn default() -> InternAtomRequest<'input>

Returns the “default value” for a type.

impl<'input> Hash for InternAtomRequest<'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 InternAtomRequest<'input>

fn cmp(&self, other: &InternAtomRequest<'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<InternAtomRequest<'input>> for InternAtomRequest<'input>

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

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

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

This method tests for !=.

impl<'input> PartialOrd<InternAtomRequest<'input>> for InternAtomRequest<'input>

fn partial_cmp(&self, other: &InternAtomRequest<'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> ReplyRequest for InternAtomRequest<'input>

type Reply = InternAtomReply

The kind of reply that this request generates.

impl<'input> Request for InternAtomRequest<'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 InternAtomRequest<'input>

impl<'input> StructuralEq for InternAtomRequest<'input>

impl<'input> StructuralPartialEq for InternAtomRequest<'input>