Crate schematic

source ·

Modules§

  • color
    ASCII color helpers for use within error messages.
  • env
    Built-in parse_env functions.
  • merge
    Built-in merge functions.
  • schema
    Generate schemas to render into outputs.
  • validate
    Built-in validate functions.

Macros§

Structs§

  • ConfigLoadResult
    The result of loading a configuration. Includes the final configuration, and all layers that were loaded.
  • ConfigLoader
  • Layer
    A layer of configuration that was loaded, and used to create the final state.
  • Meta
    Provides metadata about a configuration struct or enum.
  • ParseError
    Error for a single parse failure. Can be used with TryFrom, [FromStr], or serde.
  • ParserError
    Error related to serde parsing.
  • Path
    Represents the path from the struct root to nested a field or field value.
  • SchemaField
    Represents a field within a schema struct, or a variant within a schema enum/union.
  • ValidateError
    Error for a single validation failure.
  • ValidatorError
    Error that contains multiple validation errors, for each setting that failed.

Enums§

  • ConfigError
    All configuration based errors.
  • ExtendsFrom
    Represents an extendable setting, either a string or a list of strings.
  • Format
    Supported source configuration formats.
  • PathSegment
    Represents all the different forms a path is composed of.
  • SchemaType
    All possible types within a schema.
  • Source
    Source from which to load a configuration.
  • ValidateErrorType
    Either contains a single or multiple validation errors.

Traits§

  • Cacher
    A system for reading and writing to a cache for URL based configurations.
  • Config
    Represents the final configuration, with all settings populated with a value.
  • ConfigEnum
    Represents an enumerable setting for use within a Config.
  • PartialConfig
    Represents a partial configuration of the base Config, with all settings marked as optional by wrapping the values in Option.
  • Schematic
    Defines a schema that represents the shape of the implementing type.

Functions§

  • is_file_like
    Returns true if the value looks like a file, by checking for file://, path separators, or supported file extensions.
  • is_secure_url
    Returns true if the value is a secure URL, by checking for https://. This check can be bypassed for localhost URLs.
  • is_source_format
    Returns true if the value ends in a supported file extension.
  • is_url_like
    Returns true if the value looks like a URL, by checking for http://, https://, or www.

Type Aliases§

Derive Macros§