Skip to main content

WindowsScmInstall

Struct WindowsScmInstall 

Source
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

Source

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.

Source

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.

Source

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.

Source

pub fn service_id(&self) -> &ServiceId

The Windows service key name.

Source

pub fn display_name(&self) -> &str

The caller-owned display name.

Source

pub fn start_type(&self) -> WindowsStartType

The caller-owned startup mode.

Source

pub fn error_control(&self) -> WindowsErrorControl

The caller-owned error-control setting.

Source

pub fn account_name(&self) -> Option<&str>

Optional caller-selected account name; no account password is accepted or stored.

Source

pub fn dependencies(&self) -> Option<&[WindowsServiceDependency]>

Optional caller-owned SCM dependencies; None preserves them on refresh.

Source

pub fn transition_timeout(&self) -> Duration

The bounded timeout used by install/uninstall and SCM polling.

Trait Implementations§

Source§

impl Clone for WindowsScmInstall

Source§

fn clone(&self) -> Self

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 Debug for WindowsScmInstall

Source§

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

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

impl Eq for WindowsScmInstall

Source§

impl PartialEq for WindowsScmInstall

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for WindowsScmInstall

Auto Trait Implementations§

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> 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> Same for T

Source§

type Output = T

Should always be Self
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, !>

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.