Crate forc_util

Utility items shared between forc crates.

Modules

• restricted
  Helpers for validating and checking names like package and organization names.
• tx_utils

Macros

• forc_result_bail

Structs

• ForcCliResult
  A wrapper around ForcResult. Designed to be returned from entry points as it handles error reporting and exits with correct exit code.
• ForcError
  A forc error type which is a wrapper around anyhow::Error. It enables propagation of custom exit code alongisde the original error.

Constants

• DEFAULT_ERROR_EXIT_CODE
• DEFAULT_OUTPUT_DIRECTORY
• DEFAULT_SUCCESS_EXIT_CODE

Functions

• default_output_directory
• find_file_name
• find_nested_dir_with_file
  Continually go down in the file tree until a specified file is found.
• find_nested_manifest_dir
  Continually go down in the file tree until a Forc manifest file is found.
• find_parent_dir_with_file
  Continually go up in the file tree until a specified file is found.
• find_parent_manifest_dir
  Continually go up in the file tree until a Forc manifest file is found.
• find_parent_manifest_dir_with_check
  Continually go up in the file tree until a Forc manifest file is found and given predicate returns true.
• git_checkouts_directory
  The location at which forc will checkout git repositories.
• is_sway_file
• kebab_to_snake_case
  Simple function to convert kebab-case to snake_case.
• lock_path
• print_compiling
• print_on_failure
• print_warnings
• program_type_str
• user_forc_directory
  Returns the user’s .forc directory, $HOME/.forc by default.
• validate_name

Type Definitions

• ForcResult
  A result type for forc operations. This shouldn’t be returned from entry points, instead return ForcCliResult to exit with correct exit code.