Enum Kind 

pub enum Kind {
    Message,
    Status,
    Note,
    Riff,
    Other,
}

The kind of a post. A post call sends message, status or note.

use riff_core::wire::Kind;

assert_eq!(serde_json::to_string(&Kind::Status).unwrap(), r#""status""#);
assert_eq!("status".parse::<Kind>(), Ok(Kind::Status));
assert_eq!(serde_json::to_string(&Kind::Note).unwrap(), r#""note""#);
assert_eq!("note".parse::<Kind>(), Ok(Kind::Note));
assert!("other".parse::<Kind>().is_err());
assert!(Kind::Note.needs_body() && !Kind::Status.needs_body());

Variants

Message

A message to read.

Status

A status request. Each session that it wakes sets its status with status. It does not post a reply.

Note

A note: it informs and wakes no session. A session sees it at its next read (01M3JPMQE6S7YM4HPEVGXWK7ET).

Riff

A message that riff itself writes, as the person of the riff: the watch of a deploy, the daemon, the lines of riff release. It reads and wakes as a message. It never counts as the word of a person (Kind::by_riff). A session has no use for it, so a schema of a call does not list it.

Other

A kind that this build does not know. A reader shows the post as a message.

Implementations

impl Kind

pub fn is_message(&self) -> bool

pub fn by_riff(&self) -> bool

True for the kind of a line that riff writes, not a person: Kind::Riff.

use riff_core::wire::Kind;

assert!(Kind::Riff.by_riff());
assert!(![Kind::Message, Kind::Status, Kind::Note, Kind::Other].iter().any(Kind::by_riff));

pub fn needs_body(&self) -> bool

True when a post of this kind needs a body. Only a status request needs none.

pub fn is_post(&self) -> bool

True for a kind that a post call can have. A kind of a later build reads as Kind::Other, and no post call can have it (01M3XSF90E9JYYTC13D9THY4WE).

use riff_core::wire::Kind;

let read = |json: &str| serde_json::from_str::<Kind>(json).unwrap();
assert_eq!(read(r#""note""#), Kind::Note);
// The kind of a line of riff has a name in JSON, and none for a person.
assert_eq!(read(r#""riff""#), Kind::Riff);
assert_eq!(serde_json::to_string(&Kind::Riff).unwrap(), r#""riff""#);
assert!("riff".parse::<Kind>().is_err());
// A kind of a later build can have each form of JSON.
for later in [r#""poll""#, r#"{"poll":"wave"}"#, "7", "null"] {
    assert_eq!(read(later), Kind::Other, "{later}");
}
assert!(Kind::Note.is_post() && Kind::Riff.is_post() && !Kind::Other.is_post());
assert_eq!(serde_json::to_string(&Kind::Other).unwrap(), r#""other""#);

// The schema of a call has only the kinds of a `post` call.
let schema = serde_json::to_value(schemars::schema_for!(Kind)).unwrap();
let kinds: Vec<&str> = schema["oneOf"]
    .as_array()
    .unwrap()
    .iter()
    .map(|kind| kind["const"].as_str().unwrap())
    .collect();
assert_eq!(kinds, ["message", "status", "note"]);

Trait Implementations

impl Clone for Kind

fn clone(&self) -> Kind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Kind

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

Formats the value using the given formatter.

impl Default for Kind

fn default() -> Kind

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Kind

The set of kinds can grow. A build reads each value that it does not know as Kind::Other: a text, and each other form of JSON (01M3XSF90E9JYYTC13D9THY4WE). The kind Kind::Riff has a name in JSON but not in FromStr: a person types no such kind.

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

Deserialize this value from the given Serde deserializer.

impl FromStr for Kind

type Err = String

The associated error which can be returned from parsing.

fn from_str(text: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl JsonSchema for Kind

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 Kind

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

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 Kind

impl Eq for Kind

impl StructuralPartialEq for Kind