Struct gpg_tui::term::tui::Tui[−][src]

pub struct Tui<B: Backend> {
    pub events: EventHandler,
    pub paused: bool,
    // some fields omitted
}

Expand description

Text-based user interface.

Tui is responsible for setting up the terminal and initializing the interface. Terminal event handler can be accessed via events field.

Fields

events: EventHandler

Terminal event handler.

paused: bool

Is the interface paused?

Implementations

[src]

impl<B: Backend> Tui

[src]

pub fn new(terminal: Terminal, events: EventHandler) -> Self

Constructs a new instance of Tui.

[src]

pub fn init(&mut self) -> Result<()>

Initializes the terminal interface.

It enables the raw mode and sets terminal properties.

[src]

pub fn toggle_pause(&mut self) -> Result<()>

Toggles the paused state of interface.

It disables the key input and exits the terminal interface on pause (and vice-versa).

[src]

pub fn enable_mouse_capture(&mut self) -> Result<()>

Enables the mouse capture.

[src]

pub fn disable_mouse_capture(&mut self) -> Result<()>

Disables the mouse capture.

[src]

pub fn draw(&mut self, app: &mut App<'_>) -> Result<()>

Draw the terminal interface by rendering the widgets.

[src]

pub fn exit(&mut self) -> Result<()>

Exits the terminal interface.

It disables the raw mode and reverts back the terminal properties.

Trait Implementations

[src]

impl<B: Debug + Backend> Debug for Tui

[src]

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl !RefUnwindSafe for Tui

impl<B> Send for Tui<B> where
    B: Send,

impl !Sync for Tui

impl<B> Unpin for Tui<B> where
    B: Unpin,

impl !UnwindSafe for Tui

Blanket Implementations

[src]

impl<T> Any for T where
    T: 'static + ?Sized,

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<Src, Scheme> ApproxFrom<Src, Scheme> for Src where
    Scheme: ApproxScheme,

type Err = NoError

The error type produced by a failed conversion.

pub fn approx_from(
    src: Src
) -> Result<Src, <Src as ApproxFrom<Src, Scheme>>::Err>

Convert the given value into an approximately equivalent representation.

impl<Dst, Src, Scheme> ApproxInto<Dst, Scheme> for Src where
    Dst: ApproxFrom<Src, Scheme>,
    Scheme: ApproxScheme,

type Err = <Dst as ApproxFrom<Src, Scheme>>::Err

The error type produced by a failed conversion.

pub fn approx_into(self) -> Result<Dst, <Src as ApproxInto<Dst, Scheme>>::Err>

Convert the subject into an approximately equivalent representation.

[src]

impl<T> Borrow<T> for T where
    T: ?Sized,

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized,

[src]

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T, Dst> ConvAsUtil<Dst> for T

fn approx(self) -> Result<Dst, Self::Err> where
    Self: ApproxInto<Dst, DefaultApprox>,

Approximate the subject with the default scheme.

fn approx_by<Scheme>(self) -> Result<Dst, Self::Err> where
    Self: ApproxInto<Dst, Scheme>,
    Scheme: ApproxScheme,

Approximate the subject with a specific scheme.

impl<T> ConvUtil for T

fn approx_as<Dst>(self) -> Result<Dst, Self::Err> where
    Self: ApproxInto<Dst, DefaultApprox>,

Approximate the subject to a given type with the default scheme.

fn approx_as_by<Dst, Scheme>(self) -> Result<Dst, Self::Err> where
    Self: ApproxInto<Dst, Scheme>,
    Scheme: ApproxScheme,

Approximate the subject to a given type with a specific scheme.

fn into_as<Dst>(self) -> Dst where
    Self: Into<Dst>,

Convert the subject to a given type.

fn try_as<Dst>(self) -> Result<Dst, Self::Err> where
    Self: TryInto<Dst>,

Attempt to convert the subject to a given type.

fn value_as<Dst>(self) -> Result<Dst, Self::Err> where
    Self: ValueInto<Dst>,

Attempt a value conversion of the subject to a given type.

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

impl<T, U> Into<U> for T where
    U: From<T>,

[src]

pub fn into(self) -> U

Performs the conversion.

impl<Src> TryFrom<Src> for Src

type Err = NoError

The error type produced by a failed conversion.

pub fn try_from(src: Src) -> Result<Src, <Src as TryFrom<Src>>::Err>

Convert the given value into the subject type.

[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

[src]

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<Src, Dst> TryInto<Dst> for Src where
    Dst: TryFrom<Src>,

type Err = <Dst as TryFrom<Src>>::Err

The error type produced by a failed conversion.

pub fn try_into(self) -> Result<Dst, <Src as TryInto<Dst>>::Err>

Convert the subject into the destination type.

[src]

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

[src]

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<Src> ValueFrom<Src> for Src

type Err = NoError

The error type produced by a failed conversion.

pub fn value_from(src: Src) -> Result<Src, <Src as ValueFrom<Src>>::Err>

Convert the given value into an exactly equivalent representation.

impl<Src, Dst> ValueInto<Dst> for Src where
    Dst: ValueFrom<Src>,

type Err = <Dst as ValueFrom<Src>>::Err

The error type produced by a failed conversion.

pub fn value_into(self) -> Result<Dst, <Src as ValueInto<Dst>>::Err>

Convert the subject into an exactly equivalent representation.