lightshuttle-export 0.5.0

Manifest to deployment artifact transpilation for LightShuttle
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

//! Error type returned by the export pipeline.

use lightshuttle_spec::SpecError;

/// Shorthand `Result` type that pins the error to [`ExportError`].
///
/// Used as the return type of [`crate::lower`] and [`crate::Emitter::emit`].
pub type Result<T> = std::result::Result<T, ExportError>;

/// Errors raised while lowering a manifest or emitting artifacts.
#[derive(Debug, thiserror::Error)]
pub enum ExportError {
    /// Resolving a manifest resource into a container specification
    /// failed during lowering.
    #[error("failed to resolve resource `{resource}`")]
    Spec {
        /// Resource whose resolution failed.
        resource: String,
        /// Underlying specification error.
        #[source]
        source: SpecError,
    },

    /// An emitter could not represent a resource for its target (for
    /// example, a locally built image has no registry reference to put
    /// in a Kubernetes manifest).
    #[error("`{resource}` cannot be exported to {target}: {reason}")]
    Unsupported {
        /// Resource that cannot be represented.
        resource: String,
        /// Target that rejected it.
        target: &'static str,
        /// Why the resource is unsupported for this target.
        reason: String,
    },
}