Skip to main content

StatsView

Struct StatsView 

Source
pub struct StatsView<V: 'static + ViewBridge> {
    pub state: Rc<RefCell<V::StateType>>,
    pub reverse_sort: bool,
    pub event_controllers: Rc<RefCell<HashMap<Event, Controllers>>>,
    /* private fields */
}
Expand description

StatsView is a view wrapper that wraps tabs, titles, and list of stats.

Terminology: title: A title here means a column name in the stats table. We call it title to align with below_derive’s function get_title_line. tab or topic: A tab or topic is the content of “Tabs” defined in the module level description. For example, “general”, “cpu”, “pressure”, etc.

The tab_titles_map defines a hashmap between a tab name and a vector of its corresponding string titles. This will help StatsView to switch stats headline(columns name) when a user switching tabs. This hashmap will be automatically generated by tab_view_map.

tab_view_map defines a map relationship between a tab name and its concrete V data structure. The V here represents “view” which, in implementation, is a enum of “tab” data structure. And each “tab” defines stats data and will derive the BelowDecor to generate all display functions. Please check the implementation of V for more details.

detailed_view here is our cursive object. I wrapped it with OnEventView in order to let the concrete “view“s to define their customized handler. You can think the detailed_view will be something like this

OnEventView –> Panel –> LinearLayout::Vertical –> Child 0: A TabView that represent the topic tab –> child 1: ScrollView –> LinearLayout::Vertical –> child 0: A TabView that represent the title header tab –> child 1: A SelectView that represents the detail stats –> child 2: Command palette

state defines the state of a view. Filters, sorting orders will be defined here.

Fields§

§state: Rc<RefCell<V::StateType>>§reverse_sort: bool§event_controllers: Rc<RefCell<HashMap<Event, Controllers>>>

Implementations§

Source§

impl<V: 'static + ViewBridge> StatsView<V>

Source

pub fn new( name: &'static str, tabs: Vec<String>, tab_view_map: HashMap<String, V>, select_view: SelectView<<V::StateType as StateCommon>::KeyType>, state: V::StateType, event_controllers: Rc<RefCell<HashMap<Event, Controllers>>>, cmd_controllers: Rc<RefCell<HashMap<&'static str, Controllers>>>, ) -> Self

Source

pub fn update_title(&mut self)

Source

pub fn on_event<F, E>(self, trigger: E, cb: F) -> Self
where E: Into<EventTrigger>, F: 'static + Fn(&mut Cursive),

Source

pub fn get_tab_view(&mut self) -> ViewRef<TabView>

Source

pub fn get_title_view(&mut self) -> ViewRef<TabView>

Source

pub fn get_list_scroll_view( &mut self, ) -> &mut ScrollView<NamedView<SelectView<<V::StateType as StateCommon>::KeyType>>>

Source

pub fn get_detail_view( &mut self, ) -> ViewRef<SelectView<<V::StateType as StateCommon>::KeyType>>

Source

pub fn get_cmd_palette(&mut self) -> ViewRef<CommandPalette>

Source

pub fn get_screen_width(&mut self) -> usize

Source

pub fn set_horizontal_offset(&mut self, x: usize)

Source

pub fn refresh(&mut self, c: &mut Cursive)

Source

pub fn feed_data(self, c: &mut Cursive) -> Self

Source

pub fn get_view(c: &mut Cursive) -> ViewRef<Self>

Convenience function to get StatsView

Source

pub fn refresh_myself(c: &mut Cursive)

Source

pub fn set_alert(&mut self, msg: &str)

Source

pub fn cp_warn(c: &mut Cursive, msg: &str)

Convenience function to raise warning. Only to CommandPalette.

Source

pub fn cp_filter(c: &mut Cursive, filter_info: Option<(String, String)>)

Convenience function to set filter to CommandPalette. filter_info provides the column title (for the filtered field) and filter

Trait Implementations§

Source§

impl<V: 'static + ViewBridge> ViewWrapper for StatsView<V>

Source§

type V = OnEventView<Panel<LinearLayout>>

Type that this view wraps.
Source§

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

Runs a function on the inner view, returning the result. Read more
Source§

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

Runs a function on the inner view, returning the result. Read more
Source§

fn into_inner(self) -> Result<Self::V, Self>
where Self::V: Sized,

Attempts to retrieve the inner view.
Source§

fn wrap_on_event(&mut self, ch: Event) -> EventResult

Wraps the on_event method.
Source§

fn wrap_draw(&self, printer: &Printer<'_, '_>)

Wraps the draw method.
Source§

fn wrap_required_size(&mut self, req: XY<usize>) -> XY<usize>

Wraps the required_size method.
Source§

fn wrap_layout(&mut self, size: XY<usize>)

Wraps the layout method.
Source§

fn wrap_take_focus( &mut self, source: Direction, ) -> Result<EventResult, CannotFocus>

Wraps the take_focus method.
Source§

fn wrap_call_on_any( &mut self, selector: &Selector<'_>, callback: &mut dyn FnMut(&mut (dyn View + 'static)), )

Wraps the find method.
Source§

fn wrap_focus_view( &mut self, selector: &Selector<'_>, ) -> Result<EventResult, ViewNotFound>

Wraps the focus_view method.
Source§

fn wrap_needs_relayout(&self) -> bool

Wraps the needs_relayout method.
Source§

fn wrap_important_area(&self, size: XY<usize>) -> Rect

Wraps the important_area method.

Auto Trait Implementations§

§

impl<V> !RefUnwindSafe for StatsView<V>

§

impl<V> !Send for StatsView<V>

§

impl<V> !Sync for StatsView<V>

§

impl<V> !UnwindSafe for StatsView<V>

§

impl<V> Freeze for StatsView<V>

§

impl<V> Unpin for StatsView<V>
where V: Unpin,

§

impl<V> UnsafeUnpin for StatsView<V>

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> AnyView for T
where T: View,

Source§

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

Downcast self to a Any.

Source§

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

Downcast self to a mutable Any.

Source§

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

Returns a boxed any from a boxed self. 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

Source§

impl<T> Erased for T

Source§

impl<T> Finder for T
where T: View,

Source§

fn call_on_all<V, F>(&mut self, sel: &Selector<'_>, callback: F)
where V: View, F: FnMut(&mut V),

Runs a callback on all views identified by sel. Read more
Source§

fn call_on<V, F, R>(&mut self, sel: &Selector<'_>, callback: F) -> Option<R>
where V: View, F: FnOnce(&mut V) -> R,

Runs a callback on the view identified by sel. Read more
Source§

fn call_on_name<V, F, R>(&mut self, name: &str, callback: F) -> Option<R>
where V: View, F: FnOnce(&mut V) -> R,

Convenient method to use call_on with a view::Selector::Name.
Source§

fn find_name<V>( &mut self, name: &str, ) -> Option<OwningHandle<OwningRef<Rc<RefCell<V>>, RefCell<V>>, RefMut<'static, V>>>
where V: View,

Convenient method to find a view wrapped in an NamedView.
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> IntoBoxedView for T
where T: View,

Source§

fn into_boxed_view(self) -> Box<dyn View>

Returns a Box<View>.
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
Source§

impl<T> Nameable for T
where T: View,

Source§

fn with_name<S>(self, name: S) -> NamedView<Self>
where S: Into<String>,

Wraps this view into an NamedView with the given id. Read more
Source§

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

Source§

impl<T> Resizable for T
where T: View,

Source§

fn resized( self, width: SizeConstraint, height: SizeConstraint, ) -> ResizedView<Self>

Wraps self in a ResizedView with the given size constraints.
Source§

fn fixed_size<S>(self, size: S) -> ResizedView<Self>
where S: Into<XY<usize>>,

Wraps self into a fixed-size ResizedView.
Source§

fn fixed_width(self, width: usize) -> ResizedView<Self>

Wraps self into a fixed-width ResizedView.
Source§

fn fixed_height(self, height: usize) -> ResizedView<Self>

Wraps self into a fixed-width ResizedView.
Source§

fn full_screen(self) -> ResizedView<Self>

Wraps self into a full-screen ResizedView.
Source§

fn full_width(self) -> ResizedView<Self>

Wraps self into a full-width ResizedView.
Source§

fn full_height(self) -> ResizedView<Self>

Wraps self into a full-height ResizedView.
Source§

fn max_size<S>(self, size: S) -> ResizedView<Self>
where S: Into<XY<usize>>,

Wraps self into a limited-size ResizedView.
Source§

fn max_width(self, max_width: usize) -> ResizedView<Self>

Wraps self into a limited-width ResizedView.
Source§

fn max_height(self, max_height: usize) -> ResizedView<Self>

Wraps self into a limited-height ResizedView.
Source§

fn min_size<S>(self, size: S) -> ResizedView<Self>
where S: Into<XY<usize>>,

Wraps self into a ResizedView at least sized size.
Source§

fn min_width(self, min_width: usize) -> ResizedView<Self>

Wraps self in a ResizedView at least min_width wide.
Source§

fn min_height(self, min_height: usize) -> ResizedView<Self>

Wraps self in a ResizedView at least min_height tall.
Source§

impl<T> Scrollable for T
where T: View,

Source§

fn scrollable(self) -> ScrollView<Self>

Wraps self in a ScrollView.
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> View for T
where T: ViewWrapper,

Source§

fn draw(&self, printer: &Printer<'_, '_>)

Draws the view with the given printer (includes bounds) and focus. Read more
Source§

fn required_size(&mut self, req: XY<usize>) -> XY<usize>

Returns the minimum size the view requires with the given restrictions. Read more
Source§

fn on_event(&mut self, ch: Event) -> EventResult

Called when an event is received (key press, mouse event, …). Read more
Source§

fn layout(&mut self, size: XY<usize>)

Called once the size for this view has been decided. Read more
Source§

fn take_focus(&mut self, source: Direction) -> Result<EventResult, CannotFocus>

Attempt to give this view the focus. Read more
Source§

fn call_on_any( &mut self, selector: &Selector<'_>, callback: &mut dyn FnMut(&mut (dyn View + 'static)), )

Runs a closure on the view identified by the given selector. Read more
Source§

fn needs_relayout(&self) -> bool

Should return true if the view content changed since the last call to layout(). Read more
Source§

fn focus_view( &mut self, selector: &Selector<'_>, ) -> Result<EventResult, ViewNotFound>

Moves the focus to the view identified by the given selector. Read more
Source§

fn important_area(&self, size: XY<usize>) -> Rect

What part of the view is important and should be visible? Read more
Source§

fn type_name(&self) -> &'static str

Returns the type of this view. Read more
Source§

impl<T> With for T

Source§

fn wrap_with<U, F>(self, f: F) -> U
where F: FnOnce(Self) -> U,

Calls the given closure and return the result. Read more
Source§

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

Calls the given closure on self.
Source§

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

Calls the given closure on self.
Source§

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

Calls the given closure if condition == true.