Enum xplr::app::ExternalMsg [−][src]
pub enum ExternalMsg {}Show variants
Explore, Refresh, ClearScreen, FocusNext, FocusNextByRelativeIndex(usize), FocusNextByRelativeIndexFromInput, FocusPrevious, FocusPreviousByRelativeIndex(usize), FocusPreviousByRelativeIndexFromInput, FocusFirst, FocusLast, FocusPath(String), FocusPathFromInput, FocusByIndex(usize), FocusByIndexFromInput, FocusByFileName(String), ChangeDirectory(String), Enter, Back, LastVisitedPath, NextVisitedPath, FollowSymlink, BufferInput(String), BufferInputFromKey, SetInputBuffer(String), RemoveInputBufferLastCharacter, RemoveInputBufferLastWord, ResetInputBuffer, SwitchMode(String), SwitchModeBuiltin(String), SwitchModeCustom(String), SwitchLayout(String), SwitchLayoutBuiltin(String), SwitchLayoutCustom(String), Call(Command), CallSilently(Command), BashExec(String), BashExecSilently(String), Select, SelectAll, SelectPath(String), UnSelect, UnSelectAll, UnSelectPath(String), ToggleSelection, ToggleSelectAll, ToggleSelectionByPath(String), ClearSelection, AddNodeFilter(NodeFilterApplicable), RemoveNodeFilter(NodeFilterApplicable), ToggleNodeFilter(NodeFilterApplicable), AddNodeFilterFromInput(NodeFilter), RemoveNodeFilterFromInput(NodeFilter), RemoveLastNodeFilter, ResetNodeFilters, ClearNodeFilters, AddNodeSorter(NodeSorterApplicable), RemoveNodeSorter(NodeSorter), ReverseNodeSorter(NodeSorter), ToggleNodeSorter(NodeSorterApplicable), ReverseNodeSorters, RemoveLastNodeSorter, ResetNodeSorters, ClearNodeSorters, LogInfo(String), LogSuccess(String), LogError(String), Quit, PrintResultAndQuit, PrintAppStateAndQuit, Debug(String), Terminate,
Variants
Explore the present working directory and register the filtered nodes.
This operation is expensive. So, try avoiding using it too often.
Once exploration is done, it will auto Refresh
the state.
Refresh the app state (uncluding UI).
But it will not re-explore the directory if the working directory is the same.
If there is some change in the working directory and you want to re-explore it,
use the Explore
message instead.
Clears the screen.
Focus next node.
FocusNextByRelativeIndex(usize)
Focus on the n
th node relative to the current focus where n
is a given value.
Example: FocusNextByRelativeIndex: 2
Focus on the n
th node relative to the current focus where n
is read from
the input buffer.
Focus on the previous item.
FocusPreviousByRelativeIndex(usize)
Focus on the -n
th node relative to the current focus where n
is a given value.
Example: FocusPreviousByRelativeIndex: 2
Focus on the -n
th node relative to the current focus where n
is read from
the input buffer.
Focus on the first node.
Focus on the last node.
FocusPath(String)
Focus on the given path.
Example: FocusPath: /tmp
Focus on the path read from input buffer.
FocusByIndex(usize)
Focus on the absolute n
th node where n
is a given value.
Example: FocusByIndex: 2
Focus on the absolute n
th node where n
is read from the input buffer.
FocusByFileName(String)
Focus on the file by name from the present working directory.
Example: FocusByFileName: README.md
ChangeDirectory(String)
Change the present working directory ($PWD)
Example: ChangeDirectory: /tmp
Enter into the currently focused path if it’s a directory.
Go back to the parent directory.
Go to the last path visited.
Go to the next path visited.
Follow the symlink under focus to its actual location.
BufferInput(String)
Append/buffer the given string into the input buffer.
Example: BufferInput: foo
Append/buffer the characted read from a keyboard input into the input buffer.
SetInputBuffer(String)
Set/rewrite the input buffer with the given string. When the input buffer is not-null (even if empty string) it will show in the UI.
Example: SetInputBuffer: foo
Remove input buffer’s last character.
Remove input buffer’s last word.
Reset the input buffer back to null. It will not show in the UI.
SwitchMode(String)
Switch input mode.
This will reset the input buffer and call Refresh
automatically.
NOTE: To be specific about which mode to switch to, use
SwitchModeBuiltin
orSwitchModeCustom
instead.
Example: SwitchMode: default
SwitchModeBuiltin(String)
Switch to a builtin mode.
This will reset the input buffer and call Refresh
automatically.
Example: SwitchModeBuiltin: default
SwitchModeCustom(String)
Switch to a custom mode.
This will reset the input buffer and call Refresh
automatically.
Example: SwitchModeCustom: my_custom_mode
SwitchLayout(String)
Switch layout.
This will call Refresh
automatically.
NOTE: To be specific about which layout to switch to, use
SwitchLayoutBuiltin
orSwitchLayoutCustom
instead.
Example: SwitchLayout: default
SwitchLayoutBuiltin(String)
Switch to a builtin layout.
This will call Refresh
automatically.
Example: SwitchLayoutBuiltin: default
SwitchLayoutCustom(String)
Switch to a custom layout.
This will call Refresh
automatically.
Example: SwitchLayoutCustom: my_custom_layout
Call(Command)
Call a shell command with the given arguments.
Note that the arguments will be shell-escaped.
So to read the variables, the -c
option of the shell
can be used.
You may need to pass Refresh
or Explore
depening on the expectation.
Example: Call: {command: bash, args: ["-c", "read -p test"]}
CallSilently(Command)
Like Call
but without the flicker. The stdin, stdout
stderr will be piped to null. So it’s non-interactive.
Example: CallSilently: {command: tput, args: ["bell"]}
BashExec(String)
An alias to Call: {command: bash, args: ["-c", "${command}"], silent: false}
where ${command} is the given value.
Example: BashExec: "read -p test"
BashExecSilently(String)
Like BashExec
but without the flicker. The stdin, stdout
stderr will be piped to null. So it’s non-interactive.
Example: BashExecSilently: "tput bell"
Select the focused node.
Select all the visible nodes.
SelectPath(String)
Select the given path.
Example: SelectPath: "/tmp"
Unselect the focused node.
Unselect all the visible nodes.
UnSelectPath(String)
UnSelect the given path.
Example: UnSelectPath: "/tmp"
Toggle selection on the focused node.
Toggle between select all and unselect all.
ToggleSelectionByPath(String)
Toggle selection by file path.
Example: ToggleSelectionByPath: "/tmp"
Clear the selection.
AddNodeFilter(NodeFilterApplicable)
Add a filter to exclude nodes while exploring directories.
Example: AddNodeFilter: {filter: RelativePathDoesStartWith, input: foo}
RemoveNodeFilter(NodeFilterApplicable)
Remove an existing filter.
Example: RemoveNodeFilter: {filter: RelativePathDoesStartWith, input: foo}
ToggleNodeFilter(NodeFilterApplicable)
Remove a filter if it exists, else, add a it.
Example: ToggleNodeFilter: {filter: RelativePathDoesStartWith, input: foo}
AddNodeFilterFromInput(NodeFilter)
Add a node filter reading the input from the buffer.
Example: AddNodeFilterFromInput: RelativePathDoesStartWith
RemoveNodeFilterFromInput(NodeFilter)
Remove a node filter reading the input from the buffer.
Example: RemoveNodeFilterFromInput: RelativePathDoesStartWith
Remove the last node filter.
Reset the node filters back to the default configuration.
Clear all the node filters.
AddNodeSorter(NodeSorterApplicable)
Add a sorter to sort nodes while exploring directories.
Example: AddNodeSorter: {sorter: ByRelativePath, reverse: false}
RemoveNodeSorter(NodeSorter)
Remove an existing sorter.
Example: RemoveNodeSorter: ByRelativePath
ReverseNodeSorter(NodeSorter)
Reverse a node sorter.
Example: ReverseNodeSorter: ByRelativePath
ToggleNodeSorter(NodeSorterApplicable)
Remove a sorter if it exists, else, add a it.
Example: ToggleSorterSorter: {sorter: ByRelativePath, reverse: false}
Reverse the node sorters.
Remove the last node sorter.
Reset the node sorters back to the default configuration.
Clear all the node sorters.
LogInfo(String)
Log information message.
Example: LogInfo: launching satellite
LogSuccess(String)
Log a success message.
Example: LogSuccess: satellite reached destination
.
LogError(String)
Log an error message.
Example: LogError: satellite crashed
Quit with returncode zero (success).
Print selected paths if it’s not empty, else, print the focused node’s path.
Print the state of application in YAML format. Helpful for debugging or generating the default configuration file.
Debug(String)
Write the application state to a file, without quitting. Also helpful for debugging.
Terminate the application with a non-zero return code.
Implementations
impl ExternalMsg
[src]
impl ExternalMsg
[src]pub fn is_read_only(&self) -> bool
[src]
Trait Implementations
impl Clone for ExternalMsg
[src]
impl Clone for ExternalMsg
[src]fn clone(&self) -> ExternalMsg
[src]
fn clone(&self) -> ExternalMsg
[src]Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]Performs copy-assignment from source
. Read more
impl Debug for ExternalMsg
[src]
impl Debug for ExternalMsg
[src]impl<'de> Deserialize<'de> for ExternalMsg
[src]
impl<'de> Deserialize<'de> for ExternalMsg
[src]fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]Deserialize this value from the given Serde deserializer. Read more
impl PartialEq<ExternalMsg> for ExternalMsg
[src]
impl PartialEq<ExternalMsg> for ExternalMsg
[src]fn eq(&self, other: &ExternalMsg) -> bool
[src]
fn eq(&self, other: &ExternalMsg) -> bool
[src]This method tests for self
and other
values to be equal, and is used
by ==
. Read more
fn ne(&self, other: &ExternalMsg) -> bool
[src]
fn ne(&self, other: &ExternalMsg) -> bool
[src]This method tests for !=
.
impl Serialize for ExternalMsg
[src]
impl Serialize for ExternalMsg
[src]impl Eq for ExternalMsg
[src]
impl StructuralEq for ExternalMsg
[src]
impl StructuralPartialEq for ExternalMsg
[src]
Auto Trait Implementations
impl RefUnwindSafe for ExternalMsg
impl Send for ExternalMsg
impl Sync for ExternalMsg
impl Unpin for ExternalMsg
impl UnwindSafe for ExternalMsg
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<Q, K> Equivalent<K> for Q where
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,
[src]
impl<Q, K> Equivalent<K> for Q where
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,
[src]pub fn equivalent(&self, key: &K) -> bool
[src]
pub fn equivalent(&self, key: &K) -> bool
[src]Compare self to key
and return true
if they are equal.
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,