mm_client_common

Struct Attachment

Source 
pub struct Attachment { /* private fields */ }
Expand description

A handle for sending messages to the server over an attachment stream.

An attachment is ended once the corresponding AttachmentDelegate receives the attachment_ended or parameters_changed (with reattach_required = true) callbacks. Using it past that point will silently drop events.

Implementations§

Source§

impl Attachment

Source

pub fn request_video_refresh(&self, stream_seq: u64)

Requests that the server generate a packet with headers and a keyframe.

Source

pub fn keyboard_input(&self, key: Key, state: KeyState, character: u32)

Sends keyboard input to the server.

Source

pub fn pointer_entered(&self)

Notifies the server that the pointer has entered the video area, including if it enters a letterbox around the video.

Source

pub fn pointer_left(&self)

Notifies the server that the pointer has left the video area. This should consider any letterboxing part of the video area.

Source

pub fn pointer_motion(&self, x: f64, y: f64)

Sends pointer motion to the server.

Source

pub fn relative_pointer_motion(&self, x: f64, y: f64)

Sends relative pointer motion to the server.

Source

pub fn pointer_input(&self, button: Button, state: ButtonState, x: f64, y: f64)

Sends pointer input to the server.

Source

pub fn pointer_scroll(&self, scroll_type: ScrollType, x: f64, y: f64)

Sends pointer scroll events to the server.

Source

pub fn gamepad_available(&self, pad: Gamepad)

Sends a ‘Gamepad Available’ event to the server.

Source

pub fn gamepad_unavailable(&self, id: u64)

Sends a ‘Gamepad Unavailable’ event to the server.

Source

pub fn gamepad_motion(&self, id: u64, axis: GamepadAxis, value: f64)

Sends gamepad joystick motion to the server.

Source

pub fn gamepad_input( &self, id: u64, button: GamepadButton, state: GamepadButtonState, )

Sends gamepad button input to the server.

Source

pub async fn detach(&self) -> Result<(), ClientError>

Ends the attachment.

Trait Implementations§

Source§

impl<UT> LiftRef<UT> for Attachment

Source§

type LiftType = Arc<Attachment>

Source§

impl<UT> LowerError<UT> for Attachment

Source§

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return Read more
Source§

impl<UT> LowerReturn<UT> for Attachment

Source§

type ReturnType = <Arc<Attachment> as LowerReturn<UniFfiTag>>::ReturnType

The type that should be returned by scaffolding functions for this type. Read more
Source§

fn lower_return(obj: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call Read more
§

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts Read more
Source§

impl<UT> TypeId<UT> for Attachment

Source§

const TYPE_ID_META: MetadataBuffer

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.

§

impl<T, UT> HandleAlloc<UT> for T
where T: Send + Sync,

§

fn new_handle(value: Arc<T>) -> Handle

Create a new handle for an Arc value Read more
§

unsafe fn clone_handle(handle: Handle) -> Handle

Clone a handle Read more
§

unsafe fn consume_handle(handle: Handle) -> Arc<T>

Consume a handle, getting back the initial Arc<> Read more
§

unsafe fn get_arc(handle: Handle) -> Arc<Self>

Get a clone of the Arc<> using a “borrowed” handle. Read more
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

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>,

Source§

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.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more