Skip to main content

TermCaps

devela::sys::os::term

Struct TermCaps 

Source 
pub struct TermCaps { /* private fields */ }
Available on crate feature term only.
Expand description

๐Ÿฎ– โฌก โŠ† โ–ซ๏ธ Terminal capability bits.

๐Ÿ“ sys/os/term

๐Ÿ“ฆ size_of::<TermCaps>() == 4 bytes / 32 bits

Stores independent terminal feature flags plus the maximum known color depth.

See also TermCap.

Implementationsยง

Sourceยง

impl TermCaps

Source

pub const EMPTY: Self

Returns an empty terminal capability set.

Source

pub const ANSI_BASE: Self

A conservative ANSI terminal baseline.

Source

pub const fn color_depth(self) -> ColorDepth

Returns the maximum known terminal color depth.

Source

pub const fn with_color_depth_enum(self, depth: ColorDepth) -> Self

Returns a copy with the given color depth.

Source

pub const fn set_color_depth_enum(&mut self, depth: ColorDepth)

Sets the maximum known terminal color depth.

Source

pub const fn has(self, cap: TermCap) -> bool

Returns whether cap is present.

Source

pub const fn set_cap(&mut self, cap: TermCap)

Returns a copy with cap enabled.

Source

pub const fn unset_cap(&mut self, cap: TermCap)

Returns a copy with cap enabled.

Source

pub const fn with_cap(self, cap: TermCap) -> Self

Returns a copy with cap enabled.

Source

pub const fn without_cap(self, cap: TermCap) -> Self

Returns a copy with cap disabled.

Sourceยง

impl TermCaps

ยงNamed bit field masks.

These constants represent each fieldโ€™s occupied bit range, not a field value.

Use them with mask-level methods such as contains_mask, with_mask and without_mask.

Source

pub const KEYBOARD: Self

1 Keyboard input.

Source

pub const MOUSE: Self

1 Mouse press/release.

Source

pub const MOUSE_DRAG: Self

1 Mouse drag.

Source

pub const MOUSE_MOTION: Self

1 Mouse motion.

Source

pub const MOUSE_SGR: Self

1 SGR mouse cell-coordinate mode.

Source

pub const MOUSE_SGR_PIXELS: Self

1 SGR mouse pixel-coordinate mode.

Source

pub const FOCUS: Self

1 Focus-in/focus-out.

Source

pub const BRACKETED_PASTE: Self

1 Bracketed paste.

Source

pub const RESIZE: Self

1 Terminal resize.

Source

pub const ANSI: Self

1 ANSI/VT escape sequences.

Source

pub const CURSOR: Self

1 Cursor movement and visibility control.

Source

pub const STYLE: Self

1 SGR styling, such as bold, reset, and colors.

Source

pub const ALT_SCREEN: Self

1 Alternate screen buffer.

Source

pub const SYNC_UPDATE: Self

1 Synchronized output updates.

Source

pub const SIXEL: Self

1 Sixel image output.

Source

pub const KITTY_IMAGE: Self

1 Kitty graphics protocol image output.

Source

pub const ITERM_IMAGE: Self

1 iTerm2 inline image output.

Source

pub const QUERY_DEVICE_ATTRS: Self

1 Device-attributes query replies.

Source

pub const QUERY_CURSOR_POS: Self

1 Cursor-position query replies.

Source

pub const QUERY_COLOR: Self

1 Color query replies.

Source

pub const COLOR_DEPTH: Self

+ Terminal color depth.

Sourceยง

impl TermCaps

Source

pub const fn new() -> Self

Returns a new bitfield with all bits cleared.

Source

pub const fn from_bits(bits: u32) -> Self

Returns a new bitfield from raw bits.

Source

pub const fn bits(self) -> u32

Returns the raw backing bits.

Source

pub const fn mask() -> u32

Returns the raw mask covering all declared fields.

Source

pub const fn all() -> Self

Returns a bitfield value with every declared field bit set.

Source

pub const fn is_empty(self) -> bool

Returns true if all raw bits are clear.

Source

pub const fn is_full(self) -> bool

Returns true if the raw bits exactly equal the declared field mask.

Source

pub const fn fields_are_zero(self) -> bool

Returns true if all declared field bits are clear.

Source

pub const fn fields_are_full(self) -> bool

Returns true if all declared field bits are set.

Source

pub const fn contains_mask(self, other: Self) -> bool

Returns true if all bits in other are set in self.

This is a mask-level predicate. When used with a named field constant, it checks whether every bit occupied by that field is set.

Source

pub const fn has_extra_bits(self) -> bool

Returns true if any bit outside the declared field mask is set.

Source

pub const fn clear(&mut self)

Clears all bits.

Source

pub const fn clear_fields(&mut self)

Clears all declared field bits, preserving bits outside the declared field mask.

Source

pub const fn without_fields(self) -> Self

Returns self with all declared field bits cleared, preserving extra bits.

Source

pub const fn with_mask(self, other: Self) -> Self

Returns self with all bits in other set.

This is a mask-level operation. Use with_FIELD(value) to replace a field value.

Source

pub const fn with_mask_if(self, condition: bool, other: Self) -> Self

Returns self with all bits in other set if condition is true.

Source

pub const fn without_mask(self, other: Self) -> Self

Returns self with all bits in other cleared.

This is a mask-level operation. It clears the occupied bits, regardless of the current field value.

Source

pub const fn without_mask_if(self, condition: bool, other: Self) -> Self

Returns self with all bits in other cleared if condition is true.

Sourceยง

impl TermCaps

ยงMethods for KEYBOARD

Source

pub const fn get_keyboard(self) -> u32

Returns the field value.

Source

pub const fn with_keyboard(self, value: u32) -> Self

Returns self with the field value replaced, masking it to fit the field width.

Source

pub const fn try_with_keyboard( self, value: u32, ) -> Result<Self, MismatchedCapacity> โ“˜

Returns self with the checked field value replaced, if it fits.

Source

pub const fn set_keyboard(&mut self, value: u32)

Replaces the field value, masking it to fit the field width.

Source

pub const fn try_set_keyboard( &mut self, value: u32, ) -> Result<(), MismatchedCapacity> โ“˜

Replaces the field value, if it fits.

Source

pub const fn clear_keyboard(&mut self)

Clears the field value.

Source

pub const fn is_keyboard_zero(self) -> bool

Returns true if the field value is zero.

Source

pub const fn is_keyboard_max(self) -> bool

Returns true if the field value equals its maximum.

Source

pub const fn keyboard_span() -> BitSpan<u32>

Returns metadata for this field.

Sourceยง

impl TermCaps

ยงMethods for MOUSE

Source

pub const fn get_mouse(self) -> u32

Returns the field value.

Source

pub const fn with_mouse(self, value: u32) -> Self

Returns self with the field value replaced, masking it to fit the field width.

Source

pub const fn try_with_mouse( self, value: u32, ) -> Result<Self, MismatchedCapacity> โ“˜

Returns self with the checked field value replaced, if it fits.

Source

pub const fn set_mouse(&mut self, value: u32)

Replaces the field value, masking it to fit the field width.

Source

pub const fn try_set_mouse( &mut self, value: u32, ) -> Result<(), MismatchedCapacity> โ“˜

Replaces the field value, if it fits.

Source

pub const fn clear_mouse(&mut self)

Clears the field value.

Source

pub const fn is_mouse_zero(self) -> bool

Returns true if the field value is zero.

Source

pub const fn is_mouse_max(self) -> bool

Returns true if the field value equals its maximum.

Source

pub const fn mouse_span() -> BitSpan<u32>

Returns metadata for this field.

Sourceยง

impl TermCaps

ยงMethods for MOUSE_DRAG

Source

pub const fn get_mouse_drag(self) -> u32

Returns the field value.

Source

pub const fn with_mouse_drag(self, value: u32) -> Self

Returns self with the field value replaced, masking it to fit the field width.

Source

pub const fn try_with_mouse_drag( self, value: u32, ) -> Result<Self, MismatchedCapacity> โ“˜

Returns self with the checked field value replaced, if it fits.

Source

pub const fn set_mouse_drag(&mut self, value: u32)

Replaces the field value, masking it to fit the field width.

Source

pub const fn try_set_mouse_drag( &mut self, value: u32, ) -> Result<(), MismatchedCapacity> โ“˜

Replaces the field value, if it fits.

Source

pub const fn clear_mouse_drag(&mut self)

Clears the field value.

Source

pub const fn is_mouse_drag_zero(self) -> bool

Returns true if the field value is zero.

Source

pub const fn is_mouse_drag_max(self) -> bool

Returns true if the field value equals its maximum.

Source

pub const fn mouse_drag_span() -> BitSpan<u32>

Returns metadata for this field.

Sourceยง

impl TermCaps

ยงMethods for MOUSE_MOTION

Source

pub const fn get_mouse_motion(self) -> u32

Returns the field value.

Source

pub const fn with_mouse_motion(self, value: u32) -> Self

Returns self with the field value replaced, masking it to fit the field width.

Source

pub const fn try_with_mouse_motion( self, value: u32, ) -> Result<Self, MismatchedCapacity> โ“˜

Returns self with the checked field value replaced, if it fits.

Source

pub const fn set_mouse_motion(&mut self, value: u32)

Replaces the field value, masking it to fit the field width.

Source

pub const fn try_set_mouse_motion( &mut self, value: u32, ) -> Result<(), MismatchedCapacity> โ“˜

Replaces the field value, if it fits.

Source

pub const fn clear_mouse_motion(&mut self)

Clears the field value.

Source

pub const fn is_mouse_motion_zero(self) -> bool

Returns true if the field value is zero.

Source

pub const fn is_mouse_motion_max(self) -> bool

Returns true if the field value equals its maximum.

Source

pub const fn mouse_motion_span() -> BitSpan<u32>

Returns metadata for this field.

Sourceยง

impl TermCaps

ยงMethods for MOUSE_SGR

Source

pub const fn get_mouse_sgr(self) -> u32

Returns the field value.

Source

pub const fn with_mouse_sgr(self, value: u32) -> Self

Returns self with the field value replaced, masking it to fit the field width.

Source

pub const fn try_with_mouse_sgr( self, value: u32, ) -> Result<Self, MismatchedCapacity> โ“˜

Returns self with the checked field value replaced, if it fits.

Source

pub const fn set_mouse_sgr(&mut self, value: u32)

Replaces the field value, masking it to fit the field width.

Source

pub const fn try_set_mouse_sgr( &mut self, value: u32, ) -> Result<(), MismatchedCapacity> โ“˜

Replaces the field value, if it fits.

Source

pub const fn clear_mouse_sgr(&mut self)

Clears the field value.

Source

pub const fn is_mouse_sgr_zero(self) -> bool

Returns true if the field value is zero.

Source

pub const fn is_mouse_sgr_max(self) -> bool

Returns true if the field value equals its maximum.

Source

pub const fn mouse_sgr_span() -> BitSpan<u32>

Returns metadata for this field.

Sourceยง

impl TermCaps

ยงMethods for MOUSE_SGR_PIXELS

Source

pub const fn get_mouse_sgr_pixels(self) -> u32

Returns the field value.

Source

pub const fn with_mouse_sgr_pixels(self, value: u32) -> Self

Returns self with the field value replaced, masking it to fit the field width.

Source

pub const fn try_with_mouse_sgr_pixels( self, value: u32, ) -> Result<Self, MismatchedCapacity> โ“˜

Returns self with the checked field value replaced, if it fits.

Source

pub const fn set_mouse_sgr_pixels(&mut self, value: u32)

Replaces the field value, masking it to fit the field width.

Source

pub const fn try_set_mouse_sgr_pixels( &mut self, value: u32, ) -> Result<(), MismatchedCapacity> โ“˜

Replaces the field value, if it fits.

Source

pub const fn clear_mouse_sgr_pixels(&mut self)

Clears the field value.

Source

pub const fn is_mouse_sgr_pixels_zero(self) -> bool

Returns true if the field value is zero.

Source

pub const fn is_mouse_sgr_pixels_max(self) -> bool

Returns true if the field value equals its maximum.

Source

pub const fn mouse_sgr_pixels_span() -> BitSpan<u32>

Returns metadata for this field.

Sourceยง

impl TermCaps

ยงMethods for FOCUS

Source

pub const fn get_focus(self) -> u32

Returns the field value.

Source

pub const fn with_focus(self, value: u32) -> Self

Returns self with the field value replaced, masking it to fit the field width.

Source

pub const fn try_with_focus( self, value: u32, ) -> Result<Self, MismatchedCapacity> โ“˜

Returns self with the checked field value replaced, if it fits.

Source

pub const fn set_focus(&mut self, value: u32)

Replaces the field value, masking it to fit the field width.

Source

pub const fn try_set_focus( &mut self, value: u32, ) -> Result<(), MismatchedCapacity> โ“˜

Replaces the field value, if it fits.

Source

pub const fn clear_focus(&mut self)

Clears the field value.

Source

pub const fn is_focus_zero(self) -> bool

Returns true if the field value is zero.

Source

pub const fn is_focus_max(self) -> bool

Returns true if the field value equals its maximum.

Source

pub const fn focus_span() -> BitSpan<u32>

Returns metadata for this field.

Sourceยง

impl TermCaps

ยงMethods for BRACKETED_PASTE

Source

pub const fn get_bracketed_paste(self) -> u32

Returns the field value.

Source

pub const fn with_bracketed_paste(self, value: u32) -> Self

Returns self with the field value replaced, masking it to fit the field width.

Source

pub const fn try_with_bracketed_paste( self, value: u32, ) -> Result<Self, MismatchedCapacity> โ“˜

Returns self with the checked field value replaced, if it fits.

Source

pub const fn set_bracketed_paste(&mut self, value: u32)

Replaces the field value, masking it to fit the field width.

Source

pub const fn try_set_bracketed_paste( &mut self, value: u32, ) -> Result<(), MismatchedCapacity> โ“˜

Replaces the field value, if it fits.

Source

pub const fn clear_bracketed_paste(&mut self)

Clears the field value.

Source

pub const fn is_bracketed_paste_zero(self) -> bool

Returns true if the field value is zero.

Source

pub const fn is_bracketed_paste_max(self) -> bool

Returns true if the field value equals its maximum.

Source

pub const fn bracketed_paste_span() -> BitSpan<u32>

Returns metadata for this field.

Sourceยง

impl TermCaps

ยงMethods for RESIZE

Source

pub const fn get_resize(self) -> u32

Returns the field value.

Source

pub const fn with_resize(self, value: u32) -> Self

Returns self with the field value replaced, masking it to fit the field width.

Source

pub const fn try_with_resize( self, value: u32, ) -> Result<Self, MismatchedCapacity> โ“˜

Returns self with the checked field value replaced, if it fits.

Source

pub const fn set_resize(&mut self, value: u32)

Replaces the field value, masking it to fit the field width.

Source

pub const fn try_set_resize( &mut self, value: u32, ) -> Result<(), MismatchedCapacity> โ“˜

Replaces the field value, if it fits.

Source

pub const fn clear_resize(&mut self)

Clears the field value.

Source

pub const fn is_resize_zero(self) -> bool

Returns true if the field value is zero.

Source

pub const fn is_resize_max(self) -> bool

Returns true if the field value equals its maximum.

Source

pub const fn resize_span() -> BitSpan<u32>

Returns metadata for this field.

Sourceยง

impl TermCaps

ยงMethods for ANSI

Source

pub const fn get_ansi(self) -> u32

Returns the field value.

Source

pub const fn with_ansi(self, value: u32) -> Self

Returns self with the field value replaced, masking it to fit the field width.

Source

pub const fn try_with_ansi(self, value: u32) -> Result<Self, MismatchedCapacity> โ“˜

Returns self with the checked field value replaced, if it fits.

Source

pub const fn set_ansi(&mut self, value: u32)

Replaces the field value, masking it to fit the field width.

Source

pub const fn try_set_ansi( &mut self, value: u32, ) -> Result<(), MismatchedCapacity> โ“˜

Replaces the field value, if it fits.

Source

pub const fn clear_ansi(&mut self)

Clears the field value.

Source

pub const fn is_ansi_zero(self) -> bool

Returns true if the field value is zero.

Source

pub const fn is_ansi_max(self) -> bool

Returns true if the field value equals its maximum.

Source

pub const fn ansi_span() -> BitSpan<u32>

Returns metadata for this field.

Sourceยง

impl TermCaps

ยงMethods for CURSOR

Source

pub const fn get_cursor(self) -> u32

Returns the field value.

Source

pub const fn with_cursor(self, value: u32) -> Self

Returns self with the field value replaced, masking it to fit the field width.

Source

pub const fn try_with_cursor( self, value: u32, ) -> Result<Self, MismatchedCapacity> โ“˜

Returns self with the checked field value replaced, if it fits.

Source

pub const fn set_cursor(&mut self, value: u32)

Replaces the field value, masking it to fit the field width.

Source

pub const fn try_set_cursor( &mut self, value: u32, ) -> Result<(), MismatchedCapacity> โ“˜

Replaces the field value, if it fits.

Source

pub const fn clear_cursor(&mut self)

Clears the field value.

Source

pub const fn is_cursor_zero(self) -> bool

Returns true if the field value is zero.

Source

pub const fn is_cursor_max(self) -> bool

Returns true if the field value equals its maximum.

Source

pub const fn cursor_span() -> BitSpan<u32>

Returns metadata for this field.

Sourceยง

impl TermCaps

ยงMethods for STYLE

Source

pub const fn get_style(self) -> u32

Returns the field value.

Source

pub const fn with_style(self, value: u32) -> Self

Returns self with the field value replaced, masking it to fit the field width.

Source

pub const fn try_with_style( self, value: u32, ) -> Result<Self, MismatchedCapacity> โ“˜

Returns self with the checked field value replaced, if it fits.

Source

pub const fn set_style(&mut self, value: u32)

Replaces the field value, masking it to fit the field width.

Source

pub const fn try_set_style( &mut self, value: u32, ) -> Result<(), MismatchedCapacity> โ“˜

Replaces the field value, if it fits.

Source

pub const fn clear_style(&mut self)

Clears the field value.

Source

pub const fn is_style_zero(self) -> bool

Returns true if the field value is zero.

Source

pub const fn is_style_max(self) -> bool

Returns true if the field value equals its maximum.

Source

pub const fn style_span() -> BitSpan<u32>

Returns metadata for this field.

Sourceยง

impl TermCaps

ยงMethods for ALT_SCREEN

Source

pub const fn get_alt_screen(self) -> u32

Returns the field value.

Source

pub const fn with_alt_screen(self, value: u32) -> Self

Returns self with the field value replaced, masking it to fit the field width.

Source

pub const fn try_with_alt_screen( self, value: u32, ) -> Result<Self, MismatchedCapacity> โ“˜

Returns self with the checked field value replaced, if it fits.

Source

pub const fn set_alt_screen(&mut self, value: u32)

Replaces the field value, masking it to fit the field width.

Source

pub const fn try_set_alt_screen( &mut self, value: u32, ) -> Result<(), MismatchedCapacity> โ“˜

Replaces the field value, if it fits.

Source

pub const fn clear_alt_screen(&mut self)

Clears the field value.

Source

pub const fn is_alt_screen_zero(self) -> bool

Returns true if the field value is zero.

Source

pub const fn is_alt_screen_max(self) -> bool

Returns true if the field value equals its maximum.

Source

pub const fn alt_screen_span() -> BitSpan<u32>

Returns metadata for this field.

Sourceยง

impl TermCaps

ยงMethods for SYNC_UPDATE

Source

pub const fn get_sync_update(self) -> u32

Returns the field value.

Source

pub const fn with_sync_update(self, value: u32) -> Self

Returns self with the field value replaced, masking it to fit the field width.

Source

pub const fn try_with_sync_update( self, value: u32, ) -> Result<Self, MismatchedCapacity> โ“˜

Returns self with the checked field value replaced, if it fits.

Source

pub const fn set_sync_update(&mut self, value: u32)

Replaces the field value, masking it to fit the field width.

Source

pub const fn try_set_sync_update( &mut self, value: u32, ) -> Result<(), MismatchedCapacity> โ“˜

Replaces the field value, if it fits.

Source

pub const fn clear_sync_update(&mut self)

Clears the field value.

Source

pub const fn is_sync_update_zero(self) -> bool

Returns true if the field value is zero.

Source

pub const fn is_sync_update_max(self) -> bool

Returns true if the field value equals its maximum.

Source

pub const fn sync_update_span() -> BitSpan<u32>

Returns metadata for this field.

Sourceยง

impl TermCaps

ยงMethods for SIXEL

Source

pub const fn get_sixel(self) -> u32

Returns the field value.

Source

pub const fn with_sixel(self, value: u32) -> Self

Returns self with the field value replaced, masking it to fit the field width.

Source

pub const fn try_with_sixel( self, value: u32, ) -> Result<Self, MismatchedCapacity> โ“˜

Returns self with the checked field value replaced, if it fits.

Source

pub const fn set_sixel(&mut self, value: u32)

Replaces the field value, masking it to fit the field width.

Source

pub const fn try_set_sixel( &mut self, value: u32, ) -> Result<(), MismatchedCapacity> โ“˜

Replaces the field value, if it fits.

Source

pub const fn clear_sixel(&mut self)

Clears the field value.

Source

pub const fn is_sixel_zero(self) -> bool

Returns true if the field value is zero.

Source

pub const fn is_sixel_max(self) -> bool

Returns true if the field value equals its maximum.

Source

pub const fn sixel_span() -> BitSpan<u32>

Returns metadata for this field.

Sourceยง

impl TermCaps

ยงMethods for KITTY_IMAGE

Source

pub const fn get_kitty_image(self) -> u32

Returns the field value.

Source

pub const fn with_kitty_image(self, value: u32) -> Self

Returns self with the field value replaced, masking it to fit the field width.

Source

pub const fn try_with_kitty_image( self, value: u32, ) -> Result<Self, MismatchedCapacity> โ“˜

Returns self with the checked field value replaced, if it fits.

Source

pub const fn set_kitty_image(&mut self, value: u32)

Replaces the field value, masking it to fit the field width.

Source

pub const fn try_set_kitty_image( &mut self, value: u32, ) -> Result<(), MismatchedCapacity> โ“˜

Replaces the field value, if it fits.

Source

pub const fn clear_kitty_image(&mut self)

Clears the field value.

Source

pub const fn is_kitty_image_zero(self) -> bool

Returns true if the field value is zero.

Source

pub const fn is_kitty_image_max(self) -> bool

Returns true if the field value equals its maximum.

Source

pub const fn kitty_image_span() -> BitSpan<u32>

Returns metadata for this field.

Sourceยง

impl TermCaps

ยงMethods for ITERM_IMAGE

Source

pub const fn get_iterm_image(self) -> u32

Returns the field value.

Source

pub const fn with_iterm_image(self, value: u32) -> Self

Returns self with the field value replaced, masking it to fit the field width.

Source

pub const fn try_with_iterm_image( self, value: u32, ) -> Result<Self, MismatchedCapacity> โ“˜

Returns self with the checked field value replaced, if it fits.

Source

pub const fn set_iterm_image(&mut self, value: u32)

Replaces the field value, masking it to fit the field width.

Source

pub const fn try_set_iterm_image( &mut self, value: u32, ) -> Result<(), MismatchedCapacity> โ“˜

Replaces the field value, if it fits.

Source

pub const fn clear_iterm_image(&mut self)

Clears the field value.

Source

pub const fn is_iterm_image_zero(self) -> bool

Returns true if the field value is zero.

Source

pub const fn is_iterm_image_max(self) -> bool

Returns true if the field value equals its maximum.

Source

pub const fn iterm_image_span() -> BitSpan<u32>

Returns metadata for this field.

Sourceยง

impl TermCaps

ยงMethods for QUERY_DEVICE_ATTRS

Source

pub const fn get_query_device_attrs(self) -> u32

Returns the field value.

Source

pub const fn with_query_device_attrs(self, value: u32) -> Self

Returns self with the field value replaced, masking it to fit the field width.

Source

pub const fn try_with_query_device_attrs( self, value: u32, ) -> Result<Self, MismatchedCapacity> โ“˜

Returns self with the checked field value replaced, if it fits.

Source

pub const fn set_query_device_attrs(&mut self, value: u32)

Replaces the field value, masking it to fit the field width.

Source

pub const fn try_set_query_device_attrs( &mut self, value: u32, ) -> Result<(), MismatchedCapacity> โ“˜

Replaces the field value, if it fits.

Source

pub const fn clear_query_device_attrs(&mut self)

Clears the field value.

Source

pub const fn is_query_device_attrs_zero(self) -> bool

Returns true if the field value is zero.

Source

pub const fn is_query_device_attrs_max(self) -> bool

Returns true if the field value equals its maximum.

Source

pub const fn query_device_attrs_span() -> BitSpan<u32>

Returns metadata for this field.

Sourceยง

impl TermCaps

ยงMethods for QUERY_CURSOR_POS

Source

pub const fn get_query_cursor_pos(self) -> u32

Returns the field value.

Source

pub const fn with_query_cursor_pos(self, value: u32) -> Self

Returns self with the field value replaced, masking it to fit the field width.

Source

pub const fn try_with_query_cursor_pos( self, value: u32, ) -> Result<Self, MismatchedCapacity> โ“˜

Returns self with the checked field value replaced, if it fits.

Source

pub const fn set_query_cursor_pos(&mut self, value: u32)

Replaces the field value, masking it to fit the field width.

Source

pub const fn try_set_query_cursor_pos( &mut self, value: u32, ) -> Result<(), MismatchedCapacity> โ“˜

Replaces the field value, if it fits.

Source

pub const fn clear_query_cursor_pos(&mut self)

Clears the field value.

Source

pub const fn is_query_cursor_pos_zero(self) -> bool

Returns true if the field value is zero.

Source

pub const fn is_query_cursor_pos_max(self) -> bool

Returns true if the field value equals its maximum.

Source

pub const fn query_cursor_pos_span() -> BitSpan<u32>

Returns metadata for this field.

Sourceยง

impl TermCaps

ยงMethods for QUERY_COLOR

Source

pub const fn get_query_color(self) -> u32

Returns the field value.

Source

pub const fn with_query_color(self, value: u32) -> Self

Returns self with the field value replaced, masking it to fit the field width.

Source

pub const fn try_with_query_color( self, value: u32, ) -> Result<Self, MismatchedCapacity> โ“˜

Returns self with the checked field value replaced, if it fits.

Source

pub const fn set_query_color(&mut self, value: u32)

Replaces the field value, masking it to fit the field width.

Source

pub const fn try_set_query_color( &mut self, value: u32, ) -> Result<(), MismatchedCapacity> โ“˜

Replaces the field value, if it fits.

Source

pub const fn clear_query_color(&mut self)

Clears the field value.

Source

pub const fn is_query_color_zero(self) -> bool

Returns true if the field value is zero.

Source

pub const fn is_query_color_max(self) -> bool

Returns true if the field value equals its maximum.

Source

pub const fn query_color_span() -> BitSpan<u32>

Returns metadata for this field.

Sourceยง

impl TermCaps

ยงMethods for COLOR_DEPTH

Source

pub const fn get_color_depth(self) -> u32

Returns the field value.

Source

pub const fn with_color_depth(self, value: u32) -> Self

Returns self with the field value replaced, masking it to fit the field width.

Source

pub const fn try_with_color_depth( self, value: u32, ) -> Result<Self, MismatchedCapacity> โ“˜

Returns self with the checked field value replaced, if it fits.

Source

pub const fn set_color_depth(&mut self, value: u32)

Replaces the field value, masking it to fit the field width.

Source

pub const fn try_set_color_depth( &mut self, value: u32, ) -> Result<(), MismatchedCapacity> โ“˜

Replaces the field value, if it fits.

Source

pub const fn clear_color_depth(&mut self)

Clears the field value.

Source

pub const fn is_color_depth_zero(self) -> bool

Returns true if the field value is zero.

Source

pub const fn is_color_depth_max(self) -> bool

Returns true if the field value equals its maximum.

Source

pub const fn color_depth_span() -> BitSpan<u32>

Returns metadata for this field.

Trait Implementationsยง

Sourceยง

impl Binary for TermCaps

Formats the set as a binary mask over its declared bit domain.

Sourceยง

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

Formats the value using the given formatter. Read more
Sourceยง

impl BitSized<{ $Bitfield::_BITFIELD_BIT_SIZE }> for TermCaps

Sourceยง

const BIT_SIZE: usize = _

The bit size of this type (only the relevant data part, without padding). Read more
Sourceยง

const MIN_BYTE_SIZE: usize = _

The rounded up byte size for this type. Read more
Sourceยง

fn bit_size(&self) -> usize

Returns the bit size of this type (only the relevant data part, without padding). Read more
Sourceยง

fn min_byte_size(&self) -> usize

Returns the rounded up byte size for this type. Read more
Sourceยง

impl Clone for TermCaps

Sourceยง

fn clone(&self) -> TermCaps

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) ยท Sourceยง

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

Performs copy-assignment from source. Read more
Sourceยง

impl ConstInit for TermCaps

Sourceยง

const INIT: Self

Returns the compile-time โ€œinitial valueโ€ for a type.
Sourceยง

impl Copy for TermCaps

Sourceยง

impl Debug for TermCaps

Formats the bitfield as named field values.

Sourceยง

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

Formats the value using the given formatter. Read more
Sourceยง

impl DebugExt for TermCaps
where TermCaps: Debug,

Sourceยง

type Ctx = ReprMode

The context used to guide formatting.
Sourceยง

fn fmt_with(&self, f: &mut Formatter<'_>, ctx: &Self::Ctx) -> FmtResult<()>

Formats self under the given context.
Sourceยง

fn debug_with<'a>(&'a self, ctx: &'a Self::Ctx) -> DebugWith<'a, Self>
where Self: Sized,

Wraps self for contextual debug formatting.
Sourceยง

impl Default for TermCaps

Sourceยง

fn default() -> Self

Returns the โ€œdefault valueโ€ for a type. Read more
Sourceยง

impl Display for TermCaps

Formats the bitfield as compact named field values.

Sourceยง

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

Formats the value using the given formatter. Read more
Sourceยง

impl Eq for TermCaps

Sourceยง

impl Hash for TermCaps

Sourceยง

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more
1.3.0 ยท Sourceยง

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Sourceยง

impl LowerHex for TermCaps

Formats the set as a hexadecimal mask over its declared bit domain.

Sourceยง

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

Formats the value using the given formatter. Read more
Sourceยง

impl Octal for TermCaps

Formats the set as an octal mask over its declared bit domain.

Sourceยง

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

Formats the value using the given formatter. Read more
Sourceยง

impl Ord for TermCaps

Sourceยง

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) ยท Sourceยง

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) ยท Sourceยง

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) ยท Sourceยง

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Sourceยง

impl PartialEq for TermCaps

Sourceยง

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) ยท Sourceยง

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

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

impl PartialOrd for TermCaps

Sourceยง

fn partial_cmp(&self, other: &Self) -> Option<Ordering> โ“˜

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) ยท Sourceยง

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) ยท Sourceยง

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) ยท Sourceยง

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) ยท Sourceยง

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Sourceยง

impl UpperHex for TermCaps

Formats the set as a hexadecimal mask over its declared bit domain.

Sourceยง

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

Formats the value using the given formatter. Read more

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> AnyExt for T
where T: Any + ?Sized,

Sourceยง

fn type_id() -> TypeId

Returns the TypeId of Self. Read more
Sourceยง

fn type_of(&self) -> TypeId

Returns the TypeId of self. Read more
Sourceยง

fn type_name(&self) -> &'static str โ“˜

Returns the type name of self. Read more
Sourceยง

fn type_is<T: 'static>(&self) -> bool

Returns true if Self is of type T. Read more
Sourceยง

fn type_hash(&self) -> u64

Returns a deterministic hash of the TypeId of Self.
Sourceยง

fn type_hash_with<H: Hasher>(&self, hasher: H) -> u64

Returns a deterministic hash of the TypeId of Self using a custom hasher.
Sourceยง

fn as_any_ref(&self) -> &dyn Any
where Self: Sized,

Upcasts &self as &dyn Any. Read more
Sourceยง

fn as_any_mut(&mut self) -> &mut dyn Any
where Self: Sized,

Upcasts &mut self as &mut dyn Any. Read more
Sourceยง

fn as_any_box(self: Box<Self>) -> Box<dyn Any>
where Self: Sized,

Available on crate feature alloc only.
Upcasts Box<self> as Box<dyn Any>. Read more
Sourceยง

fn downcast_ref<T: 'static>(&self) -> Option<&T> โ“˜

Available on crate feature unsafe_layout and non-crate feature safe_code only.
Returns some shared reference to the inner value if it is of type T. Read more
Sourceยง

fn downcast_mut<T: 'static>(&mut self) -> Option<&mut T> โ“˜

Available on crate feature unsafe_layout and non-crate feature safe_code only.
Returns some exclusive reference to the inner value if it is of type T. 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> ByteSized for T

Sourceยง

const BYTE_ALIGN: usize = _

The alignment of this type in bytes.
Sourceยง

const BYTE_SIZE: usize = _

The size of this type in bytes.
Sourceยง

fn byte_align(&self) -> usize

Returns the alignment of this type in bytes.
Sourceยง

fn byte_size(&self) -> usize

Returns the size of this type in bytes. Read more
Sourceยง

fn ptr_size_ratio(&self) -> [usize; 2]

Returns the size ratio between Ptr::BYTES and BYTE_SIZE. Read more
Sourceยง

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

Sourceยง

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

๐Ÿ”ฌThis is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Sourceยง

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

Sourceยง

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

Checks if this value is equivalent to the given key. Read more
Sourceยง

impl<T> From<T> for T

Sourceยง

fn from(t: T) -> T

Returns the argument unchanged.

Sourceยง

impl<T> Hook for T

Sourceยง

fn hook<F>(self, f: F) -> Self
where F: FnOnce(&mut Self),

Hooks a mutation step into the value and returns it. Read more
Sourceยง

fn tap<F>(self, f: F) -> Self
where F: FnOnce(&Self),

Taps into the value for observation and returns it unchanged. 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> MemExt for T
where T: ?Sized,

Sourceยง

const NEEDS_DROP: bool = _

Know whether dropping values of this type matters, in compile-time.
Sourceยง

fn mem_align_of<T>() -> usize

Returns the minimum alignment of the type in bytes. Read more
Sourceยง

fn mem_align_of_val(&self) -> usize

Returns the alignment of the pointed-to value in bytes. Read more
Sourceยง

fn mem_size_of<T>() -> usize

Returns the size of a type in bytes. Read more
Sourceยง

fn mem_size_of_val(&self) -> usize

Returns the size of the pointed-to value in bytes. Read more
Sourceยง

fn mem_copy(&self) -> Self
where Self: Copy,

Bitwise-copies a value. Read more
Sourceยง

fn mem_needs_drop(&self) -> bool

Returns true if dropping values of this type matters. Read more
Sourceยง

fn mem_drop(self)
where Self: Sized,

Drops self by running its destructor. Read more
Sourceยง

fn mem_forget(self)
where Self: Sized,

Forgets about self without running its destructor. Read more
Sourceยง

fn mem_replace(&mut self, other: Self) -> Self
where Self: Sized,

Replaces self with other, returning the previous value of self. Read more
Sourceยง

fn mem_take(&mut self) -> Self
where Self: Default,

Replaces self with its default value, returning the previous value of self. Read more
Sourceยง

fn mem_swap(&mut self, other: &mut Self)
where Self: Sized,

Swaps the value of self and other without deinitializing either one. Read more
Sourceยง

unsafe fn mem_zeroed<T>() -> T

Available on crate feature unsafe_layout only.
Returns the value of type T represented by the all-zero byte-pattern. Read more
Sourceยง

unsafe fn mem_transmute_copy<Src, Dst>(src: &Src) -> Dst

Available on crate feature unsafe_layout only.
Returns the value of type T represented by the all-zero byte-pattern. Read more
Sourceยง

fn mem_as_bytes(&self) -> &[u8] โ“˜
where Self: Sync + Unpin,

Available on crate feature unsafe_slice only.
View a Sync + Unpin self as &[u8]. Read more
Sourceยง

fn mem_as_bytes_mut(&mut self) -> &mut [u8] โ“˜
where Self: Sync + Unpin,

Available on crate feature unsafe_slice only.
View a Sync + Unpin self as &mut [u8]. Read more
Sourceยง

impl<T, R> Morph<R> for T
where T: ?Sized,

Sourceยง

fn morph<F>(self, f: F) -> R
where F: FnOnce(Self) -> R, Self: Sized,

Morphs the value into a new one and returns it. Read more
Sourceยง

fn morph_ref<F>(&self, f: F) -> R
where F: FnOnce(&Self) -> R,

Morphs the value by shared reference and returns the result. Read more
Sourceยง

fn morph_mut<F>(&mut self, f: F) -> R
where F: FnOnce(&mut Self) -> R,

Morphs the value by exclusive reference and returns the result. Read more
Sourceยง

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

Sourceยง

type Owned = T

The resulting type after obtaining ownership.
Sourceยง

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Sourceยง

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Sourceยง

impl<T> ToString for T
where T: Display + ?Sized,

Sourceยง

fn to_string(&self) -> String โ“˜

Converts the given value to a String. 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.