Struct brawl_api::time::TimeLike

pub struct TimeLike(_);

Represents a timestamp provided by the Brawl API. If the chrono feature is enabled (it is by default), then it is possible to use helper methods to convert it to chrono data structures - see TimeLike.parse (this is recommended, as it is aware of the correct format).

Methods

impl TimeLike

pub fn parse(&self) -> Result<DateTime<Utc>>

Parses this timestamp into a chrono::DateTime<chrono::Utc>, using the API's format (see constants::TIMELIKE_FORMAT).

Errors

If the string is invalid, an Error::ParseTimeLike is returned. Generally, when requesting from the API, this shouldn't ever happen.

Examples

use brawl_api::prelude::*;
use brawl_api::{TimeLike, Battle};
use chrono::{DateTime, Utc};


// after obtaining a fetched battlelog's battle
let battle: Battle;

let mut the_time: TimeLike = battle.battle_time;
let parsed_time: DateTime<Utc> = the_time.parse()?;
// the parsed time of the battle is now available for use.

impl TimeLike

pub fn inner(&self) -> &String

Returns an immutable reference to the inner string.

pub fn inner_mut(&mut self) -> &mut String

Returns a mutable reference to the inner string.

Trait Implementations

impl Clone for TimeLike

fn clone(&self) -> TimeLike

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TimeLike

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

Formats the value using the given formatter.

impl Default for TimeLike

fn default() -> TimeLike

Returns an initial TimeLike instance containing an empty string.

Examples

use brawl_api::TimeLike;

assert_eq!(
    TimeLike::default().to_string(),
    "",
)

impl<'de> Deserialize<'de> for TimeLike

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for TimeLike

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

Displays the inner string of the TimeLike instance.

impl Eq for TimeLike

impl Hash for TimeLike

fn hash<__H: Hasher>(&self, state: &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<TimeLike> for TimeLike

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

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

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

This method tests for !=.

impl Serialize for TimeLike

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

Serialize this value into the given Serde serializer.

impl StructuralEq for TimeLike

impl StructuralPartialEq for TimeLike