Struct RwArea 

pub struct RwArea(/* private fields */);

A type erased RawArea

This type houses the inner Area, and provides type erased access to its functions.

Implementations

impl RwArea

pub fn read<'a>(&'a self, pa: &'a Pass) -> &'a Area

Shared access to an Area

You should use this if you want “prolonged” access to the Area’s methods, without necessarily bringing a Pass with you.

pub fn read_as<'a, A>(&'a self, pa: &'a Pass) -> Option<&'a A>

where A: RawArea,

Attempt to read this as a specific implementation of RawArea

You can use this to deal with individual RawAreas, so you can do a “per Ui” configuration for your Plugin/configuration.

This will return None if the RawArea within is of a different type.

pub fn write<'a>(&'a self, pa: &'a mut Pass) -> &'a mut Area

Mutable access to an Area

You should use this if you want “prolonged” access to the Area’s methods, without necessarily bringing a Pass with you.

pub fn write_as<'a, A>(&'a self, pa: &'a mut Pass) -> Option<&'a mut A>

where A: RawArea,

Attempt to write this as a specific implementation of RawArea

You can use this to deal with individual RawAreas, so you can do a “per Ui” configuration for your Plugin/configuration. This could be used to, for example, place frames around an Area when making use of a terminal Ui, or using some custom css when using a web Ui.

This will return None if the RawArea within is of a different type.

pub fn set_width(&self, pa: &mut Pass, width: f32) -> Result<(), Text>

Sets the width of the RawArea

pub fn set_height(&self, pa: &mut Pass, height: f32) -> Result<(), Text>

Sets the height of the RawArea

pub fn hide(&self, pa: &mut Pass) -> Result<(), Text>

Hides the RawArea

pub fn reveal(&self, pa: &mut Pass) -> Result<(), Text>

Reveals the RawArea

pub fn set_as_active(&self, pa: &mut Pass)

Tells the RawUi that this RawArea is the one that is currently focused.

Should make self the active RawArea while deactivating any other active RawArea.

pub fn size_of_text( &self, pa: &Pass, opts: PrintOpts, text: &Text, ) -> Result<Coord, Text>

What size the given Text would occupy, if unwrapped

The x component represents the width needed to show the Text without wrapping, while the y component represents the height needed to show all the lines of the Text.

This function does take into account the size of the screen, and assumes that you will want to iterate from the start of the Text. Therefore, it will preemptively stop iterating through the Text when the remaining characters wouldn’t show up on screen.

pub fn get_print_info(&self, pa: &Pass) -> PrintInfo

The current printing information of the area

pub fn set_print_info(&self, pa: &mut Pass, info: PrintInfo)

Sets a previously acquired PrintInfo to the area

pub fn scroll_ver(&self, pa: &mut Pass, text: &Text, dist: i32, opts: PrintOpts)

Scrolls the Text veritcally by an amount

If scroll_beyond is set, then the Text will be allowed to scroll beyond the last line, up until reaching the scrolloff.y value.

pub fn scroll_around_points( &self, pa: &mut Pass, text: &Text, points: TwoPoints, opts: PrintOpts, )

Scrolls the Text on all four directions until the given TwoPoints is within the ScrollOff range

There are two other scrolling methods for Area: scroll_ver and scroll_to_points. The difference between this and scroll_to_points is that this method doesn’t do anything if the TwoPoints is already on screen.

pub fn scroll_to_points( &self, pa: &mut Pass, text: &Text, points: TwoPoints, opts: PrintOpts, )

Scrolls the Text to the visual line of a TwoPoints

This method takes line wrapping into account, so it’s not the same as setting the starting points to the Text::visual_line_start of these TwoPoints.

If scroll_beyond is set, then the Text will be allowed to scroll beyond the last line, up until reaching the scrolloff.y value.

pub fn start_points(&self, pa: &Pass, text: &Text, opts: PrintOpts) -> TwoPoints

Scrolls the Area to the given TwoPoints

pub fn end_points(&self, pa: &Pass, text: &Text, opts: PrintOpts) -> TwoPoints

Scrolls the Area to the given TwoPoints

pub fn has_changed(&self, pa: &Pass) -> bool

Wether this Area has changed since last being printed

This includes changes to the area’s size, location, and PrintInfo, as well as other ui implementation specific information.

pub fn is_master_of(&self, pa: &Pass, other: &RwArea) -> bool

Whether or not this Area is the “master” of another

pub fn store_cache(&self, pa: &Pass, path: impl AsRef<Path>) -> Result<(), Text>

Stores the cache of the Area, given a path to associate with this cache

pub fn top_left(&self, pa: &Pass) -> Coord

The top left Coord of this Area

pub fn bottom_right(&self, pa: &Pass) -> Coord

The bottom right Coord of this Area

pub fn width(&self, pa: &Pass) -> f32

Gets the width of the area

pub fn height(&self, pa: &Pass) -> f32

Gets the height of the area

pub fn points_at_coord( &self, pa: &Pass, text: &Text, coord: Coord, opts: PrintOpts, ) -> Option<TwoPointsPlace>

The TwoPoints where a Coord is found

Returns None if either the RawArea does not contain the given Coord, or if the Coord is in a position where Text is not printed.

pub fn coord_at_points( &self, pa: &Pass, text: &Text, points: TwoPoints, opts: PrintOpts, ) -> Option<Coord>

The Coord where the given TwoPoints would be printed

Returns None if the TwoPoints are not part of the Text

pub fn columns_at( &self, pa: &Pass, text: &Text, points: TwoPoints, opts: PrintOpts, ) -> Option<Columns>

Returns column information about a TwoPoints.

If the points are part of the Strs, returns a Columns struct. This contains the line column and the wrapped column.

The former measures the distance since the last \n character or start of Text. The latter measures the distance since the last wrap, i.e., the distance to the left edge of the area.

pub fn is_active(&self, pa: &Pass) -> bool

Returns true if this is the currently active Area

Only one Area should be active at any given moment.

pub fn is_eq(&self, pa: &Pass, other: &RwArea) -> bool

Wether this Area is the same as another

Trait Implementations

impl Clone for RwArea

fn clone(&self) -> RwArea

Returns a duplicate of the value.

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

Performs copy-assignment from source.