Module prelude

Source

Re-exports§

pub use anyhow;
pub use fs_err;
pub use log;

Macros§

flowey_request
Declare a new Request type for the current Node.
new_flow_node
new_simple_flow_node

Structs§

AdoResourcesRepositoryId
An ADO repository declared as a resource in the top-level pipeline.
AdoRuntimeVar
Handle to an ADO variable.
AdoStepServices
GhUserSecretVar
Read a custom, user-defined secret by passing in the secret name.
ImportCtx
Context passed to FlowNode::imports.
NodeCtx
Context object for a FlowNode.
Path
A slice of a path (akin to str).
PathBuf
An owned, mutable path (akin to String).
ReadVar
Read a value from a flowey Var at runtime, returning the value written by the Var’s corresponding WriteVar.
RustRuntimeServices
StepCtx
Context object for an individual step.
WriteVar
Write a value into a flowey Var at runtime, which can then be read via a corresponding ReadVar.

Enums§

FlowArch
What architecture the flow is being running on.
FlowBackend
What backend the flow is being running on.
FlowPlatform
What platform the flow is being running on.
FlowPlatformKind
The kind platform the flow is being running on, Windows or Unix.
FlowPlatformLinuxDistro
The kind platform the flow is being running on, Windows or Unix.
GhParam
GhPermission
Refers to the scope of a permission granted to the GITHUB_TOKEN for a job.
GhPermissionValue
The assigned permission value for a scope.
SideEffect
Uninhabited type corresponding to a step which performs a side-effect, without returning a specific value.
VarClaimed
Uninhabited type used to denote that a particular WriteVar / ReadVar is currently claimed by a step, and can be read/written to.
VarNotClaimed
Uninhabited type used to denote that a particular WriteVar / ReadVar is not currently claimed by any step, and cannot be directly accessed.

Traits§

ClaimVar
Claim one or more flowey Vars for a particular step.
Context
Provides the context method for Result.
Deserialize
A data structure that can be deserialized from any data format supported by Serde.
FlowNode
TODO: clearly verbalize what a FlowNode encompasses
FloweyPathExt
Extension trait to streamline working with Path in flowey.
IntoRequest
A “glue” trait which improves NodeCtx::req ergonomics, by tying a particular Request type to its corresponding FlowNode.
Serialize
A data structure that can be serialized into any data format supported by Serde.
SimpleFlowNode
A helper trait to streamline implementing FlowNode instances that only ever operate on a single request at a time.
VarEqBacking
Check if ReadVar / WriteVar instances are backed by the same underlying flowey Var.

Functions§

same_across_all_reqs
Helper method to streamline request validation in cases where a value is expected to be identical across all incoming requests.
same_across_all_reqs_backing_var
Helper method to streamline request validation in cases where a value is expected to be identical across all incoming requests, using a custom comparison function.

Type Aliases§

ClaimedGhParam
ClaimedReadVar
A ReadVar which has been claimed by a particular step, allowing it to be read at runtime.
ClaimedWriteVar
A WriteVar which has been claimed by a particular step, allowing it to be written to at runtime.

Derive Macros§

Deserialize
Serialize