Struct omaha_client::common::App

source ·
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>,
}
Expand description

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§

source§

impl App

source

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.

source§

impl App

source

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

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

source

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().

source

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.

source

pub fn get_target_channel(&self) -> &str

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

source

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

Set the cohort hint to |channel|.

source

pub fn valid(&self) -> bool

Trait Implementations§

source§

impl Clone for App

source§

fn clone(&self) -> App

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for App

source§

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

Formats the value using the given formatter. Read more
source§

impl From<&App> for PersistedApp

source§

fn from(app: &App) -> Self

Converts to this type from the input type.
source§

impl PartialEq for App

source§

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

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

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.
source§

impl Eq for App

source§

impl StructuralPartialEq for App

Auto Trait Implementations§

§

impl RefUnwindSafe for App

§

impl Send for App

§

impl Sync for App

§

impl Unpin for App

§

impl UnwindSafe for App

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> Unless for T

source§

fn unless(self, option: Option<T>) -> T

§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more