pub struct WindowsScmInstall { /* private fields */ }Expand description
Caller-owned settings used when creating or refreshing an SCM registration.
The descriptor intentionally omits failure actions, service descriptions, dependencies, custom passwords, and service-entrypoint configuration. A refresh preserves existing fields that this descriptor does not own.
§Errors
The validating builders on this type report
ServiceError::InvalidInput: an empty, overlong, path-like, or
control-character service name, display name, account name, or dependency
name; a duplicate dependency name; and a zero or overlong transition
timeout. The Service Control Manager’s own conditions — an access denial
(OS code 5) and a registration that disappeared before the operation —
are reported by WindowsScmManager’s operations, not by this type.
Implementations§
Source§impl WindowsScmInstall
impl WindowsScmInstall
Sourcepub fn new(
service_name: impl Into<String>,
display_name: impl Into<String>,
start_type: WindowsStartType,
error_control: WindowsErrorControl,
account_name: Option<String>,
) -> Result<Self, ServiceError>
pub fn new( service_name: impl Into<String>, display_name: impl Into<String>, start_type: WindowsStartType, error_control: WindowsErrorControl, account_name: Option<String>, ) -> Result<Self, ServiceError>
Creates a caller-owned SCM install descriptor.
§Errors
ServiceError::InvalidInput when the service name is empty,
overlong (MAX_SCM_NAME_CHARS UTF-16 units), path-like, or contains a
control character; when the display name is empty, overlong, or
contains a control character; or when the account name is empty,
overlong, or contains a control character.
Sourcepub fn with_dependencies(
self,
dependencies: Vec<WindowsServiceDependency>,
) -> Result<Self, ServiceError>
pub fn with_dependencies( self, dependencies: Vec<WindowsServiceDependency>, ) -> Result<Self, ServiceError>
Sets caller-owned SCM dependencies. An empty list explicitly clears dependencies during refresh; leaving this unset preserves them.
§Errors
ServiceError::InvalidInput when a dependency name is empty,
overlong (MAX_SCM_NAME_CHARS UTF-16 units), path-like, or contains a
control character, or when the list names the same service or group
twice.
Sourcepub fn with_transition_timeout(
self,
timeout: Duration,
) -> Result<Self, ServiceError>
pub fn with_transition_timeout( self, timeout: Duration, ) -> Result<Self, ServiceError>
Sets the bounded timeout used by install/uninstall and SCM polling.
§Errors
ServiceError::InvalidInput when the timeout is zero or exceeds
MAX_TRANSITION_TIMEOUT.
Sourcepub fn service_id(&self) -> &ServiceId
pub fn service_id(&self) -> &ServiceId
The Windows service key name.
Sourcepub fn display_name(&self) -> &str
pub fn display_name(&self) -> &str
The caller-owned display name.
Sourcepub fn start_type(&self) -> WindowsStartType
pub fn start_type(&self) -> WindowsStartType
The caller-owned startup mode.
Sourcepub fn error_control(&self) -> WindowsErrorControl
pub fn error_control(&self) -> WindowsErrorControl
The caller-owned error-control setting.
Sourcepub fn account_name(&self) -> Option<&str>
pub fn account_name(&self) -> Option<&str>
Optional caller-selected account name; no account password is accepted or stored.
Sourcepub fn dependencies(&self) -> Option<&[WindowsServiceDependency]>
pub fn dependencies(&self) -> Option<&[WindowsServiceDependency]>
Optional caller-owned SCM dependencies; None preserves them on refresh.
Sourcepub fn transition_timeout(&self) -> Duration
pub fn transition_timeout(&self) -> Duration
The bounded timeout used by install/uninstall and SCM polling.