Skip to main content

MiddlewareRequest

Struct MiddlewareRequest 

Source
pub struct MiddlewareRequest<'request> {
    pub meta: CommandMeta,
    pub command_path: &'request str,
    pub system: &'request str,
    pub user_args: ValueMap,
    pub args: ValueMap,
    pub default_fields: &'request str,
    pub view_id: Option<&'request str>,
    pub auth: AuthRequirement,
    pub raw_output: bool,
    pub pagination_command: Option<String>,
}
Expand description

Inputs for one middleware-managed command execution.

Fields§

§meta: CommandMeta

Per-command metadata used by authentication, authorization, dry-run, audit, and activity.

§command_path: &'request str

Colon-separated command path.

§system: &'request str

Backend/system id used in output metadata and generic error attribution.

§user_args: ValueMap

Arguments explicitly supplied by the user.

§args: ValueMap

Effective arguments, including defaults.

§default_fields: &'request str

Default field projection when --fields is absent.

§view_id: Option<&'request str>

Id of the human view this command declared, if any.

The command path for an inline with_view, or the shared id from with_view_id. None renders generic human output.

§auth: AuthRequirement

Authentication requirement enforced by the engine for this command.

§raw_output: bool

Mirrors CommandSpec::raw_output: when true, a successful string result renders verbatim, bypassing the format/pipeline machinery entirely.

§pagination_command: Option<String>

The invoked command replayed as --flag value text — command path plus every flag the user explicitly passed, using clap’s own long-flag names — with --limit/--offset deliberately omitted.

Some only for a command that opted into CommandSpec::with_pagination; the engine appends --limit/--offset for the next page and surfaces it as a next_actions entry when the response has more data. None for every other command, and for any caller driving Middleware directly (e.g. Middleware::run_no_auth) instead of through Cli, which is what computes this.

Trait Implementations§

Source§

impl<'request> Clone for MiddlewareRequest<'request>

Source§

fn clone(&self) -> MiddlewareRequest<'request>

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<'request> Debug for MiddlewareRequest<'request>

Source§

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

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

impl<'request> PartialEq for MiddlewareRequest<'request>

Source§

fn eq(&self, other: &MiddlewareRequest<'request>) -> bool

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

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

Inequality operator !=. Read more
Source§

impl<'request> StructuralPartialEq for MiddlewareRequest<'request>

Auto Trait Implementations§

§

impl<'request> Freeze for MiddlewareRequest<'request>

§

impl<'request> RefUnwindSafe for MiddlewareRequest<'request>

§

impl<'request> Send for MiddlewareRequest<'request>

§

impl<'request> Sync for MiddlewareRequest<'request>

§

impl<'request> Unpin for MiddlewareRequest<'request>

§

impl<'request> UnsafeUnpin for MiddlewareRequest<'request>

§

impl<'request> UnwindSafe for MiddlewareRequest<'request>

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

Source§

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

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

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
Source§

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
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, <T as TryFrom<U>>::Error>

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.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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