Struct MouseOptions 

pub struct MouseOptions {
    pub button: MouseButton,
    pub alt: bool,
    pub ctrl: bool,
    pub shift: bool,
}

Button and modifier state for a mouse action.

The default is an unmodified left button.

Fields

button: MouseButton

alt: bool

ctrl: bool

shift: bool

Implementations

impl MouseOptions

pub const fn new(button: MouseButton) -> Self

pub const fn with_alt(self) -> Self

pub const fn with_ctrl(self) -> Self

pub const fn with_shift(self) -> Self

pub const fn sgr_code(self) -> u8

Return the SGR mouse button code used by terminal protocols.

pub const fn from_sgr_code(code: u8) -> Option<Self>

Decode an SGR mouse button code used by protocol adapters.

Trait Implementations

impl Clone for MouseOptions

fn clone(&self) -> MouseOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MouseOptions

impl Debug for MouseOptions

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

Formats the value using the given formatter.

impl Default for MouseOptions

fn default() -> MouseOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MouseOptions

where MouseOptions: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for MouseOptions

impl From<MouseButton> for MouseOptions

fn from(button: MouseButton) -> Self

Converts to this type from the input type.

impl PartialEq for MouseOptions

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for MouseOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MouseOptions