Struct omaha_client::common::App

pub struct App {
    pub id: String,
    pub version: Version,
    pub fingerprint: Option<String>,
    pub cohort: Cohort,
    pub user_counting: UserCounting,
    pub extra_fields: HashMap<String, String>,
}

The App struct holds information about an application to perform an update check for.

Fields

id: String

This is the app_id that Omaha uses to identify a given application.

version: Version

This is the current version of the application.

fingerprint: Option<String>

This is the fingerprint for the application package.

See https://github.com/google/omaha/blob/HEAD/doc/ServerProtocolV3.md#packages–fingerprints

cohort: Cohort

The app’s current cohort information (cohort id, hint, etc). This is both provided to Omaha as well as returned by Omaha.

user_counting: UserCounting

The app’s current user-counting information. This is both provided to Omaha as well as returned by Omaha.

extra_fields: HashMap<String, String>

Extra fields to include in requests to Omaha. The client library does not inspect or operate on these, it just sends them to the service as part of the “app” objects in each request.

Implementations

impl App

pub fn builder() -> AppBuilder<((), (), (), (), (), ())>

Create a builder for building App. On the builder, call .id(...), .version(...), .fingerprint(...)(optional), .cohort(...)(optional), .user_counting(...)(optional), .extra_fields(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of App.

impl App

pub async fn load<'a>(&'a mut self, storage: &'a impl Storage)

Load data from |storage|, only overwrite existing fields if data exists.

pub async fn persist<'a>(&'a self, storage: &'a mut impl Storage)

Persist cohort and user counting to |storage|, will try to set all of them to storage even if previous set fails. It will NOT call commit() on |storage|, caller is responsible to call commit().

pub fn get_current_channel(&self) -> &str

Get the current channel name from cohort name, returns empty string if no cohort name set for the app.

pub fn get_target_channel(&self) -> &str

Get the target channel name from cohort hint, fallback to current channel if no hint.

pub fn set_target_channel( &mut self, channel: Option<String>, id: Option<String> )

Set the cohort hint to |channel|.

pub fn valid(&self) -> bool

Trait Implementations

impl Clone for App

fn clone(&self) -> App

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for App

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

Formats the value using the given formatter.

impl From<&App> for PersistedApp

fn from(app: &App) -> Self

Converts to this type from the input type.

impl PartialEq for App

fn eq(&self, other: &App) -> 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 Eq for App

impl StructuralPartialEq for App