Struct KittyKeyboardFlags

Source

pub struct KittyKeyboardFlags {
    pub disambiguate_escape_codes: bool,
    pub report_event_types: bool,
    pub report_alternate_keys: bool,
    pub report_all_keys_as_escape_codes: bool,
    pub report_associated_text: bool,
}

Expand description

The Kitty keyboard protocol enhancement flags a child program has pushed with CSI > <flags> u.

A terminal must not send the protocol’s CSI u encodings until the child has asked for them, so these gate key_event_to_bytes. Only disambiguate_escape_codes changes what this encoder emits today; the rest are surfaced so hosts can see what the child negotiated.

Fields§

§disambiguate_escape_codes: bool

Bit 1. Keys with no unambiguous legacy encoding are reported as CSI <codepoint>;<mod> u, and a lone Esc becomes CSI 27 u so it cannot be confused with an escape sequence.

§report_event_types: bool

Bit 2. Key release and repeat events are reported. Not emitted: KeyEvent carries no kind.

§report_alternate_keys: bool

Bit 4. Shifted and base-layout key codes accompany each report. Not emitted.

§report_all_keys_as_escape_codes: bool

Bit 8. Every key, including plain text, is reported as an escape code. Not emitted.

§report_associated_text: bool

Bit 16. The text a key would produce accompanies each report. Not emitted.

Struct KittyKeyboardFlags Copy item path

Fields§

Implementations§

impl KittyKeyboardFlags

pub fn any(&self) -> bool

Trait Implementations§

impl Clone for KittyKeyboardFlags

fn clone(&self) -> KittyKeyboardFlags

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

impl Copy for KittyKeyboardFlags

impl Debug for KittyKeyboardFlags

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

impl Default for KittyKeyboardFlags

fn default() -> KittyKeyboardFlags

impl<'de> Deserialize<'de> for KittyKeyboardFlags

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

impl Eq for KittyKeyboardFlags

impl PartialEq for KittyKeyboardFlags

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

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

impl Serialize for KittyKeyboardFlags

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

impl StructuralPartialEq for KittyKeyboardFlags

Auto Trait Implementations§

impl Freeze for KittyKeyboardFlags

impl RefUnwindSafe for KittyKeyboardFlags

impl Send for KittyKeyboardFlags

impl Sync for KittyKeyboardFlags

impl Unpin for KittyKeyboardFlags

impl UnsafeUnpin for KittyKeyboardFlags

impl UnwindSafe for KittyKeyboardFlags

Blanket Implementations§

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for Swhere T: Real + Zero + Arithmetics + Clone, Swp: WhitePoint<T>, Dwp: WhitePoint<T>, D: AdaptFrom<S, Swp, Dwp, T>,

fn adapt_into_using<M>(self, method: M) -> Dwhere M: TransformMatrix<T>,

fn adapt_into(self) -> D

impl<T, C> AdaptIntoUnclamped<T> for Cwhere T: AdaptFromUnclamped<C>,

type Scalar = <T as AdaptFromUnclamped<C>>::Scalar

fn adapt_into_unclamped_with<M>(self) -> Twhere M: LmsToXyz<<C as AdaptIntoUnclamped<T>>::Scalar> + XyzToLms<<C as AdaptIntoUnclamped<T>>::Scalar>,

fn adapt_into_unclamped(self) -> Twhere Bradford: LmsToXyz<Self::Scalar> + XyzToLms<Self::Scalar>,

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T, C> ArraysFrom<C> for Twhere C: IntoArrays<T>,

fn arrays_from(colors: C) -> T

impl<T, C> ArraysInto<C> for Twhere C: FromArrays<T>,

fn arrays_into(self) -> C

impl<T> AsOut<T> for Twhere T: Copy,

fn as_out(&mut self) -> Out<'_, T>

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for Uwhere T: FromCam16Unclamped<WpParam, U>,

type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar

fn cam16_into_unclamped( self, parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar>, ) -> T

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DTwhere ST: ?Sized, DT: ?Sized,

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DTwhere ST: ?Sized, DT: ?Sized,

impl<T> CloneToUninit for Twhere T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

impl<T, C> ComponentsFrom<C> for Twhere C: IntoComponents<T>,

fn components_from(colors: C) -> T

impl<T> ContextValue for Twhere T: Clone + PartialEq + 'static,

impl<T> Conv for T

fn conv<T>(self) -> Twhere Self: Into<T>,

impl<T> DeserializeOwned for Twhere T: for<'de> Deserialize<'de>,

impl<T> Downcast for Twhere T: Any,

fn into_any(self: Box<T>) -> Box<dyn Any>

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

fn as_any(&self) -> &(dyn Any + 'static)

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

impl<T> DowncastSync for Twhere T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send> ⓘ

impl<T> DragPayload for Twhere T: Any + Debug + 'static,

fn as_any(&self) -> &(dyn Any + 'static)

fn into_arc(self: Box<T>) -> Arc<dyn DragPayload> ⓘ

impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

impl<T> FmtForward for T

fn fmt_binary(self) -> FmtBinary<Self>where Self: Binary,

fn fmt_display(self) -> FmtDisplay<Self>where Self: Display,

fn fmt_lower_exp(self) -> FmtLowerExp<Self>where Self: LowerExp,

Struct KittyKeyboardFlags

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S
where T: Real + Zero + Arithmetics + Clone, Swp: WhitePoint<T>, Dwp: WhitePoint<T>, D: AdaptFrom<S, Swp, Dwp, T>,

fn adapt_into_using<M>(self, method: M) -> D
where M: TransformMatrix<T>,

impl<T, C> AdaptIntoUnclamped<T> for C
where T: AdaptFromUnclamped<C>,

fn adapt_into_unclamped_with<M>(self) -> T
where M: LmsToXyz<<C as AdaptIntoUnclamped<T>>::Scalar> + XyzToLms<<C as AdaptIntoUnclamped<T>>::Scalar>,

fn adapt_into_unclamped(self) -> T
where Bradford: LmsToXyz<Self::Scalar> + XyzToLms<Self::Scalar>,

impl<T> Any for T
where T: 'static + ?Sized,

impl<T, C> ArraysFrom<C> for T
where C: IntoArrays<T>,

impl<T, C> ArraysInto<C> for T
where C: FromArrays<T>,

impl<T> AsOut<T> for T
where T: Copy,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for U
where T: FromCam16Unclamped<WpParam, U>,

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

impl<T> CloneToUninit for T
where T: Clone,

impl<T, C> ComponentsFrom<C> for T
where C: IntoComponents<T>,

impl<T> ContextValue for T
where T: Clone + PartialEq + 'static,

fn conv<T>(self) -> T
where Self: Into<T>,

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<T> Downcast for T
where T: Any,

impl<T> DowncastSync for T
where T: Any + Send + Sync,

impl<T> DragPayload for T
where T: Any + Debug + 'static,

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

impl<T, U> FromStimulus<U> for T
where U: IntoStimulus<T>,

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

impl<T, U> IntoAngle<U> for T
where U: FromAngle<T>,

impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for U
where T: Cam16FromUnclamped<WpParam, U>,

impl<T, U> IntoColor<U> for T
where U: FromColor<T>,

impl<T, U> IntoColorUnclamped<U> for T
where U: FromColorUnclamped<T>,

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

impl<T> Pipe for T
where T: ?Sized,

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

impl<T> ResetDiscriminant<T> for T
where T: Copy,

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,