Enum RuleId 

pub enum RuleId {
    FragmentNamesTheVenueForm,
    CleanRemovesOnlyANamedLeftover,
    EveryPairCarriesAVerdict,
    OneTargetRunsOneMechanism,
    StatusReportsAndNeverJudges,
    TheOperatorCallerReportsEveryOutcome,
    ThePinMovesInOneTransaction,
    TheShellEntryCallerIsRateLimitedAndSilent,
    TheSyncLeavesADiffNobodyCommitted,
    TheToolServesAndDoesNotEdit,
    RecordedDimensionOnlyShrinks,
    DebtIsCreatedByAnExplicitAct,
    CellCarriesOneReference,
    ComparisonCarriesALegend,
    VerdictCarriesItsWord,
    EveryTableIsDated,
    TablePipesAreEscaped,
    CitationResolvesToARule,
    BodyStaysWithinWordCap,
    FilenameCarriesNoDigit,
    MergedRecordIsPermanent,
    RecordIsNotRevised,
    DeclaredLocationIsNamedByItsVariable,
    LandingClassifiesItsTargetFirst,
    SeededRuleRunsNoCanonCommand,
    SkillChecksItsHostBeforeItPlans,
    SkillHasOneOwner,
    SkillInstallRestoresOnFailure,
    SkillObeysThePortableFormat,
    SkillPlansBeforeItActs,
    InstallSweepsWhatThePayloadDropped,
    InitializationPreservesProjectContent,
    InstancesOperateOffline,
    ManifestIdentifiesEveryOwnedFile,
    DeclarationIsSeededOnceAndThenOwned,
    SkillPackageIsSelfContained,
    SkillInstallPreviewsBeforeWriting,
    SkillUninstallRemovesOnlyWhatItWrote,
    SkillsArePartOfThePayload,
    TheDoctorAnswersForTheInstalledSkills,
    ThePayloadNamesNoOtherProject,
    ThePayloadRootsAreDeclaredOnce,
    UpgradeConflictsAreAtomic,
    UserScopeFilesStayUnrecorded,
    UserScopeReceiptIsRequiredState,
    MachineScopeRecipeDropsASessionVariable,
    PlanIsStoredAndAppliedByItsId,
    ApplyRefusesAPlanWhoseInputsMoved,
    OneWriterHoldsATarget,
    PlanWritesNothing,
    DecisionPrecedesWhatDependsOnIt,
    FindingIsSomethingTheProgramProved,
    WriteIntoAdoptedStateIsAnOperatorAct,
    IncrementalScopeLeavesNoStructuralFinding,
    OnePlanIsTheInputToEveryWrite,
    ReadinessIsTheWorstPrecondition,
    FingerprintCoversWhatTheApplyWouldDo,
    PlannerIsDeterministic,
    TargetDecidesItsClassification,
    ReleaseIsReadThroughOneSeam,
    ReleaseDeclaresWhatItLands,
    ProtocolVersionIsARangeTheEngineDeclares,
    PreSchemaReleaseIsCatalogedOrUnavailable,
    FetchedArchiveIsVerifiedBeforeItIsRead,
    ResolutionHappensOnceAndWritesOnlyTheCache,
    RunThatDidNotFinishIsRolledBack,
    ApplyProvesEveryPostconditionItReports,
    DestinationIsContainedBeforeItIsWritten,
    PlanIdIsAFingerprintAndNeverAPath,
    ApplyResolvesNothing,
    TargetRecordsTheReleaseItHolds,
    ReleaseDeclaresWhatItAsksOfItsOperator,
    BinaryBuildsForEveryDeclaredTarget,
    OneCatalogDescribesEveryServedDocument,
    InstanceIsRoutedToTheIndex,
    AuthorInstructionsStayWithinBudget,
    ChapterStaysWithinLineCap,
    DocumentStatesThePresent,
    DocumentUsesStructuralMarkdownOnly,
    EveryBudgetCarriesAGate,
    FenceDeclaresALanguage,
    ProseStaysUnwrapped,
    DocumentCarriesNoPersonalPath,
    DocumentDirectoryExplainsItself,
    DocumentOwnsWhatItGoverns,
    KindPrefixCarriesASlug,
    ArtifactFilenamesCarryAKindPrefix,
    CompanionArtifactsShareTheSpecName,
    SpecStatesThePresent,
    SpecWinsOverRecord,
    SpecsAreCentralized,
    ProhibitionsAreCapped,
    RequirementCarriesAVerification,
    RequirementCarriesFiveParts,
    RuleIdIsUniqueAndSlugged,
    RuleIdOutlivesItsSentence,
    SpecStaysWithinLineCap,
    StatementUsesAnEarsPattern,
    UnenforcedRulesAreDeclared,
    VerificationNamesALiveHook,
    DivergentResultNamesItsDestination,
    ManualStepEnumeratesItsInteraction,
    StepFollowsItsProducers,
    StepIsOneImperativeAction,
    ExternalFactIsVerifiedUpstream,
    CitationsLiveInTheReferenceZone,
    EveryStepCarriesItsCheck,
    PreconditionsOpenAndVerificationCloses,
    TheManifestStaysReadable,
    AgentsBlockStaysManaged,
    TrackingRegistryStaysValid,
    ProjectDeclaresWhatItsGatesJudge,
    ManagedBlockAgreesWithTheDeclaration,
    BugzillaReportBodyFitsReportWidth,
    FiledRecordCarriesItsReport,
    RecordCarriesItsRetirementCondition,
    RecordCarriesOneFilingState,
    RecordCarriesOneState,
    RecordRecordsItsLastCheck,
    RecordWalksTheMechanism,
    CaseIdIsASlug,
    CanonGateIsNotDelivered,
    DeliveredGateReadsWhatTheConventionOwns,
    ReleasedVersionIsNotReAuthored,
    TagDerivesFromTheVersionFile,
    EveryReleaseDeclaresWhatItAsks,
    LicenseDeclaresBothHalves,
    CanonRecordDescribesItsTree,
    RkPinHasTwoFactsAndOneMover,
    DeliveredGateSetIsDeclaredOnce,
    ThirdPartyNoticesTravelWithThePayload,
    VersionsAreSemanticAndAligned,
    CommentCitesTheRule,
    CommentNamesNoRecord,
    GateMessageCitesTheRule,
    SpecMayLeadItsCode,
    SuppressionNamesItsCase,
    DeclaredDependentExists,
    PerishableSourceIsRegistered,
    EntryDeclaresHowToRevalidate,
    OverdueEntryBlocks,
    UpstreamCheckDoesNotEditTheTree,
    UpstreamDerivationPinsARevision,
    RegistryHasOneReadableShape,
    ExistingDocumentConvertsWhenEdited,
    NoDeliveredGateJudgesProse,
    SourcesNameTheRevisionRead,
    DocumentationBlockRoutesToTheStyle,
    StyleLivesInOneDocument,
    NoneImposesNoObligation,
    ProjectSelectsOneSource,
}

A domain:rule requirement address defined by a spec.

Variants

FragmentNamesTheVenueForm

acquisition:a-fragment-names-the-venue-form

CleanRemovesOnlyANamedLeftover

acquisition:clean-removes-only-a-named-leftover

EveryPairCarriesAVerdict

acquisition:every-pair-carries-a-verdict

OneTargetRunsOneMechanism

acquisition:one-target-runs-one-mechanism

StatusReportsAndNeverJudges

acquisition:status-reports-and-never-judges

TheOperatorCallerReportsEveryOutcome

acquisition:the-operator-caller-reports-every-outcome

ThePinMovesInOneTransaction

acquisition:the-pin-moves-in-one-transaction

TheShellEntryCallerIsRateLimitedAndSilent

acquisition:the-shell-entry-caller-is-rate-limited-and-silent

TheSyncLeavesADiffNobodyCommitted

acquisition:the-sync-leaves-a-diff-nobody-committed

TheToolServesAndDoesNotEdit

acquisition:the-tool-serves-and-does-not-edit

RecordedDimensionOnlyShrinks

budget-debt:a-recorded-dimension-only-shrinks

DebtIsCreatedByAnExplicitAct

budget-debt:debt-is-created-by-an-explicit-act

CellCarriesOneReference

comparison-docs:a-cell-carries-one-reference

ComparisonCarriesALegend

comparison-docs:a-comparison-carries-a-legend

VerdictCarriesItsWord

comparison-docs:a-verdict-carries-its-word

EveryTableIsDated

comparison-docs:every-table-is-dated

TablePipesAreEscaped

comparison-docs:table-pipes-are-escaped

CitationResolvesToARule

decision-records:a-citation-resolves-to-a-rule

BodyStaysWithinWordCap

decision-records:body-stays-within-350-words

FilenameCarriesNoDigit

decision-records:filename-carries-no-digit

MergedRecordIsPermanent

decision-records:merged-record-is-permanent

RecordIsNotRevised

decision-records:record-is-not-revised

DeclaredLocationIsNamedByItsVariable

distribution:a-declared-location-is-named-by-its-variable

LandingClassifiesItsTargetFirst

distribution:a-landing-classifies-its-target-first

SeededRuleRunsNoCanonCommand

distribution:a-seeded-rule-runs-no-canon-command

SkillChecksItsHostBeforeItPlans

distribution:a-skill-checks-its-host-before-it-plans

SkillHasOneOwner

distribution:a-skill-has-one-owner

SkillInstallRestoresOnFailure

distribution:a-skill-install-restores-on-failure

SkillObeysThePortableFormat

distribution:a-skill-obeys-the-portable-format

SkillPlansBeforeItActs

distribution:a-skill-plans-before-it-acts

InstallSweepsWhatThePayloadDropped

distribution:an-install-sweeps-what-the-payload-dropped

InitializationPreservesProjectContent

distribution:initialization-preserves-project-content

InstancesOperateOffline

distribution:instances-operate-offline

ManifestIdentifiesEveryOwnedFile

distribution:manifest-identifies-every-owned-file

DeclarationIsSeededOnceAndThenOwned

distribution:the-declaration-is-seeded-once-and-then-owned

SkillPackageIsSelfContained

distribution:a-skill-package-is-self-contained

SkillInstallPreviewsBeforeWriting

distribution:skill-install-previews-before-writing

SkillUninstallRemovesOnlyWhatItWrote

distribution:skill-uninstall-removes-only-what-it-wrote

SkillsArePartOfThePayload

distribution:skills-are-part-of-the-payload

TheDoctorAnswersForTheInstalledSkills

distribution:the-doctor-answers-for-the-installed-skills

ThePayloadNamesNoOtherProject

distribution:the-payload-names-no-other-project

ThePayloadRootsAreDeclaredOnce

distribution:the-payload-roots-are-declared-once

UpgradeConflictsAreAtomic

distribution:upgrade-conflicts-are-atomic

UserScopeFilesStayUnrecorded

distribution:user-scope-files-stay-unrecorded

UserScopeReceiptIsRequiredState

distribution:a-user-scope-receipt-is-required-state

MachineScopeRecipeDropsASessionVariable

release:a-machine-scope-recipe-drops-a-session-variable

PlanIsStoredAndAppliedByItsId

reconcile:a-plan-is-stored-and-applied-by-its-id

ApplyRefusesAPlanWhoseInputsMoved

reconcile:an-apply-refuses-a-plan-whose-inputs-moved

OneWriterHoldsATarget

reconcile:one-writer-holds-a-target

PlanWritesNothing

reconcile:a-plan-writes-nothing

DecisionPrecedesWhatDependsOnIt

reconcile:a-decision-precedes-what-depends-on-it

FindingIsSomethingTheProgramProved

reconcile:a-finding-is-something-the-program-proved

WriteIntoAdoptedStateIsAnOperatorAct

reconcile:a-write-into-adopted-state-is-an-operator-act

IncrementalScopeLeavesNoStructuralFinding

reconcile:an-incremental-scope-leaves-no-structural-finding

OnePlanIsTheInputToEveryWrite

reconcile:one-plan-is-the-input-to-every-write

ReadinessIsTheWorstPrecondition

reconcile:readiness-is-the-worst-precondition

FingerprintCoversWhatTheApplyWouldDo

reconcile:the-fingerprint-covers-what-the-apply-would-do

PlannerIsDeterministic

reconcile:the-planner-is-deterministic

TargetDecidesItsClassification

reconcile:the-target-decides-its-classification

ReleaseIsReadThroughOneSeam

bundle:a-release-is-read-through-one-seam

ReleaseDeclaresWhatItLands

bundle:a-release-declares-what-it-lands

ProtocolVersionIsARangeTheEngineDeclares

bundle:the-protocol-version-is-a-range-the-engine-declares

PreSchemaReleaseIsCatalogedOrUnavailable

bundle:a-pre-schema-release-is-cataloged-or-unavailable

FetchedArchiveIsVerifiedBeforeItIsRead

bundle:a-fetched-archive-is-verified-before-it-is-read

ResolutionHappensOnceAndWritesOnlyTheCache

bundle:resolution-happens-once-and-writes-only-the-cache

RunThatDidNotFinishIsRolledBack

reconcile:a-run-that-did-not-finish-is-rolled-back

ApplyProvesEveryPostconditionItReports

reconcile:an-apply-proves-every-postcondition-it-reports

DestinationIsContainedBeforeItIsWritten

reconcile:a-destination-is-contained-before-it-is-written

PlanIdIsAFingerprintAndNeverAPath

reconcile:a-plan-id-is-a-fingerprint-and-never-a-path

ApplyResolvesNothing

reconcile:an-apply-resolves-nothing

TargetRecordsTheReleaseItHolds

reconcile:a-target-records-the-release-it-holds

ReleaseDeclaresWhatItAsksOfItsOperator

reconcile:a-release-declares-what-it-asks-of-its-operator

BinaryBuildsForEveryDeclaredTarget

release:the-binary-builds-for-every-declared-target

OneCatalogDescribesEveryServedDocument

docs-discovery:one-catalog-describes-every-served-document

InstanceIsRoutedToTheIndex

docs-discovery:an-instance-is-routed-to-the-index

AuthorInstructionsStayWithinBudget

docs-format:author-instructions-stay-within-budget

ChapterStaysWithinLineCap

docs-format:chapter-stays-within-200-lines

DocumentStatesThePresent

docs-format:document-states-the-present

DocumentUsesStructuralMarkdownOnly

docs-format:document-uses-structural-markdown-only

EveryBudgetCarriesAGate

docs-format:every-budget-carries-a-gate

FenceDeclaresALanguage

docs-format:fence-declares-a-language

ProseStaysUnwrapped

docs-format:prose-stays-unwrapped

DocumentCarriesNoPersonalPath

docs-foundations:a-document-carries-no-personal-path

DocumentDirectoryExplainsItself

docs-foundations:a-document-directory-explains-itself

DocumentOwnsWhatItGoverns

docs-foundations:a-document-owns-what-it-governs

KindPrefixCarriesASlug

docs-foundations:a-kind-prefix-carries-a-slug

ArtifactFilenamesCarryAKindPrefix

docs-foundations:artifact-filenames-carry-a-kind-prefix

CompanionArtifactsShareTheSpecName

docs-foundations:companion-artifacts-share-the-spec-name

SpecStatesThePresent

docs-foundations:spec-states-the-present

SpecWinsOverRecord

docs-foundations:spec-wins-over-record

SpecsAreCentralized

docs-foundations:specs-are-centralized

ProhibitionsAreCapped

docs-specs:prohibitions-are-capped

RequirementCarriesAVerification

docs-specs:requirement-carries-a-verification

RequirementCarriesFiveParts

docs-specs:requirement-carries-five-parts

RuleIdIsUniqueAndSlugged

docs-specs:rule-id-is-unique-and-slugged

RuleIdOutlivesItsSentence

docs-specs:rule-id-outlives-its-sentence

SpecStaysWithinLineCap

docs-specs:spec-stays-within-300-lines

StatementUsesAnEarsPattern

docs-specs:statement-uses-an-ears-pattern

UnenforcedRulesAreDeclared

docs-specs:unenforced-rules-are-declared

VerificationNamesALiveHook

docs-specs:verification-names-a-live-hook

DivergentResultNamesItsDestination

guides:a-divergent-result-names-its-destination

ManualStepEnumeratesItsInteraction

guides:a-manual-step-enumerates-its-interaction

StepFollowsItsProducers

guides:a-step-follows-its-producers

StepIsOneImperativeAction

guides:a-step-is-one-imperative-action

ExternalFactIsVerifiedUpstream

guides:an-external-fact-is-verified-upstream

CitationsLiveInTheReferenceZone

guides:citations-live-in-the-reference-zone

EveryStepCarriesItsCheck

guides:every-step-carries-its-check

PreconditionsOpenAndVerificationCloses

guides:preconditions-open-and-verification-closes

TheManifestStaysReadable

instance:the-manifest-stays-readable

AgentsBlockStaysManaged

instance:the-agents-block-stays-managed

TrackingRegistryStaysValid

instance:the-tracking-registry-stays-valid

ProjectDeclaresWhatItsGatesJudge

instance:the-project-declares-what-its-gates-judge

ManagedBlockAgreesWithTheDeclaration

instance:the-managed-block-agrees-with-the-declaration

BugzillaReportBodyFitsReportWidth

known-issues:a-bugzilla-report-body-fits-in-79-columns

FiledRecordCarriesItsReport

known-issues:a-filed-record-carries-its-report

RecordCarriesItsRetirementCondition

known-issues:a-record-carries-its-retirement-condition

RecordCarriesOneFilingState

known-issues:a-record-carries-one-filing-state

RecordCarriesOneState

known-issues:a-record-carries-one-state

RecordRecordsItsLastCheck

known-issues:a-record-records-its-last-check

RecordWalksTheMechanism

known-issues:a-record-walks-the-mechanism

CaseIdIsASlug

known-issues:case-id-is-a-slug

CanonGateIsNotDelivered

release:a-canon-gate-is-not-delivered

DeliveredGateReadsWhatTheConventionOwns

release:a-delivered-gate-reads-what-the-convention-owns

ReleasedVersionIsNotReAuthored

release:a-released-version-is-not-re-authored

TagDerivesFromTheVersionFile

release:a-tag-derives-from-the-version-file

EveryReleaseDeclaresWhatItAsks

release:every-release-declares-what-it-asks

LicenseDeclaresBothHalves

release:license-declares-both-halves

CanonRecordDescribesItsTree

release:the-canon-record-describes-its-tree

RkPinHasTwoFactsAndOneMover

release:the-rk-pin-has-two-facts-and-one-mover

DeliveredGateSetIsDeclaredOnce

release:the-delivered-gate-set-is-declared-once

ThirdPartyNoticesTravelWithThePayload

release:third-party-notices-travel-with-the-payload

VersionsAreSemanticAndAligned

release:versions-are-semantic-and-aligned

CommentCitesTheRule

spec-to-code:a-comment-cites-the-rule

CommentNamesNoRecord

spec-to-code:a-comment-names-no-record

GateMessageCitesTheRule

spec-to-code:a-gate-message-cites-the-rule

SpecMayLeadItsCode

spec-to-code:a-spec-may-lead-its-code

SuppressionNamesItsCase

spec-to-code:a-suppression-names-its-case

DeclaredDependentExists

tracking:a-declared-dependent-exists

PerishableSourceIsRegistered

tracking:a-perishable-source-is-registered

EntryDeclaresHowToRevalidate

tracking:an-entry-declares-how-to-revalidate

OverdueEntryBlocks

tracking:an-overdue-entry-blocks

UpstreamCheckDoesNotEditTheTree

tracking:an-upstream-check-does-not-edit-the-tree

UpstreamDerivationPinsARevision

tracking:an-upstream-derivation-pins-a-revision

RegistryHasOneReadableShape

tracking:the-registry-has-one-readable-shape

ExistingDocumentConvertsWhenEdited

writing-style:an-existing-document-converts-when-edited

NoDeliveredGateJudgesProse

writing-style:no-delivered-gate-judges-prose

SourcesNameTheRevisionRead

writing-style:sources-name-the-revision-read

DocumentationBlockRoutesToTheStyle

writing-style:the-documentation-block-routes-to-the-style

StyleLivesInOneDocument

writing-style:the-style-lives-in-one-document

NoneImposesNoObligation

writing-policy:none-imposes-no-obligation

ProjectSelectsOneSource

writing-policy:the-project-selects-one-source

Implementations

impl RuleId

pub const ALL: &'static [Self]

Every rule the specs define, in slug order.

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

The domain:rule slug pair this variant addresses.

pub fn parse(id: &str) -> Option<Self>

The rule one slug pair addresses, where a spec defines it.

Trait Implementations

impl Clone for RuleId

fn clone(&self) -> RuleId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for RuleId

impl Debug for RuleId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RuleId

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for RuleId

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

Formats the value using the given formatter.

impl Eq for RuleId

impl Hash for RuleId

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for RuleId

fn cmp(&self, other: &RuleId) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for RuleId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for RuleId

fn partial_cmp(&self, other: &RuleId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for RuleId

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RuleId