Struct poke_a_mango::ops::Leader

pub struct Leader {
    pub name: String,
    pub time: DateTime<FixedOffset>,
    pub score: u64,
}

A leaderboard entry.

Examples

Reading a leaderboard, adding an entry to it, then writing it back.

let tf = temp_dir().join("poke-a-mango-doctest").join("ops-Leader-0");
create_dir_all(&tf).unwrap();

let tf = tf.join("leaderboard.toml");
File::create(&tf).unwrap();

let mut leaders = Leader::read(&tf).unwrap();
assert!(leaders.is_empty());
leaders.push(Leader::now("nabijaczleweli".to_string(), 105));
assert_eq!(Leader::write(leaders, &tf), Ok(()));

This could alternatively be done with Leader::append().

Fields

name: String

Name the user entered when prompted.

time: DateTime<FixedOffset>

Time the score was achieved.

score: u64

User's score.

Methods

impl Leader

pub fn now(name: String, score: u64) -> Leader

Create a new leaderboard entry with time set to now.

Examples

let ldr = Leader::now("nabijaczleweli".to_string(), 36);
assert_eq!(ldr.name, "nabijaczleweli");
assert_eq!(ldr.score, 36);

pub fn read(p: &Path) -> Result<Vec<Leader>, Error>

Read leaderboard from the specified file.

If the specified file doesn't exist an empty leaderboard is returned.

Examples

let tf = temp_dir().join("poke-a-mango-doctest").join("ops-Leader-read-0");
create_dir_all(&tf).unwrap();

let tf = tf.join("leaderboard.toml");
File::create(&tf).unwrap();

assert_eq!(Leader::read(&tf), Ok(vec![]));

pub fn write(queued_leaders: Vec<Leader>, p: &Path) -> Result<(), Error>

Save leaderboard to the specified file.

Examples

let tf = temp_dir().join("poke-a-mango-doctest").join("ops-Leader-write-0");
create_dir_all(&tf).unwrap();

Leader::write(vec![Leader::now("nabijaczleweli".to_string(), 105),
                   Leader::now("skorezore".to_string(), 51)],
              &tf.join("leaderboard.toml"))
    .unwrap();

pub fn append(ldr: Leader, p: &Path) -> Result<(), Error>

Append the specified leader to the leaderboard file at the specified path.

This is equivalent to reading it, appending the leader, properly sorting and writing it back.

Examples

let tf = temp_dir().join("poke-a-mango-doctest").join("ops-Leader-append-0");
create_dir_all(&tf).unwrap();

assert_eq!(Leader::append(Leader::now("nabijaczleweli".to_string(), 105), &tf.join("leaderboard.toml")), Ok(()));

Trait Implementations

impl Debug for Leader

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Clone for Leader

fn clone(&self) -> Leader

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Hash for Leader

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl PartialEq for Leader

fn eq(&self, __arg_0: &Leader) -> bool

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

fn ne(&self, __arg_0: &Leader) -> bool

This method tests for !=.

impl Eq for Leader

impl Encodable for Leader

fn encode<__S: Encoder>(&self, __arg_0: &mut __S) -> Result<(), __S::Error>

Serialize a value using an Encoder.

impl Decodable for Leader

fn decode<__D: Decoder>(__arg_0: &mut __D) -> Result<Leader, __D::Error>

Deserialize a value using a Decoder.

impl Ord for Leader

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

impl PartialOrd for Leader

fn partial_cmp(&self, other: &Self) -> 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.