Struct ObserveInput 

pub struct ObserveInput {
    pub deployment: Option<String>,
    pub url: Option<String>,
    pub identity: Option<String>,
    pub commit: Option<String>,
    pub timeout_seconds: Option<u64>,
    pub dry_run: bool,
}

The input of served.observe: which deployment, where it is, which commit is expected and how long the probe may take. Everything is optional — the defaults are this repository’s own site, its build.json and HEAD.

use majordomus_cli::capability::builtin::served::ObserveInput;
let input: ObserveInput = serde_json::from_str(r#"{"commit":"HEAD"}"#).unwrap();
assert_eq!(input.commit.as_deref(), Some("HEAD"));
assert!(serde_json::from_str::<ObserveInput>(r#"{"shell":"rm"}"#).is_err());

Fields

deployment: Option<String>

The name the observation is recorded under; pages when absent.

url: Option<String>

The site’s base URL; base_url of site/config.toml when absent.

identity: Option<String>

The identity file under the base; build.json when absent.

commit: Option<String>

The commit expected to be served, any revision git resolves; HEAD when absent.

timeout_seconds: Option<u64>

The bound on the probe in seconds; ten when absent.

dry_run: bool

Judge without recording. Recording is the default, because an observation nobody kept is a measurement nobody can read.

Trait Implementations

impl BenchmarkCases for ObserveInput

fn benchmark_cases(_: &CaseContext<'_>) -> Vec<NamedCase<Self>>

The cases, in a stable order. An empty list means “nothing to benchmark in this repository”, which the coverage check reports as missing.

fn benchmark_cases_json(ctx: &CaseContext<'_>) -> Vec<NamedCase<Value>>

The cases as JSON, the shape every runner serialises from.

impl Debug for ObserveInput

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

Formats the value using the given formatter.

impl Default for ObserveInput

fn default() -> ObserveInput

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ObserveInput

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ObserveInput

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for ObserveInput

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

where __S: Serializer,

Serialize this value into the given Serde serializer.