Struct version_history_shared::VersionHistory

pub struct VersionHistory { /* private fields */ }

VersionHistory stores the history of Fuchsia API levels, and lets callers query the support status of API levels and ABI revisions.

Implementations

impl VersionHistory

pub const fn new(versions: &'static [Version]) -> Self

Outside of tests, callers should use the static [HISTORY] instance. However, for testing purposes, you may want to build your own hermetic “alternate history” that doesn’t change over time.

If you’re not testing versioning in particular, and you just want an API level/ABI revision that works, see [get_example_supported_version_for_tests].

pub fn get_abi_revision_for_platform_components(&self) -> AbiRevision

The ABI revision for components and packages that are “part of the platform” and never “move between releases”. For example:

• Packages produced by the platform build have this ABI revision.
• Components which are not packaged but are “part of the platform” nonetheless (e.g. components loaded from bootfs) have this ABI revision.
• Most packages produced by assembly tools have this ABI revision.
  • The update package is a noteworthy exception, since it “moves between releases”, in that it is produced by assembly tools from one Fuchsia release, and then later read by the OS from a previous release (that is, the one performing the update).

pub fn get_misleading_version_for_ffx(&self) -> Version

ffx currently presents information suggesting that the platform supports a single API level and ABI revision. This is misleading and should be fixed. Until we do, we have to choose a particular Version for ffx to present.

TODO: https://fxbug.dev/326096999 - Remove this, or turn it into something that makes more sense.

pub fn get_example_supported_version_for_tests(&self) -> Version

API level to be used in tests that create components on the fly and need to specify a supported API level or ABI revision, but don’t particularly care which. The returned Version will be consistent within a given build, but may change from build to build.

pub fn check_api_level_for_build( &self, api_level: ApiLevel ) -> Result<AbiRevision, ApiLevelError>

Check whether the platform supports building components that target the given API level, and if so, returns the ABI revision associated with that API level.

TODO: https://fxbug.dev/326096347 - This doesn’t actually check that the API level is supported, merely that it exists. At time of writing, this is the behavior implemented by ffx package, so I’m keeping it consistent in the interest of no-op refactoring.

pub fn check_abi_revision_for_runtime( &self, abi_revision: AbiRevision ) -> Result<(), AbiRevisionError>

Check whether the operating system supports running components that target the given ABI revision.

pub fn version_from_api_level(&self, api_level: ApiLevel) -> Option<Version>

Trait Implementations

impl Debug for VersionHistory

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for VersionHistory

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for VersionHistory

fn cmp(&self, other: &VersionHistory) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for VersionHistory

fn eq(&self, other: &VersionHistory) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for VersionHistory

fn partial_cmp(&self, other: &VersionHistory) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for VersionHistory

impl StructuralPartialEq for VersionHistory