Struct logind_zbus::UserProxy

pub struct UserProxy<'a>(_);

Proxy wrapper for the logind User dbus interface

All get_* methods are property getters

Example

use logind_zbus::ManagerProxy;
use logind_zbus::UserProxy;
use zbus::blocking::Connection;

let connection = Connection::system().unwrap();
let manager = ManagerProxy::new(&connection).unwrap();
let users = manager.list_users().unwrap();

let user = UserProxy::new(&connection, &users[0]).unwrap();

let time1 = user.get_timestamp().unwrap();
assert!(time1.as_secs() > 0);

let time2 = user.get_timestamp_monotonic().unwrap();
assert!(time2.as_secs() > 0);

Implementations

impl<'a> UserProxy<'a>

pub fn new<U>(connection: &Connection, user: &'a U) -> Result<Self> where
    U: IntoUserPath, 

pub fn kill(&self, signal_number: i32) -> Result<()>

pub fn terminate(&self) -> Result<()>

They’ll be back

pub fn get_display(&self) -> Result<DbusPath>

Property: which graphical session should be used as the primary UI display for the user. It is a structure encoding the session ID and the object path of the session to use.

pub fn get_gid(&self) -> Result<u32>

Property: primary GID of the user

pub fn get_is_idle_hint(&self) -> Result<bool>

Property: idle hint state of the user

pub fn get_is_idle_since_hint(&self) -> Result<Duration>

Property: idle hint state of the user

pub fn get_is_idle_since_hint_monotonic(&self) -> Result<Duration>

Property: idle hint state of the user

pub fn get_linger(&self) -> Result<bool>

Property: shows whether lingering is enabled for this user

pub fn get_name(&self) -> Result<String>

Property: Users name

pub fn get_runtime_path(&self) -> Result<String>

Property: runtime path of the user, i.e. $XDG_RUNTIME_DIR

pub fn get_service(&self) -> Result<String>

Property: the unit name of the user systemd service of this user. Each logged in user is assigned a user service that runs a user systemd instance. This is usually an instance of user@.service.

pub fn get_sessions(&self) -> Result<Vec<DbusPath>>

pub fn get_slice(&self) -> Result<String>

Property: unit name of the user systemd slice of this user. Each logged in user gets a private slice.

pub fn get_state(&self) -> Result<UserState>

Property: Users state

pub fn get_timestamp(&self) -> Result<Duration>

Property: login time of the user in microseconds since the epoch (realtime)

pub fn get_timestamp_monotonic(&self) -> Result<Duration>

Property: login time of the user in microseconds since the epoch (walltime)

pub fn get_uid(&self) -> Result<u32>

Property: Unix UID of the user

Methods from Deref<Target = Proxy<'a>>

pub fn connection(&self) -> &Connection

Get a reference to the associated connection.

pub fn destination(&self) -> &BusName<'_>

Get a reference to the destination service name.

pub fn path(&self) -> &ObjectPath<'_>

Get a reference to the object path.

pub fn interface(&self) -> &InterfaceName<'_>

Get a reference to the interface.

pub fn introspect(&self) -> Result<String, Error>

Introspect the associated object, and return the XML description.

See the xml module for parsing the result.

pub fn cached_property<T>(
    &self,
    property_name: &str
) -> Result<Option<T>, Error> where
    T: TryFrom<OwnedValue>,
    <T as TryFrom<OwnedValue>>::Error: Into<Error>, 

Get the cached value of the property property_name.

This returns None if the property is not in the cache. This could be because the cache was invalidated by an update, because caching was disabled for this property or proxy, or because the cache has not yet been populated. Use get_property to fetch the value from the peer.

pub fn cached_property_raw(
    &'p self,
    property_name: &'p str
) -> Option<impl Deref<Target = Value<'static>> + 'p>

Get the cached value of the property property_name.

Same as cached_property, but gives you access to the raw value stored in the cache. This is useful if you want to avoid allocations and cloning.

pub fn get_property<T>(&self, property_name: &str) -> Result<T, Error> where
    T: TryFrom<OwnedValue>,
    <T as TryFrom<OwnedValue>>::Error: Into<Error>, 

Get the property property_name.

Get the property value from the cache or call the Get method of the org.freedesktop.DBus.Properties interface.

pub fn set_property<'t, T>(
    &self,
    property_name: &str,
    value: T
) -> Result<(), Error> where
    T: 't + Into<Value<'t>>, 

Set the property property_name.

Effectively, call the Set method of the org.freedesktop.DBus.Properties interface.

pub fn call_method<'m, M, B>(
    &self,
    method_name: M,
    body: &B
) -> Result<Arc<Message>, Error> where
    M: TryInto<MemberName<'m>>,
    B: Serialize + DynamicType,
    <M as TryInto<MemberName<'m>>>::Error: Into<Error>, 

Call a method and return the reply.

Typically, you would want to use call method instead. Use this method if you need to deserialize the reply message manually (this way, you can avoid the memory allocation/copying, by deserializing the reply to an unowned type).

pub fn call<'m, M, B, R>(&self, method_name: M, body: &B) -> Result<R, Error> where
    M: TryInto<MemberName<'m>>,
    B: Serialize + DynamicType,
    R: DeserializeOwned + Type,
    <M as TryInto<MemberName<'m>>>::Error: Into<Error>, 

Call a method and return the reply body.

Use call_method instead if you need to deserialize the reply manually/separately.

pub fn call_noreply<'m, M, B>(
    &self,
    method_name: M,
    body: &B
) -> Result<(), Error> where
    M: TryInto<MemberName<'m>>,
    B: Serialize + DynamicType,
    <M as TryInto<MemberName<'m>>>::Error: Into<Error>, 

Call a method without expecting a reply

This sets the NoReplyExpected flag on the calling message and does not wait for a reply.

pub fn receive_signal<'m, M>(
    &self,
    signal_name: M
) -> Result<SignalIterator<'a>, Error> where
    'm: 'a,
    M: TryInto<MemberName<'m>>,
    <M as TryInto<MemberName<'m>>>::Error: Into<Error>, 

Create a stream for signal named signal_name.

Errors

Apart from general I/O errors that can result from socket communications, calling this method will also result in an error if the destination service has not yet registered its well-known name with the bus (assuming you’re using the well-known name as destination).

pub fn receive_all_signals(&self) -> Result<SignalIterator<'a>, Error>

Create a stream for all signals emitted by this service.

Errors

Apart from general I/O errors that can result from socket communications, calling this method will also result in an error if the destination service has not yet registered its well-known name with the bus (assuming you’re using the well-known name as destination).

pub fn receive_property_changed<'name, T>(
    &self,
    name: &'name str
) -> PropertyIterator<'a, T> where
    'name: 'a, 

Get an iterator to receive owner changed events.

If the proxy destination is a unique name, the stream will be notified of the peer disconnection from the bus (with a None value).

If the proxy destination is a well-known name, the stream will be notified whenever the name owner is changed, either by a new peer being granted ownership (Some value) or when the name is released (with a None value).

Note that zbus doesn’t queue the updates. If the listener is slower than the receiver, it will only receive the last update.

pub fn receive_owner_changed(&self) -> Result<OwnerChangedIterator<'_>, Error>

Get an iterator to receive property changed events.

Note that zbus doesn’t queue the updates. If the listener is slower than the receiver, it will only receive the last update.

pub fn inner(&self) -> &Proxy<'a>

Get a reference to the underlying async Proxy.

Trait Implementations

impl<'a> AsMut<Proxy<'a>> for UserProxy<'a>

fn as_mut(&mut self) -> &mut Proxy<'a>

Performs the conversion.

impl<'a> AsRef<Proxy<'a>> for UserProxy<'a>

fn as_ref(&self) -> &Proxy<'a>

Performs the conversion.

impl<'a> Deref for UserProxy<'a>

type Target = Proxy<'a>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a> DerefMut for UserProxy<'a>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.