Struct Array

pub struct Array(/* private fields */);

Wrapper around the array data provided by the wayland wire format.

On the wire, wl_array arguments are simple byte arrays. Protocol documentation may specify a specific interpretation of the bytes, however this is not directly modeled in the protocol XML.

For example, the wl_keyboard::enter event has an argument for the set of keys pressed at the time of the event:

While not explitly stated, |keys| is an array of |uint| arguments. These are packed into the array using the same rules used to write consecutive |uint| arguments to a Message.

Implementations

impl Array

pub fn new() -> Self

Creates a new, empty Array.

pub fn from_vec(v: Vec<u8>) -> Self

Creates a new Array that contains the bytes stored in the provided Vec.

pub fn as_slice(&self) -> &[u8]

Access the array data as a slice.

pub fn into_vec(self) -> Vec<u8>

Extracts the Array data as a Vec.

pub fn len(&self) -> usize

Returns the length (in bytes) of the array.

pub fn push<T: Into<Arg>>(&mut self, arg: T) -> Result<()>

Writes an Arg to the end of this Array, increasing its size.

Note that arrays cannot contain handles and it is an error to attempt to write an Arg::Handle to an array.

pub fn read_arg(&mut self, kind: ArgKind) -> Result<Arg>

Reads an Arg out of this Array and return the value.

Note that arrays cannot contain handles and it is an error to attempt to read an ArgKind::Handle from an array.

Trait Implementations

impl Debug for Array

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

Formats the value using the given formatter.

impl From<Array> for Arg

fn from(v: Array) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for Array

fn from(v: Vec<u8>) -> Self

Converts to this type from the input type.