Struct WorkspaceInitializer

pub struct WorkspaceInitializer;

Logic to create peace directories and reads/writes initialization params.

Type Parameters

• WorkspaceInit: Parameters to initialize the workspace.

  These are parameters common to the workspace. Examples:

  • Organization username.
  • Repository URL for multiple environments.

  This may be () if there are no parameters common to the workspace.

• ProfileInit: Parameters to initialize the profile.

  These are parameters specific to a profile, but common to flows within that profile. Examples:

  • Environment specific credentials.
  • URL to publish / download an artifact.

  This may be () if there are no profile specific parameters.

• FlowInit: Parameters to initialize the flow.

  These are parameters specific to a flow. Examples:

  • Configuration to skip warnings for the particular flow.

  This may be () if there are no flow specific parameters.

Implementations

impl WorkspaceInitializer

pub async fn dirs_create<'f, I>(dirs: I) -> Result<(), Error>

where I: IntoIterator<Item = &'f Path>,

Creates directories used by the peace framework.

pub async fn workspace_params_serialize<K>( storage: &Storage, workspace_params: &WorkspaceParams<K>, workspace_params_file: &WorkspaceParamsFile, ) -> Result<(), Error>

where K: Eq + Hash + Serialize + Send + Sync,

pub async fn workspace_params_deserialize<K>( storage: &Storage, type_reg: &TypeReg<K>, workspace_params_file: &WorkspaceParamsFile, ) -> Result<Option<WorkspaceParams<K>>, Error>

where K: Clone + Debug + Eq + Hash + DeserializeOwned + Send + Sync + 'static,

pub async fn profile_params_serialize<K>( storage: &Storage, profile_params: &ProfileParams<K>, profile_params_file: &ProfileParamsFile, ) -> Result<(), Error>

where K: Eq + Hash + Serialize + Send + Sync,

pub async fn profile_params_deserialize<K>( storage: &Storage, type_reg: &TypeReg<K>, profile_params_file: &ProfileParamsFile, ) -> Result<Option<ProfileParams<K>>, Error>

where K: Clone + Debug + Eq + Hash + DeserializeOwned + Send + Sync + 'static,

pub async fn flow_params_serialize<K>( storage: &Storage, flow_params: &FlowParams<K>, flow_params_file: &FlowParamsFile, ) -> Result<(), Error>

where K: Eq + Hash + Serialize + Send + Sync,

pub async fn flow_params_deserialize<K>( storage: &Storage, type_reg: &TypeReg<K>, flow_params_file: &FlowParamsFile, ) -> Result<Option<FlowParams<K>>, Error>

where K: Clone + Debug + Eq + Hash + DeserializeOwned + Send + Sync + 'static,

Trait Implementations

impl Debug for WorkspaceInitializer

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

Formats the value using the given formatter.