Struct logind_zbus::SeatProxy

pub struct SeatProxy<'a>(_);

Proxy wrapper for the logind Seat dbus interface

Example

use logind_zbus::ManagerProxy;
use logind_zbus::SeatProxy;
use zbus::Connection;

let connection = Connection::new_system().unwrap();
let manager = ManagerProxy::new(&connection).unwrap();
let seats = manager.list_seats().unwrap();
let seat = SeatProxy::new(&connection, &seats[0]).unwrap();

assert!(seat.get_active_session().is_ok());

assert!(manager.can_suspend().is_ok());

Implementations

impl<'a> SeatProxy<'a>

pub fn new(connection: &Connection, path: &'a SeatPath) -> Result<Self>

pub fn activate_session(&self, session_id: &str) -> Result<()>

Brings the session with the specified ID into the foreground if the session_id matches

pub fn switch_to(&self, vtnr: u32) -> Result<()>

Switches to the session on the virtual terminal

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

Switches to next session on the virtual terminal

If there is no active session, switches to the first session.

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

Switches to previous session on the virtual terminal

If there is no active session, switches to the first session.

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

Nuke the seat

pub fn get_active_session(&self) -> Result<SessionPath>

Property: currently active session if there is one

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

Property: the session is suitable for graphical logins

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

Property: the session is suitable for text logins

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

Property: seat ID

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

Property: Is the seat idle

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

Property: timestamp of the last change of the idle hint boolean (realtime)

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

Property: timestamp of the last change of the idle hint boolean (walltime)

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

pub fn connection(&self) -> &Connection

Get a reference to the associated connection.

pub fn destination(&self) -> &str

Get a reference to the destination service name.

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

Get a reference to the object path.

pub fn interface(&self) -> &str

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 get_property<T>(&self, property_name: &str) -> Result<T, Error> where
    T: TryFrom<OwnedValue>, 

Get the property property_name.

Effectively, 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<B>(
    &self,
    method_name: &str,
    body: &B
) -> Result<Message, Error> where
    B: Serialize + Type, 

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<B, R>(&self, method_name: &str, body: &B) -> Result<R, Error> where
    B: Serialize + Type,
    R: DeserializeOwned + Type, 

Call a method and return the reply body.

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

pub fn connect_signal<H>(
    &self,
    signal_name: &'static str,
    handler: H
) -> Result<SignalHandlerId, Error> where
    H: FnMut(&Message) -> Result<(), Error> + Send + 'static, 

Register a handler for signal named signal_name.

Once a handler is successfully registered, call Self::next_signal to wait for the next signal to arrive and be handled by its registered handler. A unique ID for the handler is returned, which can be used to deregister this handler using Self::disconnect_signal method.

Errors

This method can fail if addition of the relevant match rule on the bus fails. You can safely unwrap the Result if you’re certain that associated connnection is not a bus connection.

pub fn disconnect_signal(
    &self,
    handler_id: SignalHandlerId
) -> Result<bool, Error>

Deregister the signal handler with the ID handler_id.

This method returns Ok(true) if a handler with the id handler_id is found and removed; Ok(false) otherwise.

Errors

This method can fail if removal of the relevant match rule on the bus fails. You can safely unwrap the Result if you’re certain that associated connnection is not a bus connection.

pub fn next_signal(&self) -> Result<Option<Message>, Error>

Receive and handle the next incoming signal on the associated connection.

This method will wait for signal messages on the associated connection and call any handlers registered through the Self::connect_signal method. Signal handlers can be registered and deregistered from another threads during the call to this method.

If the signal message was handled by a handler, Ok(None) is returned. Otherwise, the received message is returned.

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 handle_signal(&self, msg: &Message) -> Result<bool, Error>

Handle the provided signal message.

Call any handlers registered through the Self::connect_signal method for the provided signal message.

If no errors are encountered, Ok(true) is returned if a handler was found and called for, the signal; Ok(false) otherwise.

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

Get a reference to the underlying async Proxy.

Trait Implementations

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

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

Performs the conversion.

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

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

Performs the conversion.

impl<'a> Deref for SeatProxy<'a>

type Target = Proxy<'a>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a> DerefMut for SeatProxy<'a>

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

Mutably dereferences the value.