Struct PaneRegionSnapshot 

pub struct PaneRegionSnapshot {
    id: PaneId,
    col: u16,
    row: u16,
    cols: u16,
    mouse_mode: PaneMouseMode,
    rows: u16,
    visible_top_row: u64,
    wrapped_rows: Vec<RowWrap>,
}

Fields

id: PaneId

col: u16

row: u16

cols: u16

mouse_mode: PaneMouseMode

rows: u16

visible_top_row: u64

wrapped_rows: Vec<RowWrap>

Implementations

impl PaneRegionSnapshot

pub fn new( id: PaneId, col: u16, row: u16, cols: u16, rows: u16, mouse_mode: PaneMouseMode, visible_top_row: u64, ) -> Result<Self>

Build a visible pane region for the current rendered frame.

Errors

• The region has zero columns or rows.
• The region row or column range overflows.

pub fn with_wrapped_rows(self, wrapped_rows: Vec<RowWrap>) -> Result<Self>

Attach per-visible-row soft-wrap metadata from the pane terminal.

Errors

• The number of row flags does not match the region height.

pub const fn col(&self) -> u16

pub const fn cols(&self) -> u16

pub const fn id(&self) -> &PaneId

pub const fn mouse_mode(&self) -> PaneMouseMode

Return the pane application’s current terminal mouse tracking mode.

pub const fn row(&self) -> u16

pub const fn rows(&self) -> u16

pub const fn visible_top_row(&self) -> u64

Return the stable content row rendered at the top of this pane’s visible viewport.

pub fn content_row_wrap(&self, content_row: u64) -> RowWrap

Return the soft-wrap metadata for a stable content row in this rendered viewport.

pub const fn containment(&self, row: u16, col: u16) -> PaneRegionContainment

fn validate(&self) -> Result<()>

Trait Implementations

impl Archive for PaneRegionSnapshot

where PaneId: Archive, u16: Archive, PaneMouseMode: Archive, u64: Archive, Vec<RowWrap>: Archive,

const COPY_OPTIMIZATION: CopyOptimization<Self>

An optimization flag that allows the bytes of this type to be copied directly to a writer instead of calling serialize.

type Archived = ArchivedPaneRegionSnapshot

The archived representation of this type.

type Resolver = PaneRegionSnapshotResolver

The resolver for this type. It must contain all the additional information from serializing needed to make the archived type from the normal type.

fn resolve(&self, resolver: Self::Resolver, out: Place<Self::Archived>)

Creates the archived version of this value at the given position and writes it to the given output.

impl Clone for PaneRegionSnapshot

fn clone(&self) -> PaneRegionSnapshot

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PaneRegionSnapshot

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

Formats the value using the given formatter.

impl<D> Deserialize<PaneRegionSnapshot, D> for ArchivedPaneRegionSnapshot

where D: Fallible + ?Sized, D::Error: Source,

fn deserialize( &self, deserializer: &mut D, ) -> Result<PaneRegionSnapshot, D::Error>

Deserializes using the given deserializer

impl Eq for PaneRegionSnapshot

impl PartialEq for PaneRegionSnapshot

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for PaneRegionSnapshot

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<__S: Fallible + ?Sized> Serialize<__S> for PaneRegionSnapshot

where PaneId: Serialize<__S>, u16: Serialize<__S>, PaneMouseMode: Serialize<__S>, u64: Serialize<__S>, Vec<RowWrap>: Serialize<__S>,

fn serialize( &self, serializer: &mut __S, ) -> Result<<Self as Archive>::Resolver, <__S as Fallible>::Error>

Writes the dependencies for the object and returns a resolver that can create the archived type.

impl StructuralPartialEq for PaneRegionSnapshot