Function: transient-infix-read

transient-infix-read is a byte-compiled function defined in transient.el.

Signature

(transient-infix-read OBJ)

Documentation

Determine the new value of the infix object OBJ.

This function merely determines the value; transient-infix-set is used to actually store the new value in the object.

For most infix classes this is done by reading a value from the user using the reader specified by the reader slot (using the method for transient-infix(var)/transient-infix(fun), described below).

For some infix classes the value is changed without reading anything in the minibuffer, i.e., the mere act of invoking the infix command determines what the new value should be, based on the previous value.

Implementations

((obj magit--git-branch:upstream)) in `magit-branch.el'.

Undocumented

((obj magit--git-variable:choices)) in `magit-transient.el'.

Undocumented

:around ((obj magit--git-variable:urls)) in `magit-transient.el'.

Undocumented

((command symbol)) in `transient.el'.

Elsewhere use the reader of the infix command COMMAND. Use this if you want to share an infix's history with a regular stand-alone command.

((obj transient-switches)) in `transient.el'.

Cycle through the mutually exclusive switches. The last value is "don't use any of these switches".

((obj transient-switch)) in `transient.el'.

Toggle the switch on or off.

((obj transient-infix)) in `transient.el'.

Read a value while taking care of history.

This method is suitable for a wide variety of infix commands, including but not limited to inline arguments and variables.

If you do not use this method for your own infix class, then you should likely replicate a lot of the behavior of this method. If you fail to do so, then users might not appreciate the lack of history, for example.

Only for very simple classes that toggle or cycle through a very limited number of possible values should you replace this with a simple method that does not handle history. (E.g., for a command line switch the only possible values are "use it" and "don't use it", in which case it is pointless to preserve history.)

:around ((obj transient-infix)) in `transient.el'.

Refresh the transient buffer and call the next method.

Also wrap `cl-call-next-method' with two macros: - `transient--with-suspended-override' allows use of minibuffer. - `transient--with-emergency-exit' arranges for the transient to be exited in case of an error.

Source Code

;; Defined in ~/.emacs.d/elpa/transient-20260414.1009/transient.el
;;;; Read

(cl-defgeneric transient-infix-read (obj)
  "Determine the new value of the infix object OBJ.

This function merely determines the value; `transient-infix-set'
is used to actually store the new value in the object.

For most infix classes this is done by reading a value from the
user using the reader specified by the `reader' slot (using the
method for `transient-infix', described below).

For some infix classes the value is changed without reading
anything in the minibuffer, i.e., the mere act of invoking the
infix command determines what the new value should be, based
on the previous value.")