Module env 

Environment variables used by radicle.

Modules

consts

Constants associated with the current target

Structs

Args

An iterator over the arguments of a process, yielding a String value for each argument.

ArgsOs

An iterator over the arguments of a process, yielding an OsString value for each argument.

JoinPathsError

The error type for operations on the PATH variable. Possibly returned from env::join_paths().

SplitPaths

An iterator that splits an environment variable into paths according to platform-specific conventions.

Vars

An iterator over a snapshot of the environment variables of this process.

VarsOs

An iterator over a snapshot of the environment variables of this process.

Enums

VarError

The error type for operations interacting with environment variables. Possibly returned from env::var().

Constants

GIT_COMMITTER_DATE

RAD_COMMIT_TIME

Environment variable to set to overwrite the commit date for both the author and the committer.

RAD_DEBUG

RAD_HINT

Show radicle hints.

RAD_HOME

Path to the radicle home folder.

RAD_KEYGEN_SEED

Private key seed. Used for generating deterministic keypairs.

RAD_LOCAL_TIME

Override the device’s local time. The format must be a unix timestamp.

RAD_PASSPHRASE

Passphrase for the encrypted radicle secret key.

RAD_RNG_SEED

RNG seed. Must be convertible to a u64.

RAD_SOCKET

Path to the radicle node socket file.

Functions

args

Returns the arguments that this program was started with (normally passed via the command line).

args_os

Returns the arguments that this program was started with (normally passed via the command line).

commit_time

Commit timestamp to use. Can be overriden by RAD_COMMIT_TIME.

current_dir

Returns the current working directory as a PathBuf.

current_exe

Returns the full filesystem path of the current running executable.

debug

Whether debug mode is on.

hints

Whether or not to show hints.

home_dir

Returns the path of the current user’s home directory if known.

join_paths

Joins a collection of Paths appropriately for the PATH environment variable.

local_time

Local time. Can be overriden by RAD_LOCAL_TIME.

pager

Get the configured pager program from the environment.

passphrase

Get the radicle passphrase from the environment.

remove_var^⚠

Removes an environment variable from the environment of the currently running process.

rng

Get a random number generator from the environment.

seed

Return the seed stored in the RAD_KEYGEN_SEED environment variable, or generate a random one.

set_current_dir

Changes the current working directory to the specified path.

set_var^⚠

Sets the environment variable key to the value value for the currently running process.

split_paths

Parses input according to platform conventions for the PATH environment variable.

temp_dir

Returns the path of a temporary directory.

var

Fetches the environment variable key from the current process.

var_os

Fetches the environment variable key from the current process, returning None if the variable isn’t set or if there is another error.

vars

Returns an iterator of (variable, value) pairs of strings, for all the environment variables of the current process.

vars_os

Returns an iterator of (variable, value) pairs of OS strings, for all the environment variables of the current process.