Skip to main content

ClientRenderer

Struct ClientRenderer 

Source
pub struct ClientRenderer {
Show 17 fields any_motion_capture: MouseAnyMotionCapture, tab_bar_dmg: TabBarDmg, selection_style: SelectionStyle, tab_bar_config: TabBarConfig, clicks: SelectionClickTracker, frame_buffer: FrameBuffer, layout: LayoutSnapshot, mouse_capture: Option<MouseCapture>, file_open_capture: Option<FileOpenCapture>, pane_regions: PaneRegionsSnapshot, selection_edge_scroll: SelectionEdgeScrollState, selection: SelectionState, synchronized_output: SynchronizedOutput, terminal_encoder: TerminalUpdateEncoder, render_transaction: Vec<u8>, render_generation: u64, edge_scroll_render_generation: Option<u64>,
}

Fields§

§any_motion_capture: MouseAnyMotionCapture§tab_bar_dmg: TabBarDmg§selection_style: SelectionStyle§tab_bar_config: TabBarConfig§clicks: SelectionClickTracker§frame_buffer: FrameBuffer§layout: LayoutSnapshot§mouse_capture: Option<MouseCapture>§file_open_capture: Option<FileOpenCapture>§pane_regions: PaneRegionsSnapshot§selection_edge_scroll: SelectionEdgeScrollState§selection: SelectionState§synchronized_output: SynchronizedOutput§terminal_encoder: TerminalUpdateEncoder§render_transaction: Vec<u8>§render_generation: u64§edge_scroll_render_generation: Option<u64>

Implementations§

Source§

impl ClientRenderer

Source

pub fn new( config: &MuxrConfig, layout: LayoutSnapshot, pane_regions: PaneRegionsSnapshot, ) -> Self

Source

fn with_config_and_synchronized_output( config: &MuxrConfig, layout: LayoutSnapshot, pane_regions: PaneRegionsSnapshot, synchronized_output: SynchronizedOutput, ) -> Self

Source

pub fn apply_layout(&mut self, layout: LayoutSnapshot)

Source

pub fn apply_sidebar_layout_logical(&mut self, layout: LayoutSnapshot)

Source

pub fn tab_id_at_sidebar_row(&self, row: u16) -> Option<TabId>

Source

pub(crate) fn tab_focus_request_for_sidebar_click( &self, event: ClientMouseEvent, ) -> Option<ClientRequest>

Source

pub fn file_open_request( &self, position: ClientMousePosition, ) -> Option<ClientRequest>

Source

pub const fn begin_file_open_capture(&mut self)

Source

pub const fn finish_file_open_capture(&mut self) -> FileOpenRelease

Source

pub fn apply_pane_regions_logical(&mut self, pane_regions: PaneRegionsSnapshot)

Source

pub fn sync_mouse_capture_logical(&mut self)

Source

fn next_mouse_capture(&self) -> MouseAnyMotionCapture

Source

pub fn apply_render_logical( &mut self, update: RenderUpdate, ) -> Result<ClientRenderOutcome>

Source

pub fn presentation_snapshot(&self) -> ClientPresentationSnapshot

Source

pub fn presentation_transaction( &mut self, committed: Option<&ClientPresentationSnapshot>, ) -> Result<Option<Vec<u8>>>

Source

pub fn acknowledge_presentation( &mut self, snapshot: &ClientPresentationSnapshot, )

Source

fn reset_render_transaction(&mut self)

Source

pub fn apply_selection_input_logical( &mut self, input: SelectionInput, ) -> Result<()>

Source

pub(crate) fn apply_selection_input_at_logical( &mut self, input: SelectionInput, now: Instant, ) -> Result<()>

Source

pub fn mouse_request_for_event( &mut self, event: ClientMouseEvent, ) -> Option<ClientMouseEvent>

Source

pub fn copy_selection(&self) -> Result<()>

Source

pub fn copy_selection_inline(&self) -> Result<()>

Source

pub fn set_selection_edge_drag( &mut self, position: ClientMousePosition, forced_direction: Option<PaneScrollDirection>, ) -> Option<SelectionEdgeScrollRequest>

Source

pub fn set_selection_outside_edge_drag( &mut self, position: ClientMousePosition, ) -> Option<SelectionEdgeScrollRequest>

Source

fn refresh_edge_drag_selection_logical(&mut self) -> Result<()>

Source

pub fn selection_edge_scroll_request( &self, ) -> Option<SelectionEdgeScrollRequest>

Source

pub fn apply_scroll_pane_line_result( &mut self, position: ClientMousePosition, direction: PaneScrollDirection, movement: PaneScrollLineMove, )

Source

fn presentation_changes( &self, committed: Option<&ClientPresentationSnapshot>, logical: &ClientPresentationSnapshot, ) -> Result<Option<RenderFrameChanges>>

Source

pub const fn mouse_capture_state(&self) -> MouseCaptureState

Source

pub const fn selection_edge_drag(&self) -> SelectionEdgeDrag

Source

pub const fn mark_selection_edge_scroll_sent( &mut self, pending: SelectionEdgeScrollPending, )

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
§

impl<T> ArchivePointee for T

§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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.

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
§

impl<T> LayoutRaw for T

§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
§

impl<O> ObjectMarkerFor<Local> for O
where O: 'static,

§

fn run_creation_hooks(report: ReportMut<'_, Dynamic, Local>)

§

impl<O> ObjectMarkerFor<SendSync> for O
where O: 'static + Send + Sync,

§

fn run_creation_hooks(report: ReportMut<'_>)

§

impl<D> OwoColorize for D

§

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

Set the foreground color generically Read more
§

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

Set the background color generically. Read more
§

fn black(&self) -> FgColorDisplay<'_, Black, Self>

Change the foreground color to black
§

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

Change the background color to black
§

fn red(&self) -> FgColorDisplay<'_, Red, Self>

Change the foreground color to red
§

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

Change the background color to red
§

fn green(&self) -> FgColorDisplay<'_, Green, Self>

Change the foreground color to green
§

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

Change the background color to green
§

fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>

Change the foreground color to yellow
§

fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>

Change the background color to yellow
§

fn blue(&self) -> FgColorDisplay<'_, Blue, Self>

Change the foreground color to blue
§

fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>

Change the background color to blue
§

fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to magenta
§

fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to magenta
§

fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to purple
§

fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to purple
§

fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>

Change the foreground color to cyan
§

fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>

Change the background color to cyan
§

fn white(&self) -> FgColorDisplay<'_, White, Self>

Change the foreground color to white
§

fn on_white(&self) -> BgColorDisplay<'_, White, Self>

Change the background color to white
§

fn default_color(&self) -> FgColorDisplay<'_, Default, Self>

Change the foreground color to the terminal default
§

fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>

Change the background color to the terminal default
§

fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>

Change the foreground color to bright black
§

fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>

Change the background color to bright black
§

fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>

Change the foreground color to bright red
§

fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>

Change the background color to bright red
§

fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>

Change the foreground color to bright green
§

fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>

Change the background color to bright green
§

fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>

Change the foreground color to bright yellow
§

fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>

Change the background color to bright yellow
§

fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>

Change the foreground color to bright blue
§

fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>

Change the background color to bright blue
§

fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright magenta
§

fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright magenta
§

fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright purple
§

fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright purple
§

fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>

Change the foreground color to bright cyan
§

fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>

Change the background color to bright cyan
§

fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>

Change the foreground color to bright white
§

fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>

Change the background color to bright white
§

fn bold(&self) -> BoldDisplay<'_, Self>

Make the text bold
§

fn dimmed(&self) -> DimDisplay<'_, Self>

Make the text dim
§

fn italic(&self) -> ItalicDisplay<'_, Self>

Make the text italicized
§

fn underline(&self) -> UnderlineDisplay<'_, Self>

Make the text underlined
Make the text blink
Make the text blink (but fast!)
§

fn reversed(&self) -> ReversedDisplay<'_, Self>

Swap the foreground and background colors
§

fn hidden(&self) -> HiddenDisplay<'_, Self>

Hide the text
§

fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>

Cross out the text
§

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either [OwoColorize::fg] or a color-specific method, such as [OwoColorize::green], Read more
§

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either [OwoColorize::bg] or a color-specific method, such as [OwoColorize::on_yellow], Read more
§

fn fg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the foreground color to a specific RGB value.
§

fn bg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the background color to a specific RGB value.
§

fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>

Sets the foreground color to an RGB value.
§

fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>

Sets the background color to an RGB value.
§

fn style(&self, style: Style) -> Styled<&Self>

Apply a runtime-determined style
§

impl<T> Pointee for T

§

type Metadata = ()

The metadata type for pointers and references to this type.
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.