Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Treatment conceal

std/secret::conceal


Generics

◻ T (any)

Parameters

↳ var name: string
↳ var plain_reveal: bool = false
↳ var transmission: string = "local"

Inputs

⇥ value: Block<T>

Outputs

↦ error: Block<string>
↦ failed: Block<void>
↦ secret: Block<Secret<T>>


Conceals a value into a secret.

Intended for values only known at runtime, such as a token given by an API response. The secret is named name, its policy is given by transmission (local, reference or value) and plain_reveal (whether the plain reveal treatment may reveal it).

If the secret cannot be created, failed is emitted and error contains the reason.