Struct ProcedureDecl 

#[non_exhaustive]
pub struct ProcedureDecl {

    pub path: String,
    pub kind: Option<Declared<ProcedureKind>>,
    pub reply: Option<String>,
    pub request: Option<String>,
    pub encoding: Option<WireEncoding>,
    pub fanout: Option<Declared<Fanout>>,
    pub idempotent: Option<bool>,
    pub cardinality: Option<i64>,
    pub when: Option<Vec<Predicate>>,
    pub gate_note: Option<String>,
    pub exposure: Option<Declared<Exposure>>,
    pub sensitive: Option<bool>,
    pub since: Option<String>,
    pub description: Option<String>,
}

One [[procedure]] entry of a served registry slice. #[non_exhaustive]: every version of this type so far has been the previous one plus a field (encoding v1.5, blob v1.8, media v1.16), and each of those was a breaking change for anyone constructing one. It is a parse result, not a thing callers build — parse_slice is the constructor — so the attribute costs the intended use nothing and stops the next field being a break (#325).

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.

path: String

The procedure path, base-relative to the producer’s @rpc root.

kind: Option<Declared<ProcedureKind>>

read | write (RFC 05 §2).

reply: Option<String>

request: Option<String>

The declared request type name, when declared.

encoding: Option<WireEncoding>

The declared payload encoding (RFC 08 §2, v1.5).

fanout: Option<Declared<Fanout>>

"forbidden" forbids *-origin fan-out calls (RFC 05 §2.1); absent means unconstrained. Surfaced in the slice since 0.5 so dynamic callers (explorers) can refuse what generated builders make unspellable — the registry layer of the three-layer refusal.

idempotent: Option<bool>

Whether the procedure declares itself idempotent (RFC 08 §2).

cardinality: Option<i64>

The declared key-population bound of a {var}-bearing path, when declared (RFC 08 §2 — required there, optional here: this type reads foreign slices, and the strict check belongs to that build’s own zenkey-build).

when: Option<Vec<Predicate>>

The conditions under which this procedure can do its work, ANDed (RFC 08 §2, v1.35). It is declared regardless, and answers error/unsupported or error/gated — PredicateKind::gated_error — while a predicate is false (§6.1).

gate_note: Option<String>

One line for the human, present only with when.

exposure: Option<Declared<Exposure>>

How far the procedure may travel (RFC 08 §2, v1.43), when declared; absent means Exposure::Fleet.

sensitive: Option<bool>

The request carries a secret (RFC 08 §2, v1.43): a generated ACL denies the procedure to every principal until a grant names it.

since: Option<String>

description: Option<String>

Implementations

impl ProcedureDecl

pub fn new(path: impl Into<String>) -> Self

A procedure declaration with its one required column.

Trait Implementations

impl Clone for ProcedureDecl

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 ProcedureDecl

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

Formats the value using the given formatter.

impl Eq for ProcedureDecl

impl PartialEq for ProcedureDecl

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ProcedureDecl