pub struct ProcessSpec { /* private fields */ }Expand description
Declarative definition of one process within a workspace section.
Implementations§
Source§impl ProcessSpec
impl ProcessSpec
pub fn name(&self) -> &ProcessName
pub fn command(&self) -> &Option<CommandLine>
pub fn working_dir(&self) -> &Option<PathBuf>
pub fn description(&self) -> &Option<Description>
pub fn restart(&self) -> &Option<RestartPolicy>
Sourcepub fn stop(&self) -> &Option<StopPolicy>
pub fn stop(&self) -> &Option<StopPolicy>
Optional graceful shutdown policy. Only command specs may configure it.
Source§impl ProcessSpec
impl ProcessSpec
pub fn with_name(self, val: ProcessName) -> Self
pub fn with_command(self, val: Option<CommandLine>) -> Self
pub fn with_working_dir(self, val: Option<PathBuf>) -> Self
pub fn with_description(self, val: Option<Description>) -> Self
pub fn with_restart(self, val: Option<RestartPolicy>) -> Self
Sourcepub fn with_stop(self, val: Option<StopPolicy>) -> Self
pub fn with_stop(self, val: Option<StopPolicy>) -> Self
Optional graceful shutdown policy. Only command specs may configure it.
Sourcepub fn with_autostart(self, val: Option<bool>) -> Self
pub fn with_autostart(self, val: Option<bool>) -> Self
Whether to launch this process automatically on load. Absent means the
per-kind default; true/false overrides it.
Source§impl ProcessSpec
impl ProcessSpec
Sourcepub fn builder() -> ProcessSpecBuilder<((), (), (), (), (), (), ())>
pub fn builder() -> ProcessSpecBuilder<((), (), (), (), (), (), ())>
Create a builder for building ProcessSpec.
On the builder, call .name(...), .command(...)(optional), .working_dir(...)(optional), .description(...)(optional), .restart(...)(optional), .stop(...)(optional), .autostart(...)(optional) to set the values of the fields.
Finally, call .build() to create the instance of ProcessSpec.
Source§impl ProcessSpec
impl ProcessSpec
Sourcepub fn to_process(&self, id: PaneId, kind: ProcessKind) -> Process
pub fn to_process(&self, id: PaneId, kind: ProcessKind) -> Process
Builds the corresponding Process entity in its initial Pending state.
Sourcepub fn restart_policy(&self) -> RestartPolicy
pub fn restart_policy(&self) -> RestartPolicy
The effective restart policy, treating an absent policy as Never.
Sourcepub fn should_autostart(&self, kind: ProcessKind) -> bool
pub fn should_autostart(&self, kind: ProcessKind) -> bool
Whether this process auto-starts. Defaults to false for commands (which wait for an explicit start) and true for agents and terminals.
Sourcepub fn effective_stop_policy(&self, kind: ProcessKind) -> Option<StopPolicy>
pub fn effective_stop_policy(&self, kind: ProcessKind) -> Option<StopPolicy>
The effective graceful shutdown policy for kind. Commands use the
domain default when the config omits stop; other kinds have no policy.
Trait Implementations§
Source§impl Clone for ProcessSpec
impl Clone for ProcessSpec
Source§fn clone(&self) -> ProcessSpec
fn clone(&self) -> ProcessSpec
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for ProcessSpec
impl Debug for ProcessSpec
Source§impl<'de> Deserialize<'de> for ProcessSpec
impl<'de> Deserialize<'de> for ProcessSpec
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Auto Trait Implementations§
impl Freeze for ProcessSpec
impl RefUnwindSafe for ProcessSpec
impl Send for ProcessSpec
impl Sync for ProcessSpec
impl Unpin for ProcessSpec
impl UnsafeUnpin for ProcessSpec
impl UnwindSafe for ProcessSpec
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> DeserializeOwned for Twhere
T: for<'de> Deserialize<'de>,
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&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)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&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> DowncastSync for T
impl<T> DowncastSync for T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more