Skip to content

Provide Foundry Documentation

structural_functions

Initializing search

provide-io/provide-io

Home
Getting Started
Foundation
TestKit
FlavorPack
Pyvider
Pyvider CTY
Pyvider HCL
Pyvider RPC Plugin
Pyvider Components
WrkNv
Foundry
Guides
Packages

Provide Foundry Documentation

provide-io/provide-io

Home
Getting Started
Foundation
Foundation
- Ecosystem
- Overview
  Overview
- Getting Started
  Getting Started
- How-To Guides
  How-To Guides
  - Logging
    Logging
    
    Basic Logging
    
    Exception Logging
    
    Structured Events
    
    Custom Processors
  - Configuration
    Configuration
    
    Environment Variables
    
    File-Based Config
    
    Secret Management
  - CLI
    CLI
    
    Building Commands
    
    Argument Parsing
    
    Interactive Prompts
  - File Operations
    File Operations
    
    Atomic Writes
    
    File Watching
  - Cryptography
    Cryptography
    
    Key Generation
    
    Signing & Verification
    
    Certificates
  - HTTP & APIs
    HTTP & APIs
    
    Making Requests
    
    Custom Middleware
  - Testing
    Testing
    
    Unit Testing
    
    Testing CLI Commands
  - Resilience
    Resilience
    
    Retry Patterns
    
    Circuit Breakers
  - Production
    Production
    
    Deployment Patterns
    
    Monitoring & Observability
  - Troubleshooting
- Concepts
  Concepts
  - How Foundation Works
  - Dependency Injection
- Reference
  Reference
  - Core
    
    Core
    
    Hub
    
    Config
    
    Errors
    
    State
  - CLI & Console
    
    CLI & Console
    
    Console
    
    Context
  - Resilience & Observability
    
    Resilience & Observability
    
    Metrics
    
    Tracer
    
    Observability
  - Data & Files
    
    Data & Files
    
    Archive
    
    Serialization
    
    Streams
  - Security
    
    Security
    
    Security
  - Utilities
    
    Utilities
    
    Concurrency
    
    Formatting
    
    Time
    
    Process
    
    Platform
    
    Transport
    
    Parsers
  - Advanced
    
    Advanced
    
    Profiling
    
    Testmode
    
    Integrations
- Specs
TestKit
TestKit
- Getting Started
  Getting Started
  - Installation
  - Quick Start
- API Reference
  API Reference
FlavorPack
FlavorPack
- Roadmap
- Getting Started
  Getting Started
- Tutorials
  Tutorials
  - HTTPie Wrapper
- User Guide
  User Guide
  - Core Concepts
    
    Core Concepts
    
    PSPF Format
    
    Package Structure
    
    Work Environments
    
    Security Model
    
    Helper Binaries
  - Building Packages
    
    Building Packages
    
    Python Applications
    
    Manifest Files
    
    Configuration
    
    Signing Packages
    
    Platform Support
  - Using Packages
    
    Using Packages
    
    Running Packages
    
    CLI Reference
    
    Inspecting Packages
    
    Cache Management
    
    Environment Variables
  - Advanced Topics
    
    Advanced Topics
    
    Cross-Language Support
    
    Custom Launchers
    
    Custom Builders
    
    Performance Tuning
    
    Debugging
- API Guide
  API Guide
- Full API Reference
  Full API Reference
  - flavor
    
    flavor
    
    cache
    
    cli
    
    commands
    
    commands
    
    extract
    
    helpers
    
    inspect
    
    keygen
    
    package
    
    utils
    
    verify
    
    workenv
    
    config
    
    config
    
    config
    
    defaults
    
    manager
    
    console
    
    exceptions
    
    helpers
    
    helpers
    
    binary_loader
    
    manager
    
    locking
    
    output
    
    package
    
    packaging
    
    packaging
    
    keys
    
    orchestrator
    
    orchestrator_helpers
    
    python
    
    python
    
    dependency_resolver
    
    dist_manager
    
    environment_builder
    
    packager
    
    pypapip_manager
    
    slot_builder
    
    uv_manager
    
    wheel_builder
    
    psp
    
    psp
    
    format_2025
    
    format_2025
    
    backends
    
    builder
    
    constants
    
    environment
    
    executor
    
    extraction
    
    generated
    
    generated
    
    modules
    
    handlers
    
    keys
    
    launcher
    
    metadata
    
    metadata
    
    assembly
    
    operations
    
    pe_utils
    
    pspf_builder
    
    reader
    
    slots
    
    spec
    
    validation
    
    workenv
    
    writer
    
    metadata
    
    metadata
    
    paths
    
    validators
    
    protocols
    
    security
    
    utils
    
    utils
    
    xor
    
    verification
- Cookbook
  Cookbook
  - Examples
    
    Examples
    
    CLI Tools
    
    Web Applications
  - Recipes
    
    Recipes
    
    Docker Integration
    
    CI/CD Pipelines
    
    Multi-Platform Builds
- Reference
  Reference
  - System Requirements
  - Glossary
  - Specification
    Specification
    
    PSPF 2025
    
    Slot Descriptor Spec
    
    FEP-0001 Core Format
    
    FEP-0002 JSON Metadata
    
    FEP-0003 Operation Registry
    
    Future Enhancements
    Future Enhancements
    
    FEP-0004 Supply Chain JIT
    
    FEP-0005 Runtime JIT
    
    FEP-0006 Staged Payload
  - Troubleshooting
    
    Troubleshooting
    
    Common Issues
    
    Error Messages
    
    Platform-Specific
    
    Platform-Specific
    
    macOS Issues
    
    Linux Issues
    
    Windows Issues
    
    FAQ
  - Development
    
    Development
    
    Contributing
    
    Architecture
    
    Building Helpers
    
    Testing
    
    Testing
    
    Unit Tests
    
    Taster vs Pretaster
    
    Integration Tests
    
    Cross-Language Tests
    
    CI/CD
    
    Release Process
  - Community
    
    Community
    
    Getting Support
    
    Discussions
    
    Contributing
    
    Blog
    
    Changelog
    
    License
Pyvider
Pyvider
- Getting Started
  Getting Started
- Tutorials
  Tutorials
- How-To Guides
  How-To Guides
  - Resources
    Resources
    
    Create a Resource
    
    Add Validation
  - Data Sources
    Data Sources
    
    Create a Data Source
    
    Handle Pagination
  - Building Components
    Building Components
    
    Creating Providers
    
    Creating Functions
    
    Using Decorators
  - Development
    Development
    
    Testing Providers
    
    Debugging
    
    Logging
    
    Error Handling
  - Production
    Production
    
    Best Practices
    
    Production Readiness
    
    Security Best Practices
    
    Performance Optimization
  - Advanced
    Advanced
    
    Provider Lifecycle
    
    Advanced Patterns
    
    Advanced Provider Features
  - Usage
    Usage
    
    Configuration
    
    Managing Resources
    
    Using Data Sources
    
    Using Functions
- Explanation
  Explanation
- Reference
  Reference
  - Resource Lifecycle
  - Data Source API
  - Examples
    Examples
    
    Pyvider Components
- Schema System
  Schema System
- 🔬 Capabilities (Experimental)
  🔬 Capabilities (Experimental)
  - Overview
- API Guide
  API Guide
  - CLI
  - Common
  - Hub
  - Providers
    
    Providers
  - Resources
  - Data Sources
  - Functions
  - Ephemeral Resources
  - Exceptions
  - Observability
  - Schema
    
    Schema
    
    Types
  - Conversion
  - Protocols
- Full API Reference
  Full API Reference
  - pyvider
    
    pyvider
    
    capabilities
    
    capabilities
    
    base
    
    decorators
    
    cli
    
    cli
    
    components_commands
    
    config_commands
    
    context
    
    install_command
    
    launch_context_command
    
    main
    
    provide_command
    
    utils
    
    common
    
    common
    
    config
    
    context
    
    encryption
    
    launch_context
    
    operation_context
    
    types
    
    utils
    
    utils
    
    attrs_factory
    
    availability
    
    conversion
    
    conversion
    
    adapter
    
    context
    
    marshaler
    
    schema_adapter
    
    utils
    
    data_sources
    
    data_sources
    
    base
    
    decorators
    
    ephemerals
    
    ephemerals
    
    base
    
    context
    
    decorators
    
    exceptions
    
    exceptions
    
    base
    
    foundation
    
    function
    
    grpc
    
    provider
    
    registry
    
    resource
    
    schema
    
    serialization
    
    validation
    
    functions
    
    functions
    
    adapters
    
    base
    
    decorators
    
    handler
    
    hub
    
    hub
    
    components
    
    discovery
    
    validators
    
    observability
    
    observability
    
    metrics
    
    protocols
    
    protocols
    
    service
    
    tfprotov6
    
    tfprotov6
    
    handlers
    
    handlers
    
    apply_resource_change
    
    call_function
    
    close_ephemeral_resource
    
    configure_provider
    
    get_functions
    
    get_metadata
    
    get_provider_schema
    
    import_resource_state
    
    move_resource_state
    
    open_ephemeral_resource
    
    plan_resource_change
    
    read_data_source
    
    read_resource
    
    renew_ephemeral_resource
    
    stop_provider
    
    upgrade_resource_state
    
    utils
    
    validate_data_resource_config
    
    validate_ephemeral_resource_config
    
    validate_provider_config
    
    validate_resource_config
    
    protobuf
    
    utils
    
    providers
    
    providers
    
    base
    
    config
    
    context
    
    decorators
    
    provider
    
    resources
    
    resources
    
    base
    
    context
    
    decorators
    
    exceptions
    
    lifecycle
    
    private_state
    
    protocol
    
    types
    
    schema
    
    schema
    
    exceptions
    
    factory
    
    transforms
    
    types
    
    types
    
    attribute
    
    blocks
    
    enums
    
    object
    
    schema
    
    types_base
    
    testmode
    
    testmode
    
    fixtures
- ⚡ Quick Reference
- FAQ
- Troubleshooting
- Glossary
- Contributing
  Contributing
  - Guidelines
  - Code of Conduct
- Development
  Development
  - Roadmap
Pyvider CTY
Pyvider CTY
- Getting Started
  Getting Started
- User Guide
  User Guide
  - Core Concepts
    Core Concepts
    
    Understanding Types
    
    Working with Values
    
    Validation
    
    Type Conversion
  - Type Reference
    Type Reference
    
    Primitive Types
    
    Collection Types
    
    Structural Types
    
    Dynamic Types
    
    Capsule Types
  - Advanced Topics
    Advanced Topics
    
    Marks System
    
    Built-in Functions
    
    Serialization
    
    Path Navigation
    
    Terraform Interop
- How-To Guides
  How-To Guides
- API Guide
  API Guide
  - Types
    
    Types
    
    Primitives
    
    Collections
    
    Structural
    
    Capsule
  - Values
  - Conversion
  - Codec
  - Functions
  - Path Navigation
  - Validation
  - Context
- Full API Reference
  Full API Reference
  - pyvider
    
    pyvider
    
    cty
    
    cty
    
    codec
    
    config
    
    config
    
    defaults
    
    runtime
    
    context
    
    context
    
    validation_context
    
    conversion
    
    conversion
    
    adapter
    
    explicit
    
    inference_cache
    
    raw_to_cty
    
    type_encoder
    
    exceptions
    
    exceptions
    
    base
    
    conversion
    
    encoding
    
    validation
    
    functions
    
    functions
    
    bytes_functions
    
    collection_functions
    
    comparison_functions
    
    conversion_functions
    
    datetime_functions
    
    encoding_functions
    
    numeric_functions
    
    string_functions
    
    structural_functions structural_functions
    Table of contents
    
    structural_functions
    
    Classes
    
    marks
    
    parser
    
    path
    
    path
    
    base
    
    types
    
    types
    
    base
    
    capsule
    
    capsule_types
    
    collections
    
    collections
    
    list
    
    map
    
    set
    
    primitives
    
    primitives
    
    bool
    
    number
    
    string
    
    structural
    
    structural
    
    dynamic
    
    object
    
    tuple
    
    validation
    
    validation
    
    recursion
    
    values
    
    values
    
    base
    
    markers
- Reference
  Reference
Pyvider HCL
Pyvider HCL
- Getting Started
- User Guide
- Architecture
- Guides
  Guides
- API Reference
  API Reference
  - pyvider
    
    pyvider
    
    hcl
    
    hcl
    
    exceptions
    
    factories
    
    factories
    
    resources
    
    types
    
    variables
    
    output
    
    output
    
    formatting
    
    parser
    
    parser
    
    base
    
    context
    
    inference
    
    terraform
    
    terraform
    
    config
Pyvider RPC Plugin
Pyvider RPC Plugin
- Introduction
  Introduction
  - Foundation Integration
- Getting Started
  Getting Started
- User Guide
  User Guide
  - Core Concepts
    
    Core Concepts
    
    RPC Architecture
    
    Transports
    
    Protocols
    
    Handshake Process
    
    Security Model
  - Server Development
    
    Server Development
    
    Basic Server Setup
    
    Service Implementation
    
    Transport Configuration
    
    Async Patterns
    
    Health Checks
  - Client Development
    
    Client Development
    
    Basic Client Setup
    
    Connection Management
    
    Direct Connections
    
    Error Handling
    
    Retry Logic
  - Security
    
    Security
    
    mTLS Configuration
    
    Certificate Management
    
    Certificate API Reference
    
    Magic Cookies
    
    Process Isolation
  - Configuration
    
    Configuration
    
    Configuration Reference
    
    Config vs Factory Parameters
    
    Client Configuration
    
    Server Configuration
    
    Security Configuration
    
    Advanced Configuration
    
    Environment Variables
    
    Production Setup
    
    Rate Limiting
    
    Logging Configuration
  - Advanced Topics
    
    Advanced Topics
    
    Type System
    
    Custom Protocols
    
    Performance Tuning
    
    Telemetry & Observability
    
    Middleware
    
    Plugin Lifecycle
  - Best Practices
- API Reference
  API Reference
  - None
- Examples
  Examples
  - Echo Service Examples
    Echo Service Examples
    
    Basic Echo
    
    Intermediate Patterns
    
    Advanced Patterns
  - Short Examples
    Short Examples
    
    Basic Client
    
    Basic Server
    
    Health Check
    
    Rate Limiting
    
    TCP Transport
    
    Custom Protocol
- Development
  Development
Pyvider Components
Pyvider Components
- Guides
  Guides
  - Understand the Pyvider Framework
  - Build Your Own Provider with Pyvider
- Resources
  Resources
  - timed_token
- Data Sources
  Data Sources
- Functions
  Functions
  - add
  - contains
  - divide
  - format
  - format_size
  - join
  - length
  - lookup
  - lower
  - max
  - min
  - multiply
  - pluralize
  - replace
  - round
  - split
  - subtract
  - sum
  - to_camel_case
  - to_kebab_case
  - to_snake_case
  - tostring
  - truncate
  - upper
- File Operations
  File Operations
  - Resources
    Resources
    
    file_content
    
    local_directory
  - Data Sources
    Data Sources
    
    file_info
- Lens
  Lens
  - Data Sources
    Data Sources
    
    lens_jq
  - Functions
    Functions
    
    lens_jq
- Network
  Network
  - Data Sources
    Data Sources
    
    http_api
- Test Mode
  Test Mode
  - Resources
    Resources
    
    private_state_verifier
    
    warning_example
  - Data Sources
    Data Sources
    
    mixed_map_test
    
    nested_resource_test
    
    simple_map_test
    
    structured_object_test
WrkNv
WrkNv
- API Reference
  API Reference
  - wrknv
    
    wrknv
    
    cli
    
    cli
    
    commands
    
    commands
    
    config
    
    container
    
    doctor
    
    gitignore
    
    lock
    
    profile
    
    secrets
    
    setup
    
    terraform
    
    tools
    
    workspace
    
    hub_cli
    
    nested_commands
    
    visual
    
    config
    
    config
    
    core
    
    defaults
    
    display
    
    persistence
    
    sources
    
    validation
    
    container
    
    container
    
    commands
    
    core
    
    errors
    
    manager
    
    metadata
    
    operations
    
    operations
    
    build
    
    exec
    
    lifecycle
    
    logs
    
    volumes
    
    runtime
    
    runtime
    
    base
    
    docker
    
    shell_commands
    
    storage
    
    errors
    
    gitignore
    
    gitignore
    
    builder
    
    detector
    
    manager
    
    templates
    
    lockfile
    
    logging
    
    logging
    
    emojis
    
    setup
    
    managers
    
    managers
    
    bao
    
    base
    
    factory
    
    github
    
    github
    
    client
    
    types
    
    go
    
    subrosa
    
    subrosa
    
    bao
    
    base
    
    ibm
    
    tf
    
    tf
    
    base
    
    bin_ops
    
    ibm
    
    metadata
    
    tofu
    
    utils
    
    uv
    
    testing
    
    testing
    
    helpers
    
    utils
    
    utils
    
    python_version
    
    version_resolver
    
    wenv
    
    wenv
    
    bin_manager
    
    completions
    
    doctor
    
    env_generator
    
    exceptions
    
    operations
    
    operations
    
    download
    
    install
    
    platform
    
    verify
    
    resilience
    
    schema
    
    workenv
    
    workspace
    
    workspace
    
    discovery
    
    manager
    
    schema
    
    sync
Foundry
Foundry
Guides
Guides
Packages
Packages
- Foundation
- TestKit
- FlavorPack
- Pyvider
- Pyvider CTY
- Pyvider HCL
- Pyvider RPC Plugin
- Pyvider Components
- Plating
- TofuSoup
- SupSrc
- WrkNv

Table of contents

structural_functions
- Classes

structural_functions

pyvider.cty.functions.structural_functions ¶

TODO: Add module docstring.

Classes¶

string_functions

Made with Material for MkDocs