Skip to main content

Requirement

Enum Requirement 

Source
pub enum Requirement {
    MailRelay,
    CeremonyPage(Ceremony),
    PaymentsProxy,
}
Expand description

A deployment prerequisite a built-in’s calls depend on.

A closed, exhaustively matchable taxonomy of the STATIC, versioned facts a built-in family needs configured before any call of its own can do anything, sibling to ToolOrigin in the same “static shape of the built-in surface” sense. Carries only the fact, never remedy text: the copy a person reads about a missing prerequisite belongs to the surface that renders it (an approval card, a status tool), not to this taxonomy.

Extending the taxonomy means adding a variant here and teaching polyc_tools::capability::builtin_requirements (crates/tools) which built-ins need it, and DeploymentCapabilities::is_viable which deployment fact answers it — the harness’s builtin_surface_guard fails closed if either side is left out (a requirement no built-in resolves to, or a built-in a requirement can’t classify).

Variants§

§

MailRelay

A usable outbound mail relay (credentials/token valid, not merely a relay URL set — a missing URL alone falls back to a hosted default). link_email needs this to actually deliver a verification message.

§

CeremonyPage(Ceremony)

A configured browser-facing ceremony page — see Ceremony.

§

PaymentsProxy

The outbound-payments proxy: a settlement currency and a way to sign (a deployment env signer or a caller’s own delegated wallet key). paid_fetch needs this to ever send a payment.

Implementations§

Source§

impl Requirement

Source

pub const ALL: [Self; 4]

Every concrete Requirement value, in declaration order — the enumeration DeploymentCapabilities::viable_names and Self::from_name iterate over, and the harness guard’s dead-variant check walks.

Source

pub const fn as_str(self) -> &'static str

Stable kebab-case name, used on the wire (TurnInput.viable_requirements) and as a telemetry label. Inverse of Self::from_name.

Source

pub fn from_name(name: &str) -> Option<Self>

Parse a stable kebab-case name; None for anything unrecognized so a caller reading the wire fails toward treating the requirement as unmet rather than guessing.

Trait Implementations§

Source§

impl Clone for Requirement

Source§

fn clone(&self) -> Requirement

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Requirement

Source§

impl Debug for Requirement

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Requirement

Source§

impl Hash for Requirement

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for Requirement

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Requirement

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more