Enum CheckMode 

pub enum CheckMode {
    Check,
    Write,
    CheckAndWrite,
}

Variants

Check

Write

CheckAndWrite

Implementations

impl CheckMode

pub(crate) fn parse(args: &[String], usage: &str) -> Result<Option<Self>>

Parses the --write/--check flag pair shared by every regenerate-or-verify xtask command (check-openapi, check-schema-docs, check-ts-client).

Returns Ok(None) when --help was handled and the caller should do nothing else. That is why this returns an Option rather than a bare CheckMode: printing usage and then running the command anyway (which is what returning a default mode here used to do) surprises anyone who asked what a command does and got it done to them instead.

pub(crate) fn should_check(self) -> bool

pub(crate) fn should_write(self) -> bool

Trait Implementations

impl Clone for CheckMode

fn clone(&self) -> CheckMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CheckMode

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

Formats the value using the given formatter.

impl PartialEq for CheckMode

fn eq(&self, other: &CheckMode) -> 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 CheckMode

impl Eq for CheckMode

impl StructuralPartialEq for CheckMode