Struct ServiceCapabilities 

pub struct ServiceCapabilities(/* private fields */);

The capabilities and limitations of the underlying platform service manager.

Implementations

impl ServiceCapabilities

pub const CUSTOM_USER_REQUIRES_PASSWORD: Self

The service requires a password when a custom user is used.

pub const SUPPORTS_CUSTOM_GROUP: Self

The service supports running as a custom group.

pub const USER_SERVICES_REQUIRE_NEW_LOGON: Self

User services require a new logon before they can be started.

pub const RESTART_ON_FAILURE_REQUIRES_AUTOSTART: Self

The service requires autostart to be enabled when restarting on failure is enabled.

pub const USES_NAME_PREFIX: Self

The service uses a name prefix.

pub const USER_SERVICES_REQ_ELEVATED_PRIV_FOR_INSTALL: Self

User services require elevated privileges to be installed.

pub const SUPPORTS_PENDING_PAUSED_STATES: Self

The service supports pending and pause states.

pub const USER_SERVICE_NAME_IS_DYNAMIC: Self

Fully qualified user service names are dynamic change between sessions. They should not be stored.

pub const SUPPORTS_DESCRIPTION: Self

The service supports a custom description.

pub const SUPPORTS_DISPLAY_NAME: Self

The service supports a custom display name.

pub const STARTS_IMMEDIATELY_WITH_AUTOSTART: Self

The service starts immediately after install when autostart is enabled.

impl ServiceCapabilities

pub const fn empty() -> Self

Get a flags value with all bits unset.

pub const fn all() -> Self

Get a flags value with all known bits set.

pub const fn bits(&self) -> u32

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: u32) -> Option<Self>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: u32) -> Self

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u32) -> Self

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

pub const fn intersects(&self, other: Self) -> bool

Whether any set bits in a source flags value are also set in a target flags value.

pub const fn contains(&self, other: Self) -> bool

Whether all set bits in a source flags value are also set in a target flags value.

Examples found in repository

examples/manager.rs (line 16)

fn run(
    service_name: &str,
    display_name: &str,
    description: &str,
) -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
    // Windows user services require a new logon before they can be started, so we will use a system service on Windows.
    // NOTE: Windows services always require elevated privileges to install, so run this example as administrator.
    let user = !UniServiceManager::capabilities()
        .contains(ServiceCapabilities::USER_SERVICES_REQUIRE_NEW_LOGON);
    let user_manager = UniServiceManager::new(service_name, "com.example.", user)?;

    let mut bin_path = std::env::current_exe().unwrap();
    bin_path.set_file_name(service_name);

    if !bin_path.exists() {
        return Err(format!(
            "Executable not found: {}. Make sure to build the service examples first.",
            bin_path.display()
        )
        .into());
    }

    let spec = ServiceSpec::new(bin_path)
        .arg("service")?
        .display_name(display_name)?
        .description(description)?;

    print!("Installing service '{service_name}'...",);
    user_manager.install_and_wait(&spec, TIMEOUT)?;
    println!("done");

    print!("Starting service '{service_name}'...");
    user_manager.start_and_wait(TIMEOUT)?;
    println!("done");

    io::stdout().flush()?;
    println!("Press Enter to stop the service...");
    let mut buffer = String::new();
    io::stdin().read_line(&mut buffer)?;

    print!("Stopping service '{service_name}'...");
    user_manager.stop_and_wait(TIMEOUT)?;
    println!("done");

    print!("Uninstalling service '{service_name}'...");
    user_manager.uninstall_and_wait(TIMEOUT)?;
    println!("done");

    Ok(())
}

pub fn insert(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

pub fn remove(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

pub fn toggle(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

pub fn set(&mut self, other: Self, value: bool)

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

pub const fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

pub const fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl ServiceCapabilities

pub const fn iter(&self) -> Iter<ServiceCapabilities>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<ServiceCapabilities>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

Trait Implementations

impl Binary for ServiceCapabilities

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

Formats the value using the given formatter.

impl BitAnd for ServiceCapabilities

fn bitand(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

type Output = ServiceCapabilities

The resulting type after applying the & operator.

impl BitAndAssign for ServiceCapabilities

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

impl BitOr for ServiceCapabilities

fn bitor(self, other: ServiceCapabilities) -> Self

The bitwise or (|) of the bits in two flags values.

type Output = ServiceCapabilities

The resulting type after applying the | operator.

impl BitOrAssign for ServiceCapabilities

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

impl BitXor for ServiceCapabilities

fn bitxor(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = ServiceCapabilities

The resulting type after applying the ^ operator.

impl BitXorAssign for ServiceCapabilities

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Extend<ServiceCapabilities> for ServiceCapabilities

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Flags for ServiceCapabilities

const FLAGS: &'static [Flag<ServiceCapabilities>]

The set of defined flags.

type Bits = u32

The underlying bits type.

fn bits(&self) -> u32

Get the underlying bits value.

fn from_bits_retain(bits: u32) -> ServiceCapabilities

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn iter_defined_names() -> IterDefinedNames<Self>

Yield a set of all named flags defined by Self::FLAGS.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

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

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

fn set(&mut self, other: Self, value: bool)

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

fn clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<ServiceCapabilities> for ServiceCapabilities

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

The bitwise or (|) of the bits in each flags value.

impl IntoIterator for ServiceCapabilities

type Item = ServiceCapabilities

The type of the elements being iterated over.

type IntoIter = Iter<ServiceCapabilities>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for ServiceCapabilities

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

Formats the value using the given formatter.

impl Not for ServiceCapabilities

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = ServiceCapabilities

The resulting type after applying the ! operator.

impl Octal for ServiceCapabilities

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

Formats the value using the given formatter.

impl PublicFlags for ServiceCapabilities

type Primitive = u32

The type of the underlying storage.

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.

impl Sub for ServiceCapabilities

fn sub(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = ServiceCapabilities

The resulting type after applying the - operator.

impl SubAssign for ServiceCapabilities

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for ServiceCapabilities

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

Formats the value using the given formatter.