Skip to main content

ServiceScaffoldSpec

Struct ServiceScaffoldSpec 

Source
pub struct ServiceScaffoldSpec {
Show 14 fields pub name: String, pub transport: ServiceTransport, pub store: StoreTarget, pub bus: Option<BusTarget>, pub models: Vec<String>, pub read_models: bool, pub commands: Vec<String>, pub events: Vec<String>, pub distributed_dependency_path: String, pub gitops: bool, pub gitops_promote: Option<GitopsPromoteTarget>, pub github: Option<GithubRepo>, pub github_preview: Option<GithubRepo>, pub github_promote: Option<GithubRepo>,
}
Expand description

What to scaffold. The pure input to generate_service_scaffold.

name and the raw models/commands/events strings are normalized by the generator (kebab/pascal/ident casing, validation, dedup) — that normalization is part of the rules this crate owns.

Fields§

§name: String

Service / package name (free-form; normalized to a kebab package name).

§transport: ServiceTransport

Runtime transport to scaffold.

§store: StoreTarget

Read-model / schema storage target.

§bus: Option<BusTarget>

Optional message bus backend.

§models: Vec<String>

Aggregate model names to scaffold (raw; may be empty).

§read_models: bool

Generate placeholder read-model modules and register them in the manifest.

§commands: Vec<String>

Command handler message names (raw; empty → a default command is derived).

§events: Vec<String>

Event handler message names (raw; may be empty).

§distributed_dependency_path: String

Relative path (from the generated project dir) to the local distributed crate, used in the generated Cargo.toml dependency.

§gitops: bool

Generate a Helm deploy chart under .gitops/deploy.

§gitops_promote: Option<GitopsPromoteTarget>

Generate a GitOps promotion chart for Argo CD or Flux.

§github: Option<GithubRepo>

The service’s own GitHub repository: emits the version/release workflows and an EnsureGithubRepository post-create action.

§github_preview: Option<GithubRepo>

Preview-environment GitOps repository: emits the preview workflow and the .gitops/preview/helm promotion chart. Independent of github.

§github_promote: Option<GithubRepo>

Permanent-environment GitOps repository: emits the promote workflow and the .gitops/promote/helm promotion chart. Independent of github.

Trait Implementations§

Source§

impl Clone for ServiceScaffoldSpec

Source§

fn clone(&self) -> ServiceScaffoldSpec

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 Debug for ServiceScaffoldSpec

Source§

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

Formats the value using the given formatter. Read more

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, 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.