cloud-sdk 0.55.0

no_std-first provider-neutral cloud SDK foundations.
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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151

use crate::operation::{OperationId, OperationImpact, PreparedRequest};
use crate::transport::StatusCode;
use crate::{ProviderId, ServiceId};

use super::{DiagnosticErrorCategory, DiagnosticRequestId, DiagnosticRetryCategory};

/// Validated provider and operation context for one lifecycle event.
#[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub struct DiagnosticContext {
    provider: ProviderId,
    service: ServiceId,
    operation: Option<OperationId>,
    impact: OperationImpact,
    retry: DiagnosticRetryCategory,
}

impl DiagnosticContext {
    pub(crate) const fn new(
        provider: ProviderId,
        service: ServiceId,
        operation: Option<OperationId>,
        impact: OperationImpact,
        retry: DiagnosticRetryCategory,
    ) -> Self {
        Self {
            provider,
            service,
            operation,
            impact,
            retry,
        }
    }

    pub(crate) fn from_prepared(prepared: &PreparedRequest<'_>) -> Self {
        let service = prepared.service();
        Self::new(
            service.provider_id(),
            service.service_id(),
            prepared.operation_id(),
            prepared.metadata().impact(),
            prepared.metadata().retry_eligibility().into(),
        )
    }

    /// Returns the validated provider identifier.
    #[must_use]
    pub const fn provider(self) -> ProviderId {
        self.provider
    }

    /// Returns the validated provider-owned service identifier.
    #[must_use]
    pub const fn service(self) -> ServiceId {
        self.service
    }

    /// Returns the provider operation identifier when one was bound.
    #[must_use]
    pub const fn operation(self) -> Option<OperationId> {
        self.operation
    }

    /// Returns the validated operation impact.
    #[must_use]
    pub const fn impact(self) -> OperationImpact {
        self.impact
    }

    /// Returns the operation retry category.
    #[must_use]
    pub const fn retry(self) -> DiagnosticRetryCategory {
        self.retry
    }
}

/// Payload-free response metadata admitted for diagnostics.
#[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub struct DiagnosticResponse {
    status: StatusCode,
    request_id: DiagnosticRequestId,
}

impl DiagnosticResponse {
    pub(crate) const fn new(status: StatusCode, request_id: DiagnosticRequestId) -> Self {
        Self { status, request_id }
    }

    /// Returns the bounded HTTP status code.
    #[must_use]
    pub const fn status(self) -> StatusCode {
        self.status
    }

    /// Returns request-ID disposition without exposing identifier bytes.
    #[must_use]
    pub const fn request_id(self) -> DiagnosticRequestId {
        self.request_id
    }
}

/// Structured client lifecycle event containing no request or response payload.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum DiagnosticEvent {
    /// A caller-owned workspace was cleared before preparation began.
    PreparationStarted,
    /// Provider preparation failed before an identity could be trusted.
    PreparationFailed {
        /// Payload-free failure category.
        error: DiagnosticErrorCategory,
    },
    /// A complete provider request and policy context was prepared.
    RequestPrepared {
        /// Validated provider operation context.
        context: DiagnosticContext,
    },
    /// One authenticated transport attempt is about to begin.
    DispatchStarted {
        /// Validated provider operation context.
        context: DiagnosticContext,
    },
    /// Authenticated execution failed before checked decoding.
    ExecutionFailed {
        /// Validated provider operation context.
        context: DiagnosticContext,
        /// Payload-free failure category.
        error: DiagnosticErrorCategory,
    },
    /// A committed bounded response was received.
    ResponseReceived {
        /// Validated provider operation context.
        context: DiagnosticContext,
        /// Admitted response metadata.
        response: DiagnosticResponse,
    },
    /// Provider-owned checked decoding failed.
    DecodeFailed {
        /// Validated provider operation context.
        context: DiagnosticContext,
        /// Response metadata when a committed response was observable.
        response: Option<DiagnosticResponse>,
        /// Payload-free failure category.
        error: DiagnosticErrorCategory,
    },
    /// One operation completed successfully.
    Completed {
        /// Validated provider operation context.
        context: DiagnosticContext,
        /// Response metadata when a committed response was observable.
        response: Option<DiagnosticResponse>,
    },
}