devela/ui/back/
definition.rs

1// devela::ui::service::definition
2//
3//! Defines the [`UiService`] trait.
4//
5
6use crate::UiCap;
7
8/// Common trait for all UI services.
9pub trait UiService {
10    /// Returns the service capabilities.
11    fn capabilities(&self) -> UiCap;
12
13    /// Returns the service inner version numbers (major, minor, patch).
14    fn version(&self) -> (u32, u32, u32);
15
16    /* auto impls */
17
18    /// Returns the service version string.
19    // IMPROVE: Use StringU8<16>
20    #[cfg(feature = "alloc")]
21    #[cfg_attr(feature = "nightly_doc", doc(cfg(feature = "alloc")))]
22    fn version_string(&self) -> crate::String {
23        let v = self.version();
24        crate::format!["v{}.{}.{}", v.0, v.1, v.2]
25    }
26}