Skip to main content

Action

Enum Action 

Source
pub enum Action {
Show 36 variants ToggleFocus, Open, Close, Down, Up, NextGroup, PrevGroup, HalfPageDown, HalfPageUp, Top, Bottom, NextHunk, PrevHunk, ToggleSplit, ToggleWrap, ShiftRight, ShiftLeft, ShiftReset, GrowDiff, ShrinkDiff, Fold, Files, ExternalEditor, Findings, Search, ToggleReviewed, Select, Comment, Delete, ClearNotes, Copy, Reply, Resolve, Refetch, Publish, Back,
}
Expand description

Something the terminal reviewer does on a key, by name (ADR 0036).

A name rather than a key, because a key is the reader’s to choose and the thing it does is not. [keys] maps these to key strings; the renderer owns what a key string means and what the defaults are, so this crate never learns a terminal’s vocabulary. One name means one thing wherever it works: down moves in the plan pane, the file list and the findings list alike, so a reader binds it once.

Adding an action is adding a variant here, its name in Action::key, and its default keys and its arm in the renderer.

Variants§

§

ToggleFocus

§

Open

§

Close

§

Down

§

Up

§

NextGroup

§

PrevGroup

§

HalfPageDown

§

HalfPageUp

§

Top

§

Bottom

§

NextHunk

§

PrevHunk

§

ToggleSplit

§

ToggleWrap

§

ShiftRight

§

ShiftLeft

§

ShiftReset

§

GrowDiff

§

ShrinkDiff

§

Fold

§

Files

§

ExternalEditor

Hand the terminal to the reader’s own editor, on the line under the cursor. The command it runs is [review].editor (ADR 0038); this is only the key that asks for it.

§

Findings

§

Search

§

ToggleReviewed

§

Select

§

Comment

§

Delete

§

ClearNotes

§

Copy

§

Reply

§

Resolve

§

Refetch

§

Publish

§

Back

Implementations§

Source§

impl Action

Source

pub const ALL: &'static [Action] = <Action as strum::VariantArray>::VARIANTS

Every variant, in declaration order, from strum’s VariantArray: the derive is what keeps the list whole, so there is no hand-kept array to forget a variant in.

Source

pub fn key(self) -> &'static str

The name this answers to in the config file. strum’s IntoStaticStr, renamed as serde renames it; every_*_name_round_trips in this module pins the two derives to the same spelling.

Trait Implementations§

Source§

impl Clone for Action

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Action

Source§

impl Debug for Action

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Action

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for Action

Source§

impl<'_derivative_strum> From<&'_derivative_strum Action> for &'static str

Source§

fn from(x: &'_derivative_strum Action) -> &'static str

Converts to this type from the input type.
Source§

impl From<Action> for &'static str

Source§

fn from(x: Action) -> &'static str

Converts to this type from the input type.
Source§

impl Hash for Action

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for Action

Source§

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

fn clamp_to<R>(self, range: R) -> Self
where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)
Restrict a value to a certain range. Read more
Source§

impl PartialEq for Action

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl PartialOrd for Action

Source§

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl Serialize for Action

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Action

Source§

impl VariantArray for Action

Source§

const VARIANTS: &'static [Self]

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. 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<N> NodeTrait for N
where N: Copy + Ord + Hash,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.