Struct xcb::x::InternAtom

pub struct InternAtom<'a> {
    pub only_if_exists: bool,
    pub name: &'a [u8],
}

Get atom identifier by name

Retrieves the identifier 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 false, the atom will be created if it does not already exist. If only_if_exists is true, ATOM_NONE will be returned if the atom does not yet exist.

Example

// Resolve the _NET_WM_NAME atom.
let cookie = conn.send_request(&x::InternAtom {
    only_if_exists: false,
    name: b"_NET_WM_NAME",
});
let reply = conn.wait_for_reply(cookie)?;
let wm_name = reply.atom();

This request replies InternAtomReply.

Associated cookie types are InternAtomCookie and InternAtomCookieUnchecked.

See also xcb::atoms_struct.

Fields

only_if_exists: bool

Return a valid atom id only if the atom already exists.

name: &'a [u8]

The name of the atom.

Trait Implementations

impl<'a> Clone for InternAtom<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for InternAtom<'a>

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

Formats the value using the given formatter.

impl<'a> RawRequest for InternAtom<'a>

fn raw_request(&self, c: &Connection, checked: bool) -> u64

Actual implementation of the request sending

impl<'a> Request for InternAtom<'a>

type Cookie = InternAtomCookie

The default cookie associated to this request.

const IS_VOID: bool = false

false if the request returns a reply, true otherwise.

impl<'a> RequestWithReply for InternAtom<'a>

type Reply = InternAtomReply

Reply associated with the request

type Cookie = InternAtomCookie

Default cookie type for the request, as returned by Connection::send_request.

type CookieUnchecked = InternAtomCookieUnchecked

Unchecked cookie type for the request, as returned by Connection::send_request_unchecked.