stoat-rs 0.2.5

Stoat API Wrapper
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

use std::{ops::Deref, time::SystemTime};

use crate::{Error, Identifiable, Result};

/// Wrapper around a ULID string, the ID format used for Stoat models.
pub struct Ulid(String);

impl Ulid {
    /// Verifies the input is a valid ULID and creates an instance of [`Ulid`].
    pub fn from_string(id: String) -> Result<Self> {
        if ulid::Ulid::from_string(&id).is_err() {
            return Err(Error::MalformedID);
        };

        Ok(Self(id))
    }

    /// Creates an instance of [`Ulid`] **_without verifying it is valid_**.
    ///
    /// Do not use this function unless you already know the input is valid.
    pub fn from_string_unchecked(id: String) -> Self {
        Self(id)
    }

    /// Returns the stored timestamp of when the ID was created.
    pub fn timestamp(&self) -> SystemTime {
        ulid::Ulid::from_string(&self.0).unwrap().datetime()
    }

    pub fn as_str(&self) -> &str {
        &self.0
    }

    pub fn to_string(self) -> String {
        self.0
    }
}

impl Deref for Ulid {
    type Target = String;

    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl Identifiable for Ulid {
    fn id(&self) -> &str {
        &self.0
    }
}

impl TryFrom<String> for Ulid {
    type Error = Error;

    fn try_from(value: String) -> Result<Self> {
        Ulid::from_string(value)
    }
}