Struct RustRuntimeServices

pub struct RustRuntimeServices<'a> { /* private fields */ }

Implementations

impl RustRuntimeServices<'_>

pub fn backend(&self) -> FlowBackend

What backend the flow is being running on (e.g: locally, ADO, GitHub, etc…)

pub fn platform(&self) -> FlowPlatform

What platform the flow is being running on (e.g: windows, linux, etc…).

pub fn arch(&self) -> FlowArch

What arch the flow is being running on (X86_64 or Aarch64)

pub fn write<T>(&mut self, var: WriteVar<T, VarClaimed>, val: &T)

where T: Serialize + DeserializeOwned,

Write a value.

If this step has already read a secret value, then this will be written as a secret value, as a conservative estimate to avoid leaking secrets. Use write_secret or write_not_secret to override this behavior.

pub fn write_secret<T>(&mut self, var: WriteVar<T, VarClaimed>, val: &T)

where T: Serialize + DeserializeOwned,

Write a secret value, such as a key or token.

Flowey will avoid logging this value, and if the value is converted to a CI environment variable, the CI system will be told not to print the value either.

pub fn write_not_secret<T>(&mut self, var: WriteVar<T, VarClaimed>, val: &T)

where T: Serialize + DeserializeOwned,

Write a value that is not secret, even if this step has already read secret values.

Usually write is preferred–use this only when your step reads secret values and you explicitly want to write a non-secret value.

pub fn write_all<T>( &mut self, vars: impl IntoIterator<Item = WriteVar<T, VarClaimed>>, val: &T, )

where T: Serialize + DeserializeOwned,

pub fn read<T>(&mut self, var: T) -> <T as ReadVarValue>::Value

where T: ReadVarValue,

pub fn dangerous_gh_set_global_env_var( &mut self, var: String, gh_env_var: String, ) -> Result<(), Error>

DANGEROUS: Set the value of Global Environment Variable (GitHub Actions only).

It is up to the caller to ensure that the variable does not get unintentionally overwritten or used.

This method should be used rarely and with great care!