Struct Progress 

pub struct Progress<S: BosStr = DefaultStr> {
    pub created_at: Datetime,
    pub level: i64,
    pub progress_percentage: Option<S>,
    pub signature: ChronicleSignature<S>,
    pub total_xp: i64,
    pub trigger_source: Option<S>,
    pub updated_at: Option<Datetime>,
    pub xp_gained_since_last_sign: Option<i64>,
    pub xp_to_next_level: Option<i64>,
    pub extra_data: Option<BTreeMap<SmolStr, Data<S>>>,
}

Signed player progression state. Singleton (rkey: self), overwritten via putRecord. Backend validates XP claims before signing.

Fields

created_at: Datetime

When the record was first created

level: i64

Current player level (derived from XP table)

progress_percentage: Option<S>

Progress toward next level as decimal string

signature: ChronicleSignature<S>

total_xp: i64

Total accumulated XP

trigger_source: Option<S>

What triggered this save (level_up, session_end, visibility_hidden, periodic, card_advance)

updated_at: Option<Datetime>

When the record was last updated

xp_gained_since_last_sign: Option<i64>

XP gained since the last signed progress record (for rate validation against daily activity)

xp_to_next_level: Option<i64>

XP remaining to reach next level

extra_data: Option<BTreeMap<SmolStr, Data<S>>>

Implementations

impl<S: BosStr> Progress<S>

pub fn uri(uri: S) -> Result<RecordUri<S, ProgressRecord>, UriError>

impl Progress<DefaultStr>

pub fn new() -> ProgressBuilder<Empty, DefaultStr>

Create a new builder for this type, using the default string type (DefaultStr = SmolStr) if needed

impl<S: BosStr> Progress<S>

pub fn builder() -> ProgressBuilder<Empty, S>

Create a new builder for this type

Trait Implementations

impl<S: Clone + BosStr> Clone for Progress<S>

fn clone(&self) -> Progress<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: BosStr> Collection for Progress<S>

const NSID: &'static str = "net.anisota.chronicle.progress"

The NSID for the Lexicon that defines the schema of records in this collection.

type Record = ProgressRecord

A marker type implementing XrpcResp that allows typed deserialization of records from this collection. Used by AgentSessionExt::get_record to return properly typed responses.

fn nsid() -> Nsid<&'static str>

Returns the Nsid for the Lexicon that defines the schema of records in this collection.

fn repo_path<T>(rkey: &RecordKey<T>) -> RepoPath<&str>

where T: RecordKeyType + Bos<str> + AsRef<str>,

Returns the repo path for a record in this collection with the given record key.

impl<S: Debug + BosStr> Debug for Progress<S>

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

Formats the value using the given formatter.

impl<'de, S> Deserialize<'de> for Progress<S>

where S: Deserialize<'de> + BosStr,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<S: Eq + BosStr> Eq for Progress<S>

impl<S: BosStr> From<ProgressGetRecordOutput<S>> for Progress<S>

fn from(output: ProgressGetRecordOutput<S>) -> Self

Converts to this type from the input type.

impl<S: BosStr + IntoStatic> IntoStatic for Progress<S>

where <S as IntoStatic>::Output: BosStr,

type Output = Progress<<S as IntoStatic>::Output>

The “owned” variant of the type. For Cow<'a, str>, this is Cow<'static, str>, for example.

fn into_static(self) -> Self::Output

Turns the value into an “owned” variant, which can then be returned, moved, etc.

impl<S: BosStr> LexiconSchema for Progress<S>

fn nsid() -> &'static str

The NSID for this type’s primary definition

fn def_name() -> &'static str

The definition name within the lexicon document

fn lexicon_doc() -> LexiconDoc<'static>

Generate the lexicon document for this type

fn validate(&self) -> Result<(), ConstraintError>

Validate an instance against lexicon constraints

fn schema_id() -> CowStr<'static>

The schema ID for this type

fn inline_schema() -> bool

Whether this type should be inlined vs referenced

impl<S: PartialEq + BosStr> PartialEq for Progress<S>

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

where S: Serialize + BosStr,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<S: PartialEq + BosStr> StructuralPartialEq for Progress<S>