Module node

Core types and traits used to create and work with flowey nodes.

Modules

• erased
• steps
• user_facing
  Node types which are considered “user facing”, and re-exported in the flowey crate.

Structs

• GhUserSecretVar
  Read a custom, user-defined secret by passing in the secret name.
• GhVarState
• ImportCtx
  Context passed to FlowNode::imports.
• NodeCtx
  Context object for a FlowNode.
• NodeHandle
  Cheap handle to a registered FlowNode
• ReadVar
  Read a value from a flowey Var at runtime, returning the value written by the Var’s corresponding WriteVar.
• 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

• CtxAnchor
• 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.
• 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.
• FlowNode
  TODO: clearly verbalize what a FlowNode encompasses
• FlowNodeBase
  The base underlying implementation of all FlowNode variants.
• ImportCtxBackend
• IntoRequest
  A “glue” trait which improves NodeCtx::req ergonomics, by tying a particular Request type to its corresponding FlowNode.
• NodeCtxBackend
• RuntimeVarDb
• 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

• list_all_registered_nodes
• new_import_ctx
• new_node_ctx
• read_var_internals
  DANGER: obtain a ReadVar backing variable and secret status.
• thin_air_read_runtime_var
  DANGER: obtain a handle to a ReadVar “out of thin air”.
• thin_air_write_runtime_var
  DANGER: obtain a handle to a WriteVar “out of thin air”.

Type Aliases

• 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.