Skip to main content

ShipperConfig

Struct ShipperConfig 

Source
pub struct ShipperConfig {
Show 16 fields pub schema_version: String, pub policy: PolicyConfig, pub verify: VerifyConfig, pub readiness: ReadinessConfig, pub output: OutputConfig, pub lock: LockConfig, pub retry: RetryConfig, pub flags: FlagsConfig, pub parallel: ParallelConfig, pub state_dir: Option<PathBuf>, pub registry: Option<RegistryConfig>, pub registries: MultiRegistryConfig, pub webhook: WebhookConfig, pub encryption: EncryptionConfigInner, pub storage: StorageConfigInner, pub rehearsal: RehearsalConfig,
}
Expand description

Project-specific configuration loaded from .shipper.toml.

This is the root deserialization target for the config file. Each field corresponds to a TOML section (e.g. [retry]RetryConfig).

Use ShipperConfig::load_from_workspace to discover and parse the file, then ShipperConfig::build_runtime_options to merge CLI overrides and produce the final RuntimeOptions.

Fields§

§schema_version: String

Schema version for the configuration file (e.g., shipper.config.v1)

§policy: PolicyConfig

Publish policy configuration

§verify: VerifyConfig

Verify mode configuration

§readiness: ReadinessConfig

Readiness check configuration

§output: OutputConfig

Output configuration

§lock: LockConfig

Lock configuration

§retry: RetryConfig

Retry configuration

§flags: FlagsConfig

Flags configuration

§parallel: ParallelConfig

Parallel publishing configuration

§state_dir: Option<PathBuf>

Optional custom state directory

§registry: Option<RegistryConfig>

Optional custom registry configuration (single registry)

§registries: MultiRegistryConfig

Multiple registry configuration for multi-registry publishing

§webhook: WebhookConfig

Webhook configuration for publish notifications

§encryption: EncryptionConfigInner

Encryption configuration for state files

§storage: StorageConfigInner

Storage configuration for cloud storage backends

§rehearsal: RehearsalConfig

Rehearsal registry configuration — opt-in phase-2 proof before live dispatch. See issue #97.

This field parses the [rehearsal] TOML section. It is wired through to CLI overrides but not yet consumed by the engine — follow-on PRs under #97 add the phase-2 execution and the gate that refuses live dispatch unless rehearsal succeeded for the same plan_id.

Implementations§

Source§

impl ShipperConfig

Source

pub fn load_from_workspace( workspace_root: &Path, ) -> Result<Option<ShipperConfig>, Error>

Load configuration from workspace root by searching for .shipper.toml

Returns Ok(None) if no config file exists.

Source

pub fn load_from_file(path: &Path) -> Result<ShipperConfig, Error>

Load configuration from a specific file path

Source

pub fn validate(&self) -> Result<(), Error>

Validate the configuration

Source

pub fn build_runtime_options(&self, cli: CliOverrides) -> RuntimeOptions

Build RuntimeOptions by merging CLI overrides with config file values.

For Option fields: CLI value takes precedence; falls back to config. For bool flags: true if either CLI or config enables it (OR).

Source

pub fn default_toml_template() -> String

Generate a default configuration file content as TOML string

Trait Implementations§

Source§

impl Clone for ShipperConfig

Source§

fn clone(&self) -> ShipperConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ShipperConfig

Source§

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

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

impl Default for ShipperConfig

Source§

fn default() -> ShipperConfig

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for ShipperConfig

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<ShipperConfig, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for ShipperConfig

Source§

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. 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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,