Crate peace_core

source ·
Expand description

Low level data types for the peace automation framework.

This crate exists because:

  • peace_cfg has a dependency on peace_resources for Resources, used in ItemSpec::setup.

  • peace_resources has a dependency on ItemSpecId, as uses TypeMap<ItemSpecId, _> for the States maps.

  • peace_resources also depends on progress::ProgressLimit for OpCheckStatus, which makes up OpCheckStatuses.

    When peace#67 is implemented, the progress module can be moved out of peace_core into peace_cfg.

Macros

  • app_name
    Returns a const AppName validated at compile time.
  • flow_id
    Returns a const FlowId validated at compile time.
  • item_spec_id
    Returns a const ItemSpecId validated at compile time.
  • profile
    Returns a const Profile validated at compile time.

Structs

  • AppName
    Name of the application that is run by end users.
  • AppNameInvalidFmt
    Error indicating AppName provided is not in the correct format.
  • FlowId
    Identifier or name of a process flow.
  • FlowIdInvalidFmt
    Error indicating FlowId provided is not in the correct format.
  • ItemSpecId
    Unique identifier for an ItemSpecId, Cow<'static, str> newtype.
  • ItemSpecIdInvalidFmt
    Error indicating ItemSpecId provided is not in the correct format.
  • Profile
    Identifier or namespace to distinguish execution environments.
  • ProfileInvalidFmt
    Error indicating Profile provided is not in the correct format.

Enums