Struct Rating 

#[non_exhaustive]
pub struct Rating {
    pub rating_count: i32,
    pub average_rating: f32,
    pub rating_histogram: Vec<i32>,
    /* private fields */
}

The rating of a Product.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

rating_count: i32

The total number of ratings. This value is independent of the value of rating_histogram.

This value must be nonnegative. Otherwise, an INVALID_ARGUMENT error is returned.

average_rating: f32

The average rating of the Product.

The rating is scaled at 1-5. Otherwise, an INVALID_ARGUMENT error is returned.

rating_histogram: Vec<i32>

List of rating counts per rating value (index = rating - 1). The list is empty if there is no rating. If the list is non-empty, its size is always 5. Otherwise, an INVALID_ARGUMENT error is returned.

For example, [41, 14, 13, 47, 303]. It means that the Product got 41 ratings with 1 star, 14 ratings with 2 star, and so on.

Implementations

impl Rating

pub fn new() -> Self

Creates a new default instance.

pub fn set_rating_count<T: Into<i32>>(self, v: T) -> Self

Sets the value of rating_count.

Example

let x = Rating::new().set_rating_count(42);

pub fn set_average_rating<T: Into<f32>>(self, v: T) -> Self

Sets the value of average_rating.

Example

let x = Rating::new().set_average_rating(42.0);

pub fn set_rating_histogram<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<i32>,

Sets the value of rating_histogram.

Example

let x = Rating::new().set_rating_histogram([1, 2, 3]);

Trait Implementations

impl Clone for Rating

fn clone(&self) -> Rating

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Rating

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

Formats the value using the given formatter.

impl Default for Rating

fn default() -> Rating

Returns the “default value” for a type.

impl Message for Rating

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Rating

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Rating