Struct omaha_client::protocol::Cohort

pub struct Cohort {
    pub id: Option<String>,
    pub hint: Option<String>,
    pub name: Option<String>,
}

The cohort identifies the update ‘track’ or ‘channel’, and is used to implement the tracking of membership in a fractional roll-out. This is per-application data.

This is sent to Omaha to identify the cohort that the application is in. This is returned (with possibly new values) by Omaha to indicate that the application is now in a different cohort. On the next update check for that application, the updater needs to use this newly returned cohort as the one that it sends to Omaha with that application.

For more information about cohorts, see the ‘cohort’, ‘cohorthint’, and ‘cohortname’ attributes of the Request.App object at:

https://github.com/google/omaha/blob/HEAD/doc/ServerProtocolV3.md#app-request

Fields

id: Option<String>

This is the cohort id itself.

hint: Option<String>

name: Option<String>

Implementations

impl Cohort

pub fn new(id: &str) -> Cohort

Create a new Cohort instance from just a cohort id (channel name).

pub fn from_hint(hint: &str) -> Cohort

pub fn update_from_omaha(&mut self, omaha_cohort: Self)

pub fn validate_name(name: &str) -> bool

A validation function to test that a given Cohort hint or name is valid per the Omaha spec: 1-1024 ascii characters, with values in the range [\u20-\u7e].

Trait Implementations

impl Clone for Cohort

fn clone(&self) -> Cohort

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Cohort

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

Formats the value using the given formatter.

impl Default for Cohort

fn default() -> Cohort

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Cohort

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Cohort

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Cohort

impl StructuralPartialEq for Cohort