Skip to main content

GlobalFlags

cli_engine::flags

Struct GlobalFlags

pub struct GlobalFlags {Show 14 fields
    pub output_format: String,
    pub verbose: String,
    pub dry_run: bool,
    pub fields: String,
    pub filter: String,
    pub expr: String,
    pub limit: i64,
    pub offset: i64,
    pub schema: bool,
    pub reason: String,
    pub timeout: String,
    pub debug: String,
    pub search: String,
    pub credential_store: Option<CredentialStore>,
}

Expand description

Parsed framework-global flags.

Applications can add their own global flags, but these are the built-in controls understood by middleware and the output pipeline.

Fields§

§output_format: String

Output format: json, human, or toon.

§verbose: String

Metadata verbosity selector.

§dry_run: bool

Whether mutating commands should short-circuit.

§fields: String

Field projection.

§filter: String

JMESPath per-item filter.

§expr: String

JMESPath whole-result expression.

§limit: i64

Client-side page size.

§offset: i64

Client-side page offset.

§schema: bool

Whether schema rendering was requested.

§reason: String

User-provided command reason.

§timeout: String

Raw timeout string.

§debug: String

Debug selector.

§search: String

Search query.

§credential_store: Option<CredentialStore>

Credential storage override from --credential-store, if supplied.

Trait Implementations§

impl Clone for GlobalFlags

fn clone(&self) -> GlobalFlags

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

impl Debug for GlobalFlags

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

Formats the value using the given formatter. Read more

impl Default for GlobalFlags

fn default() -> Self

Returns the “default value” for a type. Read more

impl Eq for GlobalFlags

impl PartialEq for GlobalFlags

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

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

1.0.0 (const: unstable) · Source§

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 StructuralPartialEq for GlobalFlags

Auto Trait Implementations§

impl Freeze for GlobalFlags

impl RefUnwindSafe for GlobalFlags

impl Send for GlobalFlags

impl Sync for GlobalFlags

impl Unpin for GlobalFlags

impl UnsafeUnpin for GlobalFlags

impl UnwindSafe for GlobalFlags

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

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

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

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

fn __clone_box(&self, _: Private) -> *mut ()

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

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

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

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

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

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

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more