Struct ProtocolSpecV1 

pub struct ProtocolSpecV1 {

    pub schema: String,
    pub name: String,
    pub version: String,
    pub description: Option<String>,
    pub handler_abi: Option<String>,
    pub ctx_version: Option<String>,
    pub programs: BTreeMap<String, ProtocolProgramV1>,
    pub stacks: BTreeMap<String, ProtocolStackDependencyV1>,
    pub params: ObjectSchemaV1,
    pub roles: BTreeMap<String, RoleV1>,
    pub resources: BTreeMap<String, ResourceDeclV1>,
    pub instance_visibility: InstanceVisibility,
    pub reads: BTreeMap<String, ReadV1>,
    pub machines: MachinesV1,
    pub steps: BTreeMap<String, StepV1>,
    pub reactions: Vec<ReactionV1>,
    pub events: BTreeMap<String, EventV1>,
    pub metadata: MetadataV1,
    pub stack: StackSurfaceV1,
}

Fields

schema: String

name: String

version: String

description: Option<String>

handler_abi: Option<String>

ctx_version: Option<String>

programs: BTreeMap<String, ProtocolProgramV1>

stacks: BTreeMap<String, ProtocolStackDependencyV1>

params: ObjectSchemaV1

roles: BTreeMap<String, RoleV1>

resources: BTreeMap<String, ResourceDeclV1>

instance_visibility: InstanceVisibility

reads: BTreeMap<String, ReadV1>

machines: MachinesV1

steps: BTreeMap<String, StepV1>

reactions: Vec<ReactionV1>

events: BTreeMap<String, EventV1>

metadata: MetadataV1

stack: StackSurfaceV1

Implementations

impl ProtocolSpecV1

pub fn hash(&self) -> Result<HashId<ProtocolSpec>, HashError>

pub fn has_handlers(&self) -> bool

pub fn create_step(&self) -> Option<(&String, &StepV1)>

pub fn effective_access( &self, step: &str, narrowed_to_secret: bool, ) -> Option<StepAccess>

The step’s effective access for an integrator that narrowed it, or None for steps no client can call.

pub fn machine(&self, kind: MachineKind) -> Option<&MachineV1>

Trait Implementations

impl Clone for ProtocolSpecV1

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProtocolSpecV1

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProtocolSpecV1

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ProtocolSpecV1

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for ProtocolSpecV1

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ProtocolSpecV1