alpm_common/traits/
schema.rs

1//! Traits for schemas.
2
3#[cfg(doc)]
4use std::str::FromStr;
5use std::{io::Read, path::Path};
6
7use alpm_types::SchemaVersion;
8
9/// A trait for file format schemas and their versioning.
10///
11/// File formats are expected to either expose the schema version directly, or at least make it
12/// possible to derive the version from them.
13pub trait FileFormatSchema {
14    /// The Error type to use.
15    type Err;
16
17    /// Returns the reference to an inner [`SchemaVersion`].
18    fn inner(&self) -> &SchemaVersion;
19
20    /// Derives [`Self`] from a `file`.
21    ///
22    /// # Note
23    ///
24    /// This function is meant for implementers to _derive_ [`Self`] based on the properties of the
25    /// `file` contents (e.g. a context-specific version identifier, etc.).
26    /// Instead of creating [`Self`] from considering all of `file`, this function is only used to
27    /// introspect `file` and to retrieve required information to _derive_ which variant of
28    /// [`Self`] to create or whether to fail.
29    fn derive_from_file(file: impl AsRef<Path>) -> Result<Self, Self::Err>
30    where
31        Self: Sized;
32
33    /// Derives [`Self`] from a [`Read`] implementer.
34    ///
35    /// # Note
36    ///
37    /// This function is meant for implementers to _derive_ [`Self`] based on the properties of the
38    /// `reader` contents (e.g. a context-specific version identifier, etc.).
39    /// Instead of creating [`Self`] from considering all of `reader`, this function is only used to
40    /// introspect `reader` and to retrieve required information to _derive_ which variant of
41    /// [`Self`] to create or whether to fail.
42    fn derive_from_reader(reader: impl Read) -> Result<Self, Self::Err>
43    where
44        Self: Sized;
45
46    /// Derives [`Self`] from a string slice `s`.
47    ///
48    /// # Note
49    ///
50    /// This function is meant for implementers to _derive_ [`Self`] based on the
51    /// properties of `s` (e.g. a context-specific version identifier, etc.).
52    /// Instead of creating [`Self`] from considering all of `s`, this function is only used to
53    /// introspect `s` and to retrieve required information to _derive_ which variant of [`Self`] to
54    /// create or whether to fail.
55    ///
56    /// For _creation_ from the entire string slice the [`FromStr`] trait should be implemented
57    /// instead.
58    fn derive_from_str(s: &str) -> Result<Self, Self::Err>
59    where
60        Self: Sized;
61}
alpm_common/traits/schema.rs

alpm_common/traits/
schema.rs
