Skip to main content

RuntimeOptions

Struct RuntimeOptions 

Source
pub struct RuntimeOptions {
Show 28 fields pub allow_dirty: bool, pub skip_ownership_check: bool, pub strict_ownership: bool, pub no_verify: bool, pub max_attempts: u32, pub base_delay: Duration, pub max_delay: Duration, pub retry_strategy: RetryStrategyType, pub retry_jitter: f64, pub retry_per_error: PerErrorConfig, pub verify_timeout: Duration, pub verify_poll_interval: Duration, pub state_dir: PathBuf, pub force_resume: bool, pub policy: PublishPolicy, pub verify_mode: VerifyMode, pub readiness: ReadinessConfig, pub output_lines: usize, pub force: bool, pub lock_timeout: Duration, pub parallel: ParallelConfig, pub webhook: WebhookConfig, pub encryption: EncryptionConfig, pub registries: Vec<Registry>, pub resume_from: Option<String>, pub rehearsal_registry: Option<String>, pub rehearsal_skip: bool, pub rehearsal_smoke_install: Option<String>,
}
Expand description

Runtime configuration options for a Shipper publish operation.

This struct contains all the tunable parameters that control how Shipper executes a publish operation, including retry behavior, verification settings, and output preferences.

§Example

use std::path::PathBuf;
use shipper::types::{RuntimeOptions, PublishPolicy, ParallelConfig};

let options = RuntimeOptions {
    allow_dirty: false,
    skip_ownership_check: false,
    strict_ownership: true,
    no_verify: false,
    max_attempts: 3,
    base_delay: std::time::Duration::from_secs(1),
    max_delay: std::time::Duration::from_secs(60),
    retry_strategy: shipper::retry::RetryStrategyType::Exponential,
    retry_jitter: 0.3,
    retry_per_error: shipper::retry::PerErrorConfig::default(),
    verify_timeout: std::time::Duration::from_secs(600),
    verify_poll_interval: std::time::Duration::from_secs(10),
    state_dir: PathBuf::from(".shipper"),
    force_resume: false,
    policy: PublishPolicy::Safe,
    verify_mode: shipper::types::VerifyMode::Workspace,
    readiness: shipper::types::ReadinessConfig::default(),
    output_lines: 1000,
    force: false,
    lock_timeout: std::time::Duration::from_secs(3600),
    parallel: ParallelConfig::default(),
    webhook: shipper::webhook::WebhookConfig::default(),
    encryption: shipper::encryption::EncryptionConfig::default(),
    registries: vec![],
};

Fields§

§allow_dirty: bool

Allow publishing from a dirty git working tree.

§skip_ownership_check: bool

Skip crate-ownership preflight checks.

§strict_ownership: bool

Fail preflight if ownership verification fails.

§no_verify: bool

Pass --no-verify to cargo publish (skip pre-publish build).

§max_attempts: u32

Maximum number of publish attempts per crate.

§base_delay: Duration

Initial backoff delay between retries.

§max_delay: Duration

Upper bound on backoff delay.

§retry_strategy: RetryStrategyType

Retry strategy type: immediate, exponential, linear, constant

§retry_jitter: f64

Jitter factor for retry delays

§retry_per_error: PerErrorConfig

Per-error-type retry configuration

§verify_timeout: Duration

Timeout for the workspace-level dry-run verification step.

§verify_poll_interval: Duration

Poll interval for the dry-run verification step.

§state_dir: PathBuf

Directory for persisted state, receipts, and event logs.

§force_resume: bool

Force resume even when the plan ID has changed.

§policy: PublishPolicy

Publishing policy preset (safe / balanced / fast).

§verify_mode: VerifyMode

Dry-run verification mode (workspace / package / none).

§readiness: ReadinessConfig

Readiness (post-publish visibility) configuration.

§output_lines: usize

Number of stdout/stderr lines to capture as evidence.

§force: bool

Force override of existing locks

§lock_timeout: Duration

Lock timeout duration (after which locks are considered stale)

§parallel: ParallelConfig

Parallel publishing configuration

§webhook: WebhookConfig

Webhook configuration for publish notifications

§encryption: EncryptionConfig

Encryption configuration for state files

§registries: Vec<Registry>

Target registries for multi-registry publishing

§resume_from: Option<String>

Optional package name to resume from (skips all packages before this one)

§rehearsal_registry: Option<String>

Rehearsal registry name (#97) — if Some, shipper rehearse publishes to this registry as phase-2 proof before live dispatch. None means rehearsal is disabled (the default; opt-in until phase-2 stabilizes).

The name must resolve against the configured Self::registries at runtime; engine::run_rehearsal errors clean otherwise.

§rehearsal_skip: bool

Operator override — explicitly skip rehearsal even if a Self::rehearsal_registry is configured (#97). Default false. When the hard gate lands (#97 PR 3), live publish will refuse to run without this flag if rehearsal has not passed for the current plan_id.

§rehearsal_smoke_install: Option<String>

Crate name to install via cargo install --registry <rehearsal> after all rehearsal publishes succeed (#97 PR 4). This is the install/smoke check that proves end-to-end registry-index resolution — the scenario that killed the rc.1 first-publish. None means no smoke install (opt-in). The named crate must exist in the plan AND have a [[bin]] target.

Trait Implementations§

Source§

impl Clone for RuntimeOptions

Source§

fn clone(&self) -> RuntimeOptions

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 RuntimeOptions

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