Updates

The crate works on both Flatpak installations at once: every system installation and the user installation. All functions block, so call them from a worker thread. The progress callback runs on the calling thread, from inside the call.

Example

use telamon_framework_flatpak as flatpak;

// What is available (refresh = true updates remote summaries and appstream data first, over the network).
for u in flatpak::list_updates(true)? {
    println!("{} {} ({} bytes)", u.name, u.branch, u.download_size);
}

// Run the updates, holding back apps that ask for new permissions.
let opts = flatpak::UpdateOptions { hold_new_permissions: true, ..Default::default() };
let outcome = flatpak::update(&opts, |p| eprintln!("{}: {}%", p.reference, p.percent));
for h in &outcome.held_back {
    println!("{} wants: {:?}", h.app.name, h.permissions);
}
if let Some(e) = outcome.error {
    eprintln!("an update failed: {e}");
}

Functions

UpdateOptions

#[derive(Debug, Clone, Copy, Default, PartialEq, Eq)]. All fields default to false.

Cancellation and time limits

libflatpak has no timeouts of its own, so a stalled remote would hold the worker for good. CancelToken (Debug, Clone, Default; new(), cancel(), is_cancelled()) stops a running call from another thread within about 50 ms. ListOptions (Debug, Clone, #[non_exhaustive]: start from ListOptions::default() and set the fields, or use the with_refresh, with_no_interaction, with_cancel, with_call_timeout and with_deadline methods) has refresh: bool and no_interaction: bool (both default false), cancel: Option<CancelToken> (default None) and call_timeout: Option<Duration> (default Some(DEFAULT_CALL_TIMEOUT), 60 seconds; None waits for ever) and deadline: Option<Duration> (the whole run, default None; calls are cut to what is left of it). A remote that failed to refresh, or timed out sizing a ref, gets no more size lookups in that run (those sizes are 0). The timeout is per libflatpak call (refreshing a remote, its appstream data, listing, sizing a ref): a call over it fails with timed out after N s, is logged and the run goes on with the next.

ListOutcome (Debug, Clone, Default, PartialEq, Eq, #[non_exhaustive]) has updates: Vec<AppUpdate>, errors: Vec<InstallationError> and checked: usize (installations checked without error) and cancelled: bool (stopped by the token; into_result() is then an error); into_result() is the updates, or the first error when nothing could be checked. InstallationError (#[non_exhaustive]) has installation: InstallationKind, id: String (flatpak's id for it, empty when listing the system installations itself failed) and error: Error. Error also derives Clone, PartialEq, Eq.

Types

All derive Debug, Clone, PartialEq, Eq unless noted.

Errors and text from remotes

pub struct Error(pub String) implements Debug, Display and std::error::Error, and converts from a glib error. The message is cleaned and cut to 300 characters, because flatpak's messages can carry text from a remote. pub type Result<T> = std::result::Result<T, Error>.

Text from a remote (app names, versions, permission items) should be made safe before it is shown or logged: