Struct AppManifest 

#[non_exhaustive]
pub struct AppManifest {
    pub app_version: Option<String>,
    pub git_sha: Option<String>,
    pub jobs: Vec<String>,
    pub critical_jobs: Vec<String>,
    pub crons: Vec<CronEntry>,
    pub base_url: Option<String>,
    pub monitors: Option<Vec<HttpMonitor>>,
    pub process_instance_id: Option<Uuid>,
    pub process_role: Option<String>,
    pub expected_process_roles: Option<Vec<ExpectedProcessRole>>,
}

The shape of the application, as reported once at boot.

manifest_version and booted_at are filled in internally when the manifest is sent ([MANIFEST_VERSION] and Utc::now() respectively).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

app_version: Option<String>

Application build version (e.g. from CARGO_PKG_VERSION).

git_sha: Option<String>

Git commit SHA of the running build.

jobs: Vec<String>

Names of every registered job type.

critical_jobs: Vec<String>

Client-only selector: which of jobs should be marked critical on the wire. Names not also present in jobs are ignored; duplicates are deduplicated. There is no second top-level wire field — see [ManifestPayload::new].

crons: Vec<CronEntry>

Every registered cron entry with its schedule.

base_url: Option<String>

Public origin used to resolve root-relative monitor targets.

monitors: Option<Vec<HttpMonitor>>

None does not participate in monitor authority; Some(vec![]) explicitly removes every declaration for this app.

process_instance_id: Option<Uuid>

process_role: Option<String>

expected_process_roles: Option<Vec<ExpectedProcessRole>>

Implementations

impl AppManifest

pub fn app_version(self, app_version: impl Into<String>) -> AppManifest

pub fn git_sha(self, git_sha: impl Into<String>) -> AppManifest

pub fn jobs(self, jobs: Vec<String>) -> AppManifest

pub fn critical_jobs(self, jobs: Vec<String>) -> AppManifest

Mark a subset of jobs as critical (declares a critical_job_failed run-health monitor for each, once cja adopts process identity). Names not present in jobs are ignored; duplicates are deduplicated.

pub fn crons(self, crons: Vec<CronEntry>) -> AppManifest

pub fn base_url(self, base_url: impl Into<String>) -> AppManifest

pub fn monitors(self, monitors: Vec<HttpMonitor>) -> AppManifest

pub fn process(self, identity: ProcessIdentity) -> AppManifest

pub fn expected_process_roles( self, roles: Vec<ExpectedProcessRole>, ) -> AppManifest

Trait Implementations

impl Clone for AppManifest

fn clone(&self) -> AppManifest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AppManifest

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

Formats the value using the given formatter.

impl Default for AppManifest

fn default() -> AppManifest

Returns the “default value” for a type.

impl PartialEq for AppManifest

fn eq(&self, other: &AppManifest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for AppManifest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for AppManifest

impl StructuralPartialEq for AppManifest