Struct SetStep 

pub struct SetStep {
    pub me: SessionUri,
    pub change: StepChange,
}

POST /v1/step: a change of the long step of me (01M48VDGTD40P8RBZMS0XB5M9N). It is a signal, and a sign of life. riff step fail also wakes the lead (01M48VDS663X064YS5ZGCCZSTB).

use riff_core::wire::{SetStep, StepChange};

let me: riff_core::name::SessionUri = "riff://mike@pangolin/o/r?session=a1".parse()?;
let set = |change| SetStep { me: me.clone(), change };
assert!(set(StepChange::Start { name: "live window".into() }).check().is_ok());
assert!(set(StepChange::Done).check().is_ok());
assert_eq!(
    set(StepChange::Fail { reason: " ".into() }).check().unwrap_err(),
    "the reason is empty"
);
assert_eq!(
    set(StepChange::Start { name: "a\nb".into() }).check().unwrap_err(),
    "the name must be one line"
);

Fields

me: SessionUri

change: StepChange

Implementations

impl SetStep

pub fn check(&self) -> Result<(), String>

Refuses a name or a reason that is not one line of at most STATUS_CHARS characters.

Trait Implementations

impl Call for SetStep

const PATH: &'static str = "/v1/step"

The HTTP path of the call, for example /v1/claim.

type Reply = ()

The reply to the call.

impl Clone for SetStep

fn clone(&self) -> SetStep

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SetStep

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SetStep

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for SetStep

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 Serialize for SetStep

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

where __S: Serializer,

Serialize this value into the given Serde serializer.