Skip to main content

App

Struct App 

Source
pub struct App {
    pub config: Config,
    pub search_fields: SearchFields,
    pub searcher: Option<Searcher>,
    pub input_source: InputSource,
    pub run_config: AppRunConfig,
    pub event_channels: EventChannels,
    pub ui_state: UIState,
    /* private fields */
}

Fields§

§config: Config§search_fields: SearchFields§searcher: Option<Searcher>§input_source: InputSource§run_config: AppRunConfig§event_channels: EventChannels§ui_state: UIState

Implementations§

Source§

impl<'a> App

Source

pub fn new( input_source: InputSource, search_field_values: &SearchFieldValues<'a>, app_run_config: AppRunConfig, config: Config, ) -> Result<Self>

Source

pub fn set_file_content_provider( &mut self, provider: Arc<dyn FileContentProvider>, )

Source

pub fn handle_internal_event( &mut self, event: InternalEvent, ) -> EventHandlingResult

Source

pub fn cancel_in_progress_tasks(&mut self)

Source

pub fn reset(&mut self)

Source

pub async fn event_recv(&mut self) -> Event

Source

pub fn background_processing_reciever( &mut self, ) -> Option<&mut UnboundedReceiver<BackgroundProcessingEvent>>

Source

pub fn perform_search_background(&mut self)

Called when searching in the background e.g. when entering chars into the search field: does not show error popup if there are validation errors

Source

pub fn perform_replacement(&mut self)

Source

pub fn handle_background_processing_event( &mut self, event: BackgroundProcessingEvent, ) -> EventHandlingResult

Source

pub fn handle_key_event(&mut self, key_event: KeyEvent) -> EventHandlingResult

Source

pub fn current_search_key(&self) -> SearchKey

Source

pub fn validate_fields(&mut self) -> Result<Option<Searcher>>

Source

pub fn show_popup(&self) -> bool

Source

pub fn popup(&self) -> Option<&Popup>

Source

pub fn errors(&self) -> Vec<AppError>

Source

pub fn add_error(&mut self, error: AppError)

Source

pub fn toast_message(&self) -> Option<&str>

Source

pub fn keymaps_all(&self) -> Vec<(String, String)>

Source

pub fn keymaps_compact(&self) -> Vec<(String, String)>

Source

pub fn search_has_completed(&self) -> bool

Source

pub fn is_preview_updated(&self) -> bool

Trait Implementations§

Source§

impl Debug for App

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl !RefUnwindSafe for App

§

impl !UnwindSafe for App

§

impl Freeze for App

§

impl Send for App

§

impl Sync for App

§

impl Unpin for App

§

impl UnsafeUnpin for App

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> 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
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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.