CmdCtxNpnfParams

Struct CmdCtxNpnfParams 

Source
pub struct CmdCtxNpnfParams<'ctx, CmdCtxTypesT>
where CmdCtxTypesT: CmdCtxTypes,
{ pub output: OwnedOrMutRef<'ctx, CmdCtxTypesT::Output>, pub interruptibility: Interruptibility<'static>, pub workspace: OwnedOrRef<'ctx, Workspace>, pub workspace_params: WorkspaceParamsOpt<<CmdCtxTypesT as CmdCtxTypes>::WorkspaceParamsKey>, }
Expand description

Context for a command that only works with workspace parameters – no profile / no flow.

path/to/repo/.peace/envman
|- 📝 workspace_params.yaml    # ✅ can read or write `WorkspaceParams`
|
|- 🌏 ..                       # ❌ cannot read or write `Profile` information

§Capabilities

This kind of command can:

  • Read or write workspace parameters.

This kind of command cannot:

Fields§

§output: OwnedOrMutRef<'ctx, CmdCtxTypesT::Output>

Output endpoint to return values / errors, and write progress information to.

See OutputWrite.

§interruptibility: Interruptibility<'static>

The interrupt channel receiver if this CmdExecution is interruptible.

§workspace: OwnedOrRef<'ctx, Workspace>

Workspace that the peace tool runs in.

§workspace_params: WorkspaceParamsOpt<<CmdCtxTypesT as CmdCtxTypes>::WorkspaceParamsKey>

Workspace params.

Implementations§

Source§

impl<'ctx, CmdCtxTypesT> CmdCtxNpnfParams<'ctx, CmdCtxTypesT>
where CmdCtxTypesT: CmdCtxTypes,

Source

pub fn builder() -> CmdCtxNpnfParamsBuilder<'ctx, CmdCtxTypesT, ((), (), (), (WorkspaceParamsOpt<<CmdCtxTypesT as CmdCtxTypes>::WorkspaceParamsKey>,))>

Create a builder for building CmdCtxNpnfParams. On the builder, call .output(...), .interruptibility(...)(optional), .workspace(...) to set the values of the fields. Finally, call .build_partial() to create the instance of CmdCtxNpnfParams.

Trait Implementations§

Source§

impl<'ctx, CmdCtxTypesT> Debug for CmdCtxNpnfParams<'ctx, CmdCtxTypesT>
where CmdCtxTypesT: CmdCtxTypes + Debug, CmdCtxTypesT::Output: Debug,

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'ctx, CmdCtxTypesT> Freeze for CmdCtxNpnfParams<'ctx, CmdCtxTypesT>
where <CmdCtxTypesT as CmdCtxTypes>::Output: Freeze,

§

impl<'ctx, CmdCtxTypesT> !RefUnwindSafe for CmdCtxNpnfParams<'ctx, CmdCtxTypesT>

§

impl<'ctx, CmdCtxTypesT> Send for CmdCtxNpnfParams<'ctx, CmdCtxTypesT>
where <CmdCtxTypesT as CmdCtxTypes>::Output: Send,

§

impl<'ctx, CmdCtxTypesT> Sync for CmdCtxNpnfParams<'ctx, CmdCtxTypesT>
where <CmdCtxTypesT as CmdCtxTypes>::Output: Sync,

§

impl<'ctx, CmdCtxTypesT> Unpin for CmdCtxNpnfParams<'ctx, CmdCtxTypesT>
where <CmdCtxTypesT as CmdCtxTypes>::WorkspaceParamsKey: Unpin,

§

impl<'ctx, CmdCtxTypesT> !UnwindSafe for CmdCtxNpnfParams<'ctx, CmdCtxTypesT>

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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSend for T
where T: Any + Send,

Source§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_sync(self: Box<T>) -> Box<dyn Any + Send + Sync>

Converts Box<Trait> (where Trait: DowncastSync) to Box<dyn Any + Send + Sync>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Converts Arc<Trait> (where Trait: DowncastSync) to Arc<Any>, which can then be downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> Resource for T
where T: Any + Debug + Send + Sync,

Source§

fn type_id(&self) -> TypeId

Source§

fn type_name(&self) -> TypeNameLit

Source§

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

Source§

type Error = Infallible

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.