Struct x11rb::protocol::xproto::InternAtomRequest

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

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§

source§

impl<'input> InternAtomRequest<'input>

source

pub fn serialize(self) -> ([Cow<'input, [u8]>; 3], Vec<OwnedFd>)

Serialize this request into bytes for the provided connection

source

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

Clone all borrowed data in this InternAtomRequest.

Trait Implementations§

source§

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

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for InternAtomRequest<'_>

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

fn default() -> InternAtomRequest<'input>

Returns the “default value” for a type. Read more
source§

impl<'input> ReplyRequest for InternAtomRequest<'input>

§

type Reply = InternAtomReply

The kind of reply that this request generates.
source§

impl<'input> Request for InternAtomRequest<'input>

source§

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

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

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

Serialize this request into its X11 protocol wire representation. Read more

Auto Trait Implementations§

§

impl<'input> Freeze for InternAtomRequest<'input>

§

impl<'input> RefUnwindSafe for InternAtomRequest<'input>

§

impl<'input> Send for InternAtomRequest<'input>

§

impl<'input> Sync for InternAtomRequest<'input>

§

impl<'input> Unpin for InternAtomRequest<'input>

§

impl<'input> UnwindSafe for InternAtomRequest<'input>

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> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.