Enum Mode

pub enum Mode {
    GuardedAreaTransferMode = 1,
    KeyboardActionMode = 2,
    ControlPresentationMode = 3,
    InsertionReplacementMode = 4,
    StatusReportTransferMode = 5,
    ErasureMode = 6,
    LineEditingMode = 7,
    BiDirectionalSupportMode = 8,
    DeviceComponentSelectMode = 9,
    CharacterEditingMode = 10,
    PositioningUnitMode = 11,
    SendReceiveMode = 12,
    FormatEffectorActionMode = 13,
    FormatEffectorTransferMode = 14,
    MultipleAreaTransferMode = 15,
    TransferTerminationMode = 16,
    SelectedAreaTransferMode = 17,
    TabulationStopMode = 18,
    GraphicRenditionCombinationMode = 21,
    ZeroDefaultMode = 22,
}

Device Modes.

Variants

GuardedAreaTransferMode = 1

Guarded Area Transfer Mode GATM.

Reset: Guard

Only the contents of unguarded areas in an eligible area are transmitted or transferred.

Set: All

The contents of guarded as well as of unguarded areas in an eligible area are transmitted or transferred.

Note

No control functions are affected.

KeyboardActionMode = 2

Keyboard Action Mode KAM.

Reset: Enabled

All or part of the manual input facilities are enabled to be used.

Set: Disabled

All or part of the manual input facilities are disabled.

Note

No control functions are affected.

ControlPresentationMode = 3

Control Presentation Mode CRM.

Reset: Control

All control functions are performed as defined; the way formator functions are processed depends on the setting of the FORMAT EFFECTOR ACTION MODE (FEAM). A device may choose to image the graphical representations of control functions in addition to performing them.

Set: Graphic

All control functions, except RESET MODE (RM), are treated as graphic characters. A device may choose to perform some control functions in addition to storing them and imaging their graphical representations.

InsertionReplacementMode = 4

Insertion Replacement Mode IRM.

Reset: Replace

The graphic symbol of a graphic character or of a control function, for which a graphical representation is required, replaces (or, depending upon the implementation, is combined with) the graphic symbol imaged at the active presentation position.

Set: Insert

The graphic symbol of a graphic character or of a control function, for which a graphical representation is required, is inserted at the active presentation position.

Note

Only control functions for which a graphical representation is required are affected.

StatusReportTransferMode = 5

Status Report Transfer Mode SRTM.

Reset: Normal

Status reports in the form of DEVICE CONTROL STRINGs (DCS) are not generated automatically.

Set: Diagnostic

Status reports in the form of DEVICE CONTROL STRINGs (DCS) are included in every data stream transmitted or transferred.

Note:

No control functions are affected.

ErasureMode = 6

Erasure Mode ERM.

Reset: Protect

Only the contents of unprotected areas are affected by an erasure control function.

Set: All

The contents of protected as well as of unprotected areas are affected by an erasure control function.

Note

Control functions affected are: EA, ECH, ED, EF, EL.

LineEditingMode = 7

Line Editing Mode VEM.

Reset: Following

If the DEVICE COMPONENT SELECT MODE (DCSM) is set to PRESENTATION, a line insertion causes the contents of the active line (the line that contains the active presentation position) and of the following lines in the presentation component to be shifted in the direction of the line progression; a line deletion causes the contents of the lines following the active line to be shifted in the direction opposite to that of the line progression.

If the DEVICE COMPONENT SELECT MODE (DCSM) is set to DATA, a line insertion causes the contents of the active line (the line that contains the active data position) and of the following lines in the data component to be shifted in the direction of the line progression; a line deletion causes the contents of the lines following the active line to be shifted in the direction opposite to that of the line progression.

Set: Preceding

If the DEVICE COMPONENT SELECT MODE (DCSM) is set to PRESENTATION, a line insertion causes the contents of the active line (the line that contains the active presentation position) and of the preceding lines to be shifted in the direction opposite to that of the line progression; a line deletion causes the contents of the lines preceding the active line to be shifted in the direction of the line progression.

If the DEVICE COMPONENT SELECT MODE (DCSM) is set to DATA, a line insertion causes the contents of the active line (the line that contains the active data position) and of the preceding lines to be shifted in the direction opposite to that of the line progression; a line deletion causes the contents of the lines preceding the active line to be shifted in the direction of the line progression.

Note

Control functions affected are: DL, IL.

BiDirectionalSupportMode = 8

Bi-directional support mode BDSM.

Reset: Explicit

Control functions are performed in the data component or in the presentation component, depending on the setting of the DEVICE COMPONENT SELECT MODE (DeviceComponentSelectMode).

Set: Implicit

Control functions are performed in the data component. All bi-directional aspects of data are handled by the device itself.

DeviceComponentSelectMode = 9

Device Component Select Mode DCSM.

Reset: Presentation

Certain control functions are performed in the presentation component. The active presentation position (or the active line, where applicable) in the presentation component is the reference position against which the relevant control functions are performed.

Set: Data

Certain control functions are performed in the data component. The active data position (or the active line, where applicable) in the data component is the reference position against which the relevant control functions are performed.

Note

Control functions affected are: CPR, CR, DCH, DL, EA, ECH, ED, EF, EL, ICH, IL, LF, NEL, RI, SLH, SLL, SPH, SPL.

CharacterEditingMode = 10

Character Editing Mode HEM.

Reset: Following

If the DEVICE COMPONENT SELECT MODE (DCSM) is set to PRESENTATION, a character insertion causes the contents of the active presentation position and of the following character positions in the presentation component to be shifted in the direction of the character path; a character deletion causes the contents of the character positions following the active presentation position to be shifted in the direction opposite to that of the character path

If the DEVICE COMPONENT SELECT MODE (DCSM) is set to DATA, a character insertion causes the contents of the active data position and of the following character positions in the data component to be shifted in the direction of the character progression; a character deletion causes the contents of the character positions following the active data position to be shifted in the direction opposite to that of the character progression.

Set: Preceding

If the DEVICE COMPONENT SELECT MODE (DCSM) is set to PRESENTATION, a character insertion causes the contents of the active presentation position and of the following character positions in the presentation component to be shifted in the direction opposite to that of the character path; a character deletion causes the contents of the character positions following the active presentation position to be shifted in the direction of the character path.

If the DEVICE COMPONENT SELECT MODE (DCSM) is set to DATA, a character insertion causes the contents of the active data position and of preceding character positions in the data component to be shifted in the direction opposite to that of the character progression; a character deletion causes the contents of the character positions preceding the active data position to be shifted in the direction of the character progression.

Note

Control functions affected are: DCH, ICH.

PositioningUnitMode = 11

Positioning Unit Mode PUM.

Reset: Character

The unit for numeric parameters of the positioning format effectors is one character position.

Set: Size

The unit for numeric parameters of the positioning format effectors is that established by the parameter value of SELECT SIZE UNIT (SSU).

Note 1

Control functions affected are: CUB, CUD, CUF, CUU, HPA, HPB, HPR, HVP, SLH, SLL, SSU, VPA, VPB, VPR.

Note 2

As the default parameter value of the control function SELECT SIZE UNIT (SSU) is CHARACTER, this mode is redundant and should no longer be used.

Note 3

The use of the POSITIONING UNIT MODE (PUM) is deprecated.

SendReceiveMode = 12

Send/Receive Mode SRM.

Reset: Monitor

Data which are locally entered are immediately imaged.

Set: Simultaneous

Local input facilities are logically disconnected from the output mechanism; only data which are sent to the device are imaged.

Note

No control functions are affected.

FormatEffectorActionMode = 13

Format Effector Action Mode FEAM.

Reset: Execute

Formator functions are performed immediately and may be stored in addition to being performed.

Set: Store

Formator functions are stored but not performed. In this case, the specified action is intended to be performed by another device when the associated data are transmitted or transferred.

Note

Control functions affected are: BPH, BS, CR, DTA, FF, FNT, GCC, GSM, GSS, HPA, HPB, HPR, HT, HTJ, HTS, HVP, JFY, NEL, PEC, PFS, PLD, PLU, PPA, PPB, PPR, PTX, QUAD, RI, SACS, SAPV, SCO, SCS, SGR, SHS, SLH, SLL, SLS, SPD, SPI, SPQR, SRCS, SRS, SSU, SSW, STAB, SVS, TAC, TALE, TATE, TBC, TCC, TSS, VPA, VPB, VPR, VTS.

FormatEffectorTransferMode = 14

Format Effector Transfer Mode FETM.

Reset: Insert

Formator functions may be inserted in a data stream to be transmitted or in data to be transferred to an auxiliary input/output device.

Set: Exclude

No formator functions other than those received while the FORMAT EFFECTOR ACTION MODE FEAM is set to STORE are included in a transmitted data stream or in data transferred to an auxiliary input/output device.

Note

No control functions are affected.

MultipleAreaTransferMode = 15

Multiple Area Transfer Mode MATM.

Reset: Single

Only the contents of the selected area which contains the active presentation position are eligible to be transmitted or transferred

Set: Multiple

The contents of all selected areas are eligible to be transmitted or transferred.

Note

No control functions are affected.

TransferTerminationMode = 16

Transfer Termination Mode TTM.

Reset: Cursor

Only the contents of the character positions preceding the active presentation position in the presentation component are eligible to be transmitted or transferred.

Set: All

The contents of character positions preceding, following, and at the active presentation position are eligible to be transmitted or transferred.

Note

No control functions are affected.

SelectedAreaTransferMode = 17

Selected Area Transfer Mode SATM.

Reset: Select

Only the contents of selected areas are eligible to be transmitted or transferred.

Set: All

The contents of all character positions, irrespective of any explicitly defined selected areas, are eligible to be transmitted or transferred.

Note

No control functions are affected.

TabulationStopMode = 18

Tabulation Stop Mode TSM.

Reset: Multiple

Character tabulation stops in the presentation component are set or cleared in the active line (the line that contains the active presentation position) and in the corresponding character positions of the preceding lines and of the following lines.

Set: Single

Character tabulation stops in the presentation component are set or cleared in the active line only.

Note

Control functions affected are: CTC, DL, HTS, IL, TBC.

GraphicRenditionCombinationMode = 21

Graphic Rendition Combination Mode GRCM.

Reset: Replacing

Each occurrence of the control function SELECT GRAPHIC RENDITION (SGR) cancels the effect of any preceding occurrence. Any graphic rendition aspects that are to remain unchanged after an occurrence of SGR have to be re-specified by that SGR.

Set: Cumulative

Each occurrence of the control function SELECT GRAPHIC RENDITION (SGR) causes only those graphic rendition aspects to be changed that are specified by that SGR. All other graphic rendition aspects remain unchanged.

Note

Control function affected is SGR.

ZeroDefaultMode = 22

Zero Default Mode ZDM.

Reset: Zero

A parameter value of 0 of a control function means the number 0.

Set: Default

A parameter value of 0 represents a default parameter value which may be different from 0.

Note 1

This mode was provided for implementations of the first edition of this Standard which specified that “an empty parameter sub-string or a parameter sub-string which consists of bit combinations 03/00 only represents a default value which depends on the control function”.

For numeric parameters which are expressed in units established by the parameter value of SELECT SIZE UNIT (SSU) the value 0 could then be specified. For numeric parameters which are effectively repeat counts, a 0 parameter value corresponded to a “no-op”. In either instance, non-negative computed numeric parameter values might have been used without treating 0 as a special (unusable) case.

Where an explicit parameter value was not used, implementers were urged to omit a parameter value (use an empty parameter sub-string) to imply a default parameter value.

Control functions affected are: CBT, CHA, CHT, CNL, CPL, CPR, CUB, CUD, CUF, CUP, CUU, CVT, DCH, DL, ECH, GSM, HPA, HPB, HPR, HVP, ICH, IL, NP, PP, PPA, PPB, PPR, REP, SD, SL, SR, SU, TCC, VPA, VPB, VPR.

Note 2

Since the publication of the first edition of this Standard in 1976 almost 15 years have expired. The use of this mode should no longer be required because the definition of default parameter values has been changed.

Note 3

The use of the ZERO DEFAULT MODE (ZDM) is deprecated.

Implementations

impl Mode

pub fn set(self) -> ControlFunction<'static>

Set the mode.

pub fn reset(self) -> ControlFunction<'static>

Reset the mode.

Trait Implementations

impl Clone for Mode

fn clone(&self) -> Mode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Mode

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

Formats the value using the given formatter.

impl FromStr for Mode

type Err = Infallible

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for Mode

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Mode

impl Eq for Mode

impl StructuralPartialEq for Mode