Struct StatePin 

#[non_exhaustive]
pub struct StatePin {
    pub resource: StatePinResource,
    pub version: StatePinVersion,
}

Available on crate feature task-consent only.

The prior state the effects were computed against. A human in the loop makes the approval window minutes wide, so the state can move underneath a pending approval. The executor asserts this pin still holds at execution and refuses otherwise — without it, a lost update silently executes against state the approver never saw.

JSON schema

{
 "title": "StatePin",
 "description": "The prior state the effects were computed against. A human in the loop makes the approval window minutes wide, so the state can move underneath a pending approval. The executor asserts this pin still holds at execution and refuses otherwise — without it, a lost update silently executes against state the approver never saw.",
 "type": "object",
 "required": [
   "resource",
   "version"
 ],
 "properties": {
   "resource": {
     "description": "Identifier of the pinned resource (usually the subject DID).",
     "type": "string",
     "minLength": 1
   },
   "version": {
     "description": "Opaque version identifier of the prior state (e.g. a did:webvh `versionId`). Compared for equality at execution; the executor MUST NOT attempt to order or interpret it.",
     "type": "string",
     "minLength": 1
   }
 },
 "additionalProperties": false
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

resource: StatePinResource

Identifier of the pinned resource (usually the subject DID).

version: StatePinVersion

Opaque version identifier of the prior state (e.g. a did:webvh versionId). Compared for equality at execution; the executor MUST NOT attempt to order or interpret it.

Implementations

impl StatePin

pub fn builder() -> StatePin

Trait Implementations

impl Clone for StatePin

fn clone(&self) -> StatePin

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StatePin

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StatePin

fn deserialize<__D>( __deserializer: __D, ) -> Result<StatePin, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<StatePin> for StatePin

fn from(value: StatePin) -> StatePin

Converts to this type from the input type.

impl Serialize for StatePin

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<StatePin> for StatePin

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: StatePin) -> Result<StatePin, ConversionError>

Performs the conversion.