interprex 5.0.0

Provider-neutral models and async interfaces for development platforms
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

use serde::{Deserialize, Serialize};
use thiserror::Error;

use super::CommitRange;
use crate::ProviderError;

/// Whether the observed head contains the observed target-branch tip.
#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[serde(rename_all = "snake_case")]
pub enum BranchFreshness {
    Current,
    /// The head does not contain the observed target-branch tip. The commits
    /// can be direct ancestors or can have diverged.
    Behind,
}

/// The provider's branch-update facts for one change request observation.
///
/// `commit_range` states the exact target and head revisions used to compute
/// `freshness`. A later read can differ. Callers pass the observed
/// `commit_range.head_sha` to the provider's update operation when they decide
/// an update is appropriate.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub struct BranchUpdateObservation {
    pub commit_range: CommitRange,
    pub freshness: BranchFreshness,
}

/// Failure to apply an exact-head branch update.
#[derive(Clone, Debug, Eq, Error, PartialEq)]
pub enum BranchUpdateError {
    /// The change request no longer has the head named by the caller.
    #[error(
        "change request head changed: expected {expected_head_sha}, observed {observed_head_sha}"
    )]
    StaleHead {
        expected_head_sha: String,
        observed_head_sha: String,
    },
    /// A provider credential, lookup, validation, transport or refusal error.
    #[error(transparent)]
    Provider(#[from] ProviderError),
}