Struct x11rb_protocol::protocol::xproto::GetPropertyReply

source ·
pub struct GetPropertyReply {
    pub format: u8,
    pub sequence: u16,
    pub length: u32,
    pub type_: Atom,
    pub bytes_after: u32,
    pub value_len: u32,
    pub value: Vec<u8>,
}
Expand description

§Fields

  • 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.
  • type - The actual type of the property (an atom).
  • bytes_after - The number of bytes remaining to be read in the property if a partial read was performed.
  • value_len - The length of value. You should use the corresponding accessor instead of this field.

Fields§

§format: u8§sequence: u16§length: u32§type_: Atom§bytes_after: u32§value_len: u32§value: Vec<u8>

Implementations§

source§

impl GetPropertyReply

source

pub fn value8(&self) -> Option<impl Iterator<Item = u8> + '_>

Iterate over the contained value if its format is 8.

This function checks if the format member of the reply is 8. If it it is not, None is returned. Otherwise and iterator is returned that interprets the value in this reply as type u8.

§Examples

Successfully iterate over the value:

// First, we have to 'invent' a GetPropertyReply.
let reply = x11rb_protocol::protocol::xproto::GetPropertyReply {
    format: 8,
    sequence: 0,
    length: 0, // This value is incorrect
    type_: 0, // This value is incorrect
    bytes_after: 0,
    value_len: 4,
    value: vec![1, 2, 3, 4],
};

// This is the actual example: Iterate over the value.
let mut iter = reply.value8().unwrap();
assert_eq!(iter.next(), Some(1));
assert_eq!(iter.next(), Some(2));
assert_eq!(iter.next(), Some(3));
assert_eq!(iter.next(), Some(4));
assert_eq!(iter.next(), None);

An iterator is only returned when the format is correct. The following example shows this.

// First, we have to 'invent' a GetPropertyReply.
let reply = x11rb_protocol::protocol::xproto::GetPropertyReply {
    format: 42, // Not allowed in X11, but used for the example
    sequence: 0,
    length: 0, // This value is incorrect
    type_: 0, // This value is incorrect
    bytes_after: 0,
    value_len: 4,
    value: vec![1, 2, 3, 4],
};
assert!(reply.value8().is_none());
source

pub fn value16(&self) -> Option<impl Iterator<Item = u16> + '_>

Iterate over the contained value if its format is 16.

This function checks if the format member of the reply is 16. If it it is not, None is returned. Otherwise and iterator is returned that interprets the value in this reply as type u16.

§Examples

Successfully iterate over the value:

// First, we have to 'invent' a GetPropertyReply.
let reply = x11rb_protocol::protocol::xproto::GetPropertyReply {
    format: 16,
    sequence: 0,
    length: 0, // This value is incorrect
    type_: 0, // This value is incorrect
    bytes_after: 0,
    value_len: 4,
    value: vec![1, 1, 2, 2],
};

// This is the actual example: Iterate over the value.
let mut iter = reply.value16().unwrap();
assert_eq!(iter.next(), Some(257));
assert_eq!(iter.next(), Some(514));
assert_eq!(iter.next(), None);

An iterator is only returned when the format is correct. The following example shows this.

// First, we have to 'invent' a GetPropertyReply.
let reply = x11rb_protocol::protocol::xproto::GetPropertyReply {
    format: 42, // Not allowed in X11, but used for the example
    sequence: 0,
    length: 0, // This value is incorrect
    type_: 0, // This value is incorrect
    bytes_after: 0,
    value_len: 4,
    value: vec![1, 2, 3, 4],
};
assert!(reply.value16().is_none());
source

pub fn value32(&self) -> Option<impl Iterator<Item = u32> + '_>

Iterate over the contained value if its format is 32.

This function checks if the format member of the reply is 32. If it it is not, None is returned. Otherwise and iterator is returned that interprets the value in this reply as type u32.

§Examples

Successfully iterate over the value:

// First, we have to 'invent' a GetPropertyReply.
let reply = x11rb_protocol::protocol::xproto::GetPropertyReply {
    format: 32,
    sequence: 0,
    length: 0, // This value is incorrect
    type_: 0, // This value is incorrect
    bytes_after: 0,
    value_len: 4,
    value: vec![1, 2, 2, 1],
};

// This is the actual example: Iterate over the value.
let mut iter = reply.value32().unwrap();
assert_eq!(iter.next(), Some(16908801));
assert_eq!(iter.next(), None);

An iterator is only returned when the format is correct. The following example shows this.

// First, we have to 'invent' a GetPropertyReply.
let reply = x11rb_protocol::protocol::xproto::GetPropertyReply {
    format: 42, // Not allowed in X11, but used for the example
    sequence: 0,
    length: 0, // This value is incorrect
    type_: 0, // This value is incorrect
    bytes_after: 0,
    value_len: 4,
    value: vec![1, 2, 3, 4],
};
assert!(reply.value32().is_none());

Trait Implementations§

source§

impl Clone for GetPropertyReply

source§

fn clone(&self) -> GetPropertyReply

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 GetPropertyReply

source§

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

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

impl Default for GetPropertyReply

source§

fn default() -> GetPropertyReply

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

impl From<GetPropertyReply> for Reply

source§

fn from(reply: GetPropertyReply) -> Reply

Converts to this type from the input type.
source§

impl Serialize for GetPropertyReply

§

type Bytes = Vec<u8>

The value returned by serialize. Read more
source§

fn serialize(&self) -> Vec<u8>

Serialize this value into X11 raw bytes.
source§

fn serialize_into(&self, bytes: &mut Vec<u8>)

Serialize this value into X11 raw bytes, appending the result into bytes. Read more
source§

impl TryParse for GetPropertyReply

source§

fn try_parse(initial_value: &[u8]) -> Result<(Self, &[u8]), ParseError>

Try to parse the given values into an instance of this type. 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> 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.
source§

impl<T> TryParseFd for T
where T: TryParse,

source§

fn try_parse_fd<'a>( value: &'a [u8], _: &mut Vec<OwnedFd>, ) -> Result<(T, &'a [u8]), ParseError>

Try to parse the given values into an instance of this type. Read more