Skip to main content

libupdated/
lib.rs

1// SPDX-License-Identifier: MIT
2// SPDX-FileCopyrightText: <text>
3// Copyright(c) 2026 Liebherr-Digital Development Center GmbH
4// Written by Thomas Witte <thomas.witte@liebherr.com>
5// </text>
6
7const LOG: &str = "libupdated";
8
9pub mod traits;
10pub use traits::*;
11
12pub mod util;
13
14/// This module implements a Hawkbit update source that fetches updates from a Hawkbit server.
15/// It uses hawkbit-rs as the Hawkbit client library.
16#[cfg(feature = "hawkbit")]
17pub mod hawkbit;
18
19/// This module implements a consent handler that relays the consent decision via MQTT to an external application.
20/// It uses rumqttc as the MQTT client and fully encapsulates the MQTT communication and event loop.
21#[cfg(feature = "mqtt")]
22pub mod mqtt_consent;
23
24/// This module implements an installer using the swupdate tool. It uses the swupdate-rs crate to interact with swupdate via its IPC interface.
25#[cfg(feature = "swupdate")]
26pub mod swupdate;
27
28#[cfg(feature = "uboot")]
29pub mod uboot;
30
31/// This module contains generic building blocks for update workflows.
32pub mod update_workflow;
33
34/// This module contains building blocks to search, configure and run update workflows.
35pub mod workflow_runner;
36
37/// Simple installer that copys the update files to a target directory.
38pub mod directory_installer;
39
40/// Simple update source that scans a directory for an update.
41pub mod directory_source;
42
43/// Simple persistent store that saves key-value pairs to a file.
44pub mod file_store;
45
46/// Simple progress reporter that logs progress messages to the console.
47pub mod log_reporter;
48
49/// Implementations of IntegriryChecks for updates, e.g. simple timeout, systemd is_system_running.
50pub mod checks;
51
52/// Implementations of UpdateTriggers, e.g. Sleep.
53pub mod trigger;
54
55pub use libupdated_macros::workflow;
56
57#[doc(hidden)]
58pub use ::inventory;
59
60#[doc(hidden)]
61pub use ::futures::future::BoxFuture;