Enum wayland_backend::protocol::Argument

pub enum Argument<Id, Fd> {
    Int(i32),
    Uint(u32),
    Fixed(i32),
    Str(Option<Box<CString>>),
    Object(Id),
    NewId(Id),
    Array(Box<Vec<u8>>),
    Fd(Fd),
}

Enum of possible argument of the protocol

Variants

Int(i32)

An integer argument. Represented by a i32.

Uint(u32)

An unsigned integer argument. Represented by a u32.

Fixed(i32)

A signed fixed point number with 1/256 precision

Str(Option<Box<CString>>)

CString

The value is boxed to reduce the stack size of Argument. The performance impact is negligible as string arguments are pretty rare in the protocol.

Object(Id)

Id of a wayland object

NewId(Id)

Id of a newly created wayland object

Array(Box<Vec<u8>>)

Vec

The value is boxed to reduce the stack size of Argument. The performance impact is negligible as array arguments are pretty rare in the protocol.

Fd(Fd)

A file descriptor argument. Represented by a [RawFd].

Implementations

impl<Id, Fd> Argument<Id, Fd>

pub fn get_type(&self) -> ArgumentType

Retrieve the type of a given argument instance

Examples found in repository

src/protocol.rs (line 276)

pub(crate) fn check_for_signature<Id, Fd>(
    signature: &[ArgumentType],
    args: &[Argument<Id, Fd>],
) -> bool {
    if signature.len() != args.len() {
        return false;
    }
    for (typ, arg) in signature.iter().copied().zip(args.iter()) {
        if !arg.get_type().same_type(typ) {
            return false;
        }
    }
    true
}

Trait Implementations

impl<Id: Clone, Fd: Clone> Clone for Argument<Id, Fd>

fn clone(&self) -> Argument<Id, Fd>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Id: Debug, Fd: Debug> Debug for Argument<Id, Fd>

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

Formats the value using the given formatter.

impl<Id: Display, Fd: AsRawFd> Display for Argument<Id, Fd>

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

Formats the value using the given formatter.

impl<Id: PartialEq, Fd: AsRawFd> PartialEq<Argument<Id, Fd>> for Argument<Id, Fd>

fn eq(&self, other: &Self) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Id: Eq, Fd: AsRawFd> Eq for Argument<Id, Fd>