Struct fwupd_dbus::Client

pub struct Client {
    pub client_name: String,
    // some fields omitted
}

A DBus client for interacting with the fwupd daemon.

Fields

client_name: String

Implementations

impl Client

pub fn new() -> Result<Self, Error>

pub fn activate<D: AsRef<DeviceId>>(&self, id: D) -> Result<(), Error>

Activate a firmware update on the device.

pub fn clear_results<D: AsRef<DeviceId>>(&self, id: D) -> Result<(), Error>

Clears the results of an offline update.

pub fn daemon_version(&self) -> Result<Box<str>, Error>

The version of this daemon.

pub fn details<H: IntoRawFd>(
    &self,
    handle: H
) -> Result<Vec<HashMap<String, DynVariant>>, Error>

Gets details about a local firmware file.

pub fn devices(&self) -> Result<Vec<Device>, Error>

Gets a list of all the devices that are supported.

pub fn downgrades<D: AsRef<DeviceId>>(
    &self,
    device_id: D
) -> Result<Vec<Release>, Error>

Get a list of all the downgrades possible for a specific device.

pub fn fetch_firmware_from_release<C: FnMut(FlashEvent)>(
    &self,
    device: &Device,
    release: &Release,
    callback: Option<C>
) -> Result<(PathBuf, Option<File>), Error>

Fetches firmware from a remote and caches it for later use.

Firmware will only be fetched if it has not already been cached, or the cached firmware has an invalid checksum.

pub fn update_device_with_release<F: FnMut(FlashEvent)>(
    &self,
    device: &Device,
    release: &Release,
    flags: InstallFlags,
    callback: Option<F>
) -> Result<(), Error>

Update firmware for a Device with the firmware specified in a Release.

pub fn history<H: IntoRawFd>(&self, handle: H) -> Result<Vec<Device>, Error>

Gets a list of all the past firmware updates.

pub fn install<D: AsRef<DeviceId>, H: IntoRawFd>(
    &self,
    id: D,
    reason: &str,
    filename: &Path,
    handle: Option<H>,
    flags: InstallFlags
) -> Result<(), Error>

Schedules a firmware to be installed.

pub fn listen_signals<'a>(
    &'a self,
    cancellable: Arc<AtomicBool>
) -> impl Iterator<Item = Signal> + 'a

Listens for signals from the DBus daemon.

pub fn modify_device<D: AsRef<DeviceId>>(
    &self,
    device_id: D,
    key: &str,
    value: &str
) -> Result<(), Error>

Modifies a device in some way.

pub fn modify_remote<R: AsRef<RemoteId>>(
    &self,
    remote_id: R,
    key: &str,
    value: &str
) -> Result<(), Error>

Modifies a remote in some way.

pub fn percentage(&self) -> Result<u8, Error>

The job percentage completion, or 0 for unknown.

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

pub fn releases<D: AsRef<DeviceId>>(
    &self,
    device_id: D
) -> Result<Vec<Release>, Error>

Gets a list of all the releases for a specific device.

pub fn remote<D: AsRef<RemoteId>>(&self, id: D) -> Result<Remote, Error>

Find the remote with the given ID.

pub fn remotes(&self) -> Result<Vec<Remote>, Error>

Gets the list of remotes.

pub fn results<D: AsRef<DeviceId>>(
    &self,
    id: D
) -> Result<Option<Device>, Error>

Gets the results of an offline update.

pub fn status(&self) -> Result<Status, Error>

The daemon status, e.g. Decompressing.

pub fn tainted(&self) -> Result<bool, Error>

If the daemon has been tainted with a third party plugin.

pub fn unlock<D: AsRef<DeviceId>>(&self, id: D) -> Result<(), Error>

Unlock the device to allow firmware access.

pub fn update_metadata<D: IntoRawFd, S: IntoRawFd, R: AsRef<RemoteId>>(
    &self,
    remote_id: R,
    data: D,
    signature: S
) -> Result<(), Error>

Adds AppStream resource information from a session client.

pub fn upgrades<D: AsRef<DeviceId>>(
    &self,
    device_id: D
) -> Result<Vec<Release>, Error>

Get a list of all the upgrades possible for a specific device.

pub fn verify<D: AsRef<DeviceId>>(&self, id: D) -> Result<(), Error>

Verifies firmware on a device by reading it back and performing a cryptographic hash, typically SHA1.

pub fn verify_update<D: AsRef<DeviceId>>(&self, id: D) -> Result<(), Error>

Updates the cryptographic hash stored for a device.