Enum StartReason 

pub enum StartReason {
    Process,
    Resume,
    Clear,
    Join,
    Other,
}

Why a session_started record is there (01M3X9X9M079WGFPJZHNXH9VEP). A start call sends process, resume or clear.

Reason	Meaning	A fresh context
process	A new agent process.	Yes
resume	The agent process resumed an old conversation.	No
clear	The agent cleared its context.	Yes
join	The session came with no new start: a register.	No
other	A reason that this build does not know.	No

use riff_core::wire::StartReason;

let read = |json: &str| serde_json::from_str::<StartReason>(json).unwrap();
assert_eq!(read(r#""process""#), StartReason::Process);
assert_eq!(read(r#""wake""#), StartReason::Other);
// A reason of a later build can have each form of JSON.
for later in [r#"{"wake":"timer"}"#, "7", "null", r#"["clear"]"#] {
    assert_eq!(read(later), StartReason::Other, "{later}");
}
assert!(StartReason::Clear.is_fresh() && StartReason::Process.is_fresh());
assert!(!StartReason::Resume.is_fresh() && !StartReason::Join.is_fresh());
assert!(StartReason::Resume.is_start() && !StartReason::Join.is_start());
assert_eq!(StartReason::Clear.word(), "clear");

Variants

Process

Resume

Clear

Join

Other

A reason that this build does not know.

Implementations

impl StartReason

pub fn is_fresh(self) -> bool

True for a start with a fresh context: it ends MustClear.

pub fn is_start(self) -> bool

True for a reason that a start call can have.

pub fn word(self) -> &'static str

The word of the reason, as the JSON has it.

Trait Implementations

impl Clone for StartReason

fn clone(&self) -> StartReason

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StartReason

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StartReason

The set of reasons can grow. A build reads each value that it does not know as StartReason::Other: a text, and each other form of JSON (01M3XM2C18TT8VSKGD77YPZG53).

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl JsonSchema for StartReason

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for StartReason

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for StartReason

impl Eq for StartReason

impl StructuralPartialEq for StartReason