Struct UpdateCursor

pub struct UpdateCursor {
    pub icon: i32,
    pub image: Bytes,
    pub hotspot_x: u32,
    pub hotspot_y: u32,
}

066 - Update Cursor

This message, which must be sent by the server on the same stream as the original 030 - Attach message, indicates that the cursor image has changed and the client should use the new one when the cursor is over the window.

Fields

icon: i32

Required.

image: Bytes

The cursor image, encoded as a PNG file. If set, the client should use this and use the icon field solely as a fallback.

hotspot_x: u32

Relates to the image, if set.

hotspot_y: u32

Implementations

impl UpdateCursor

pub fn icon(&self) -> CursorIcon

Returns the enum value of icon, or the default if the field is set to an invalid enum value.

pub fn set_icon(&mut self, value: CursorIcon)

Sets icon to the provided enum value.

Trait Implementations

impl Clone for UpdateCursor

fn clone(&self) -> UpdateCursor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateCursor

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

Formats the value using the given formatter.

impl Default for UpdateCursor

fn default() -> Self

Returns the “default value” for a type.

impl From<UpdateCursor> for MessageType

fn from(v: UpdateCursor) -> Self

Converts to this type from the input type.

impl Message for UpdateCursor

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

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

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

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

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for UpdateCursor

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for UpdateCursor