Skip to main content

vvv_engine/protocol/
mod.rs

1//! The JSON contract. Anything printed by `vvv --json` is one of these types,
2//! so a client can rely on the shape independently of the CLI's human output.
3//!
4//! Data only: nothing here reads a file or takes a `Workspace`. A client that
5//! only speaks JSON depends on this crate alone.
6
7mod answer;
8mod command;
9pub use command::Command;
10mod diff;
11pub mod display;
12mod failure;
13mod intent;
14mod notice;
15mod reach;
16mod request;
17mod respelling;
18mod result;
19mod search;
20mod selection;
21mod source;
22mod template;
23pub mod vocabulary;
24
25use serde::{Deserialize, Serialize};
26
27pub use crate::batch::Batch;
28pub use crate::capabilities::declarations::{
29    Locations, Outline, OutlineItem, OutlineQuery, Site, WhereQuery,
30};
31pub use crate::capabilities::file::{File, FileQuery, WorkspaceFiles, WorkspaceFilesQuery};
32pub use crate::capabilities::imports::{
33    Deps, DepsQuery, ExplainQuery, Explanation, ImportSite, ImportsQuery, ImportsReport,
34};
35pub use crate::capabilities::rename::{Definitions, References, ReferencesQuery};
36pub use crate::capabilities::search::{Search, SearchQuery, SearchScope};
37pub use crate::capabilities::surface::{Exposed, Surface, SurfaceQuery};
38pub use crate::capabilities::usage::{
39    Consumer, Dead, DeadQuery, Impact, ImpactQuery, Unreferenced,
40};
41pub use crate::rewrite::Rewrite;
42pub use answer::{Dep, Importer, Placed};
43pub use diff::{Diff, DiffKind, DiffLine, Hunk, LineRange};
44pub use failure::{
45    ErrorCode, Failure, OutputLimit, Recovery, RecoveryEffect, RecoveryIssue, RecoveryOperation,
46    RecoveryState, RecoveryUnverified,
47};
48pub use intent::{BatchIntent, Intent, RewriteIntent, RewriteOf};
49pub use notice::{Notice, NoticeKind};
50
51pub use reach::Reach;
52pub use request::{Answer, Call, Reply, Request};
53pub use respelling::Respelling;
54pub use result::{
55    FileChange, History, HistoryEntry, Mutation, MutationAnswer, MutationState, Undo,
56};
57pub use search::{Confidence, Match, MatchId, Occurrence, Reason, Skipped};
58pub use selection::{Selection, SelectionError};
59pub use template::{Template, TemplateError};
60
61/// The shape of this contract. Bumped when a field changes meaning or goes
62/// away; adding fields does not bump it.
63pub const SCHEMA: u32 = 1;
64
65/// Top-level envelope of every `--json` response.
66#[derive(Debug, Clone, Serialize, Deserialize)]
67#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
68#[serde(tag = "status", rename_all = "lowercase")]
69pub enum Response<T> {
70    Ok {
71        schema: u32,
72        result: T,
73    },
74    Error {
75        schema: u32,
76        #[serde(flatten)]
77        failure: Failure,
78    },
79}
80
81impl<T> Response<T> {
82    pub fn ok(result: T) -> Self {
83        Self::Ok {
84            schema: SCHEMA,
85            result,
86        }
87    }
88
89    pub fn error(failure: Failure) -> Self {
90        Self::Error {
91            schema: SCHEMA,
92            failure,
93        }
94    }
95}
96
97pub use crate::capabilities::navigation::{
98    DefinitionCandidate, DefinitionLocation, DefinitionPreview, NavigationOrigin,
99    NavigationOutcome, NavigationQuery, NavigationReply, ResolutionEvidence, ResolutionOutcome,
100    ResolutionQuery, ResolutionReply, SnapshotId, UnavailableReason,
101};
102pub use source::{ContentId, SourceAnchor, SymbolRef};
103
104pub use crate::capabilities::context::{
105    ContextBudget, ContextCandidate, ContextDetail, ContextItem, ContextOmissions, ContextOutcome,
106    ContextQuery, ContextRelation, ContextReply, ContextSignature,
107};
108
109pub use crate::capabilities::discovery::{Capability, Discovery, DiscoveryQuery};
110
111#[cfg(feature = "schema")]
112pub use crate::capabilities::schema::{
113    SchemaContract, SchemaDocument, SchemaQuery, SchemaReferences,
114};
115
116mod cursor;
117pub use crate::capabilities::context::{
118    ContextPage, ContextPageQuery, ContextUnresolved, ContextWork, PagedContextItem,
119};
120pub use crate::capabilities::excerpts::{ExpandQuery, Expansion};
121pub use crate::capabilities::pagination::{ContinueQuery, PageBudget, PageReply, WorkBudget};
122pub use crate::capabilities::search::{SearchPage, SearchPageItem, SearchPageQuery};
123pub use crate::query_store::QueryLimits;
124pub use cursor::Cursor;
125
126pub use failure::ContinuationRecovery;
127
128pub use crate::capabilities::relationships::{
129    Relationship, RelationshipBudget, RelationshipCoverage, RelationshipKind, RelationshipLimit,
130    RelationshipLimitation, RelationshipResolution, Relationships, RelationshipsQuery,
131};
132
133pub use crate::capabilities::plans::{
134    ApplyPlanQuery, DiscardPlanQuery, InspectPlanQuery, PlanId, PlanPreview, PlanReceipt,
135    PlanReview, PlanReviewCursor, PlanReviewItem, PlanReviewKind, PlanReviewPage, PlanReviewReply,
136    PlanStatus, PrepareMoveIntent, PrepareMoveQuery, PrepareMoveSymbolIntent,
137    PrepareMoveSymbolQuery, PrepareRenameQuery, PrepareRewriteQuery, ReviewMutation,
138    ReviewPlanQuery, ReviewSection, ReviewTotals,
139};
140
141pub use crate::capabilities::validation::{
142    CheckCommand, CheckFailure, CheckOperation, CheckOutcome, CheckOutput, CheckResult,
143    ValidatePlanQuery, ValidationBudget, ValidationReport, ValidationSourceState,
144};
145
146pub use crate::capabilities::moves::{
147    SymbolMoveCandidate, SymbolMoveCandidates, SymbolMoveCandidatesQuery, SymbolMoveOwnership,
148    SymbolMovePiece, SymbolMoveUnsupported,
149};