ComposeLens

https://docs.rs/compose-lens/0.1.16/compose_lens/
Admin
ComposeLens provides loss-aware parsing, processing, validation, and rendering of Compose projects.
Tokens:62,560
Snippets:1,295
Trust Score:9.1
Update:1 month ago
Show doc for...
Tokens:
Raw
### SourceSpan::new

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/source/struct.SourceSpan.html

Creates a new SourceSpan instance if the start offset is not after the end offset.

```APIDOC
## pub const fn new(source_id: SourceId, start: usize, end: usize) -> Option<Self>

### Description
Creates a span when `start` is not after `end`.
```

--------------------------------

### fn get(&self, name: &str) -> Option<EnvironmentValue>

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/interpolation/trait.EnvironmentProvider.html

Retrieves the value of a variable by its name. Returns the value if found, or None if the variable is unset.

```APIDOC
### Method
`fn get(&self, name: &str) -> Option<EnvironmentValue>`

### Description
Returns a variable value for the given name. If the variable is not defined, it returns `None`.

### Parameters
- **name** (&str) - The name of the environment variable to retrieve.

### Returns
- **Option<EnvironmentValue>** - The value associated with the name, or `None` if unset.
```

--------------------------------

### get(name: &str)

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/project/struct.ProjectAnnotations.html

Finds an effective annotation by its semantic name.

```APIDOC
## pub fn get(&self, name: &str) -> Option<&ProjectAnnotationEntry>

### Description
Finds an effective annotation by name.

### Parameters
- **name** (&str) - The semantic name of the annotation to retrieve.

### Returns
- **Option<&ProjectAnnotationEntry>** - Returns Some(&ProjectAnnotationEntry) if found, otherwise None.
```

--------------------------------

### ProjectDeploy Accessor Methods

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/project/struct.ProjectDeploy.html

Methods to retrieve effective deployment configuration values.

```rust
pub const fn endpoint_mode(&self) -> Option<&ProjectValue<DeployEndpointMode>>
```

```rust
pub const fn labels(&self) -> Option<&ProjectValue<ProjectLabels>>
```

```rust
pub const fn mode(&self) -> Option<&ProjectValue<DeployMode>>
```

```rust
pub const fn placement(&self) -> Option<&ProjectValue<ProjectDeployPlacement>>
```

```rust
pub const fn replicas(&self) -> Option<&ProjectValue<DeployReplicas>>
```

```rust
pub const fn resources(&self) -> Option<&ProjectValue<ProjectDeployResources>>
```

```rust
pub const fn restart_policy( &self, ) -> Option<&ProjectValue<ProjectDeployRestartPolicy>>
```

```rust
pub const fn rollback_config( &self, ) -> Option<&ProjectValue<ProjectDeployRollbackConfig>>
```

```rust
pub const fn update_config( &self, ) -> Option<&ProjectValue<ProjectDeployUpdateConfig>>
```

```rust
pub fn unmodeled_fields(&self) -> &[ProjectFieldReference]
```

--------------------------------

### ImplementationVersion::new

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/validation/struct.ImplementationVersion.html

Creates a new instance of ImplementationVersion with the specified major, minor, and patch components.

```APIDOC
## pub const fn new(major: u32, minor: u32, patch: u32) -> Self

### Description
Creates an exact numeric version representation.

### Parameters
- **major** (u32) - The major version component.
- **minor** (u32) - The minor version component.
- **patch** (u32) - The patch version component.
```

--------------------------------

### EnvironmentProvider Trait Definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/interpolation/trait.EnvironmentProvider.html

The core trait definition requiring a get method to retrieve environment variables.

```rust
pub trait EnvironmentProvider {
    // Required method
    fn get(&self, name: &str) -> Option<EnvironmentValue>;
}
```

--------------------------------

### Forbidden Destructuring Example

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/struct.BuildSsh.html

Demonstrates that the internal storage field cannot be accessed directly via pattern matching.

```rust
use compose_lens::model::BuildSsh;

fn forbidden(ssh: BuildSsh) {
    let BuildSsh { storage } = ssh;
}
```

--------------------------------

### PreStartServiceHook Definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/struct.PreStartServiceHook.html

The structure definition for PreStartServiceHook.

```rust
pub struct PreStartServiceHook { /* private fields */ }
```

--------------------------------

### ComposeDocumentBuilder::new

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/render/struct.ComposeDocumentBuilder.html

Creates a new, empty instance of the ComposeDocumentBuilder.

```APIDOC
## pub const fn new() -> Self

### Description
Creates an empty generated project builder.
```

--------------------------------

### ProjectPreStartServiceHook Struct Definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/project/struct.ProjectPreStartServiceHook.html

The definition of the ProjectPreStartServiceHook struct.

```rust
pub struct ProjectPreStartServiceHook { /* private fields */ }
```

--------------------------------

### GeneratedMount::bind

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/render/struct.GeneratedMount.html

Creates a bind mount. SELinux relabel intent selects short syntax deliberately. Rejects empty/NUL-bearing values and certain characters if SELinux is present.

```APIDOC
### pub fn bind(source: impl Into<String>, target: impl Into<String>, read_only: bool, selinux: Option<GeneratedSelinux>) -> Result<Self, GenerationError>

Creates a bind mount.
```

--------------------------------

### DocumentOrigin::new

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/loader/struct.DocumentOrigin.html

Creates a new instance of DocumentOrigin with a specified label and directory.

```APIDOC
## pub fn new(label: impl Into<String>, directory: impl Into<PathBuf>) -> Self

### Description
Creates an explicit document origin. The label is used for display purposes, while the directory is retained for path-resolution decisions.

### Parameters
- **label** (impl Into<String>) - Required - The display name or identifier for the document.
- **directory** (impl Into<PathBuf>) - Required - The directory path associated with the document.
```

--------------------------------

### CompatibilityProfile Methods

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/validation/struct.CompatibilityProfile.html

Methods for creating and configuring a CompatibilityProfile instance.

```APIDOC
## CompatibilityProfile

### specification()
Creates the specification-oriented profile.

### docker_compose(version: ImplementationVersion)
Creates a Docker Compose profile for an exact provider version.

### podman_compose(version: ImplementationVersion)
Creates a containers/podman-compose profile for an exact provider version.

### tolerant()
Creates a tolerant preservation profile that makes no implementation-support claim.

### with_runtime(runtime: ContainerRuntime)
Attaches the exact backend runtime selected by the caller.

### provider()
Returns the selected Compose provider.

### runtime()
Returns the selected backend runtime, if supplied.

### classify(feature: CompatibilityFeature)
Classifies one feature using only versioned built-in evidence.
```

--------------------------------

### LoadedProject::diagnostics

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/loader/struct.LoadedProject.html

Retrieves syntax and model diagnostics.

```APIDOC
## pub fn diagnostics(&self) -> &[Diagnostic]

### Description
Returns aggregated syntax and typed-model diagnostics in document order.
```

--------------------------------

### GeneratedLogging::new

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/render/struct.GeneratedLogging.html

Creates a new instance of GeneratedLogging with a specified string driver and a list of logging options.

```APIDOC
## pub fn new(driver: GeneratedString, options: Vec<GeneratedLoggingOption>) -> Result<Self, GenerationError>

### Description
Creates an explicit uninterpreted string driver and ordered unique-key options mapping. An empty options vector is retained as `options: {}`. Driver and option values are not normalized, defaulted, or interpreted for any provider.

### Errors
Rejects duplicate option keys.
```

--------------------------------

### POST_START_MISSING_COMMAND Constant Definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/constant.POST_START_MISSING_COMMAND.html

The constant definition for the missing post_start command diagnostic code.

```rust
pub const POST_START_MISSING_COMMAND: DiagnosticCode;
```

--------------------------------

### render_canonical_with_formatting

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/render/index.html

Renders a merged project with explicit presentation-only formatting choices.

```APIDOC
## render_canonical_with_formatting

### Description
Renders a merged project with explicit presentation-only formatting choices.
```

--------------------------------

### DeployReservationDeviceCapabilities struct definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/struct.DeployReservationDeviceCapabilities.html

The primary structure definition for holding ordered resource-reservation device capabilities.

```rust
pub struct DeployReservationDeviceCapabilities { /* private fields */ }
```

--------------------------------

### DocumentInput::new

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/loader/struct.DocumentInput.html

Creates a new DocumentInput instance without reading from the file system or process environment.

```APIDOC
## pub fn new(source_id: SourceId, origin: DocumentOrigin, source: impl Into<Arc<str>>) -> Self

### Description
Creates an input without reading the file system or process environment.

### Parameters
- **source_id** (SourceId) - Required - The caller-managed source identifier.
- **origin** (DocumentOrigin) - Required - The caller-defined document origin.
- **source** (impl Into<Arc<str>>) - Required - The source text content.
```

--------------------------------

### ProjectProviderOption Methods

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/project/struct.ProjectProviderOption.html

Methods available on the ProjectProviderOption struct for retrieving option metadata.

```APIDOC
## pub const fn name(&self) -> &ProjectKey

### Description
Returns the non-empty option name and every authored key location.

## pub const fn value(&self) -> &ProjectValue<ProjectProviderOptionValue>

### Description
Returns the scalar category or ordered sequence with complete merge provenance.
```

--------------------------------

### entries()

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/project/struct.ProjectProviderOptions.html

Returns the valid option entries in effective mapping order.

```APIDOC
### pub fn entries(&self) -> &[ProjectValue<ProjectProviderOption>]

Returns valid option entries in effective mapping order.
```

--------------------------------

### ProjectBuildDefinition Struct Definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/project/struct.ProjectBuildDefinition.html

The primary structure definition for build configurations.

```rust
pub struct ProjectBuildDefinition { /* private fields */ }
```

--------------------------------

### GeneratedExtraHost::new

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/render/struct.GeneratedExtraHost.html

Creates a new GeneratedExtraHost instance representing a hostname=address relationship.

```APIDOC
## pub fn new(hostname: impl Into<String>, address: impl Into<String>) -> Result<Self, GenerationError>

### Description
Creates a short-form `hostname=address` relationship. This method validates the input to ensure it does not contain empty values, NUL characters, or the reserved `=` separator.

### Parameters
- **hostname** (impl Into<String>) - Required - The hostname for the relationship.
- **address** (impl Into<String>) - Required - The address or implementation token for the relationship.

### Errors
- Returns a `GenerationError` if the inputs are invalid (e.g., empty or containing NUL characters).
```

--------------------------------

### entries()

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/project/struct.ProjectAnnotations.html

Returns the effective annotations in first-key order.

```APIDOC
## pub fn entries(&self) -> &[ProjectAnnotationEntry]

### Description
Returns effective annotations in first-key order.

### Returns
- **&[ProjectAnnotationEntry]** - A slice of effective annotation entries.
```

--------------------------------

### GeneratedVolumeDriverOption::new

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/render/struct.GeneratedVolumeDriverOption.html

Creates a new driver option with a specified name and value. It validates that the key is non-empty and does not contain NUL characters.

```APIDOC
## fn new(name: impl Into<String>, value: GeneratedVolumeDriverOptionValue) -> Result<Self, GenerationError>

### Description
Creates one driver option with a non-empty key and a string or number value.

### Parameters
- **name** (impl Into<String>) - Required - The option key.
- **value** (GeneratedVolumeDriverOptionValue) - Required - The string or number value for the option.

### Errors
Rejects an empty or NUL-bearing key and number spellings that are not exactly one YAML number scalar.
```

--------------------------------

### LoadedProject::interpolate_with_options

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/loader/struct.LoadedProject.html

Performs interpolation with specific configuration options.

```APIDOC
## pub fn interpolate_with_options(&self, environment: &dyn EnvironmentProvider, options: InterpolationOptions) -> ProjectInterpolation

### Description
Interpolates each document independently with explicit options.
```

--------------------------------

### ProjectDeployUpdateConfig Definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/project/struct.ProjectDeployUpdateConfig.html

The primary structure definition for deployment update configurations.

```rust
pub struct ProjectDeployUpdateConfig { /* private fields */ }
```

--------------------------------

### Function signature for build_project_view

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/project/fn.build_project_view.html

The function signature for building a project view from a merged project and an optional profile selection.

```rust
pub fn build_project_view(
    project: &MergedProject,
    selection: Option<&ProfileSelection>,
) -> ProjectViewResult
```

--------------------------------

### DeployReservationDevice Struct Definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/struct.DeployReservationDevice.html

The primary structure definition for a deploy resource-reservation device.

```rust
pub struct DeployReservationDevice { /* private fields */ }
```

--------------------------------

### render_canonical

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/render/index.html

Renders a merged project as deterministic ComposeLens canonical YAML.

```APIDOC
## render_canonical

### Description
Renders a merged project as deterministic `ComposeLens` canonical YAML.
```

--------------------------------

### ComposeDefaults::new

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/resolution/struct.ComposeDefaults.html

Creates a new instance of ComposeDefaults for the specified container platform.

```APIDOC
## pub const fn new(platform: ContainerPlatform) -> Self

### Description
Creates a specification-oriented provider for the target container platform.

### Parameters
- **platform** (ContainerPlatform) - Required - The target container platform for the defaults.
```

--------------------------------

### ProjectDeployResourceLimits Struct Definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/project/struct.ProjectDeployResourceLimits.html

The primary structure definition for managing deploy resource limits.

```rust
pub struct ProjectDeployResourceLimits { /* private fields */ }
```

--------------------------------

### DeployReservationDeviceOptionItem Struct Definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/struct.DeployReservationDeviceOptionItem.html

The definition of the DeployReservationDeviceOptionItem struct.

```rust
pub struct DeployReservationDeviceOptionItem { /* private fields */ }
```

--------------------------------

### LoadedProject::documents

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/loader/struct.LoadedProject.html

Retrieves the list of documents in the order they were provided.

```APIDOC
## pub fn documents(&self) -> &[LoadedDocument]

### Description
Returns documents in caller-supplied merge order.
```

--------------------------------

### Define ProjectLoggingOptions struct

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/project/struct.ProjectLoggingOptions.html

The internal structure definition for ProjectLoggingOptions.

```rust
pub struct ProjectLoggingOptions { /* private fields */ }
```

--------------------------------

### SyntaxDocument::parse

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/syntax/struct.SyntaxDocument.html

Parses YAML source text into a loss-aware document and structured diagnostics.

```APIDOC
## pub fn parse(source_id: SourceId, source: impl Into<Arc<str>>) -> Result<SyntaxParse, SyntaxParseError>

### Description
Parses YAML into a loss-aware document and structured diagnostics. Recoverable YAML errors are returned in the diagnostics field while the syntax document remains available.

### Parameters
- **source_id** (SourceId) - Required - The identifier for the source.
- **source** (impl Into<Arc<str>>) - Required - The YAML source text to parse.

### Returns
- **Result<SyntaxParse, SyntaxParseError>** - Returns a SyntaxParse object on success, or a SyntaxParseError if the source exceeds byte-offset capacity.
```

--------------------------------

### ProjectDeployReservationDeviceOptionItem Definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/project/struct.ProjectDeployReservationDeviceOptionItem.html

The struct definition for ProjectDeployReservationDeviceOptionItem.

```rust
pub struct ProjectDeployReservationDeviceOptionItem { /* private fields */ }
```

--------------------------------

### GeneratedEnvironment::host

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/render/struct.GeneratedEnvironment.html

Creates a host-resolved key-only environment entry. Rejects names that are empty, contain NUL bytes, or contain '='.

```APIDOC
## pub fn host(name: impl Into<String>) -> Result<Self, GenerationError>

### Description
Creates a host-resolved key-only environment entry.

### Errors
Rejects an empty/NUL-bearing name or a name containing '='.
```

--------------------------------

### GeneratedMount::target

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/render/struct.GeneratedMount.html

Returns the container target path.

```APIDOC
### pub fn target(&self) -> &str

Returns the container target path.
```

--------------------------------

### ImplementationVersion Accessors

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/validation/struct.ImplementationVersion.html

Methods to retrieve the individual components of an ImplementationVersion.

```APIDOC
## pub const fn major(self) -> u32
Returns the major component.

## pub const fn minor(self) -> u32
Returns the minor component.

## pub const fn patch(self) -> u32
Returns the patch component.
```

--------------------------------

### ComposeDocumentBuilder::build

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/render/struct.ComposeDocumentBuilder.html

Finalizes the construction and generates the document.

```APIDOC
## pub fn build(self, source_id: SourceId) -> Result<GeneratedComposeDocument, GenerationError>

### Description
Generates YAML and parses it back through ComposeLens’s syntax and typed-model boundaries. Returns GenerationError::MissingService for an empty project or GenerationError::InternalInvariant if parsing fails.
```

--------------------------------

### GeneratedEnvironment::name

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/render/struct.GeneratedEnvironment.html

Returns the environment name.

```APIDOC
## pub fn name(&self) -> &str

### Description
Returns the environment name.
```

--------------------------------

### IpamConfig struct definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/struct.IpamConfig.html

The primary structure definition for IPAM configuration.

```rust
pub struct IpamConfig { /* private fields */ }
```

--------------------------------

### LoadedProject::base_directory

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/loader/struct.LoadedProject.html

Returns the base directory of the project.

```APIDOC
## pub fn base_directory(&self) -> &Path

### Description
Returns the project directory inherited from the first document.
```

--------------------------------

### pub const fn line(self) -> usize

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/source/struct.LineColumn.html

Returns the one-based line number from the LineColumn instance.

```APIDOC
## pub const fn line(self) -> usize

### Description
Returns the one-based line number associated with the LineColumn instance.

### Returns
- **usize** - The one-based line number.
```

--------------------------------

### GeneratedVolumeDriverOption::name

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/render/struct.GeneratedVolumeDriverOption.html

Retrieves the key associated with the driver option.

```APIDOC
## fn name(&self) -> &str

### Description
Returns the exact non-empty option key.
```

--------------------------------

### ProjectProvider Struct Definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/project/struct.ProjectProvider.html

The primary definition of the ProjectProvider struct.

```rust
pub struct ProjectProvider { /* private fields */ }
```

--------------------------------

### Accessing DEPLOY_RESERVATION_DEVICE_OPTIONS_EXPECTED_FORM

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/constant.DEPLOY_RESERVATION_DEVICE_OPTIONS_EXPECTED_FORM.html

The constant is defined as a DiagnosticCode within the compose_lens::model module.

```rust
pub const DEPLOY_RESERVATION_DEVICE_OPTIONS_EXPECTED_FORM: DiagnosticCode;
```

--------------------------------

### SyntaxParseError::byte_len

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/syntax/struct.SyntaxParseError.html

Returns the length of the source that was rejected in bytes.

```APIDOC
### pub const fn byte_len(self) -> usize

Returns the rejected source length in bytes.
```

--------------------------------

### ProjectDeploy Struct Definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/project/struct.ProjectDeploy.html

The primary structure definition for ProjectDeploy.

```rust
pub struct ProjectDeploy { /* private fields */ }
```

--------------------------------

### GeneratedLoggingOption::new

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/render/struct.GeneratedLoggingOption.html

Creates a new logging option with a specified name and value. The name must be non-empty and not contain NUL characters.

```APIDOC
## pub fn new(name: impl Into<String>, value: GeneratedLoggingOptionValue) -> Result<Self, GenerationError>

### Description
Creates one option with a non-empty key and a string, number, or null value.

### Parameters
- **name** (impl Into<String>) - Required - The option key.
- **value** (GeneratedLoggingOptionValue) - Required - The value associated with the key.

### Errors
- Rejects an empty or NUL-bearing key.
- Rejects number spellings that are not exactly one YAML number scalar.
```

--------------------------------

### DeployUpdateConfig Struct Definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/struct.DeployUpdateConfig.html

The primary structure definition for rolling-update configurations.

```rust
pub struct DeployUpdateConfig { /* private fields */ }
```

--------------------------------

### GeneratedLogging::options

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/render/struct.GeneratedLogging.html

Retrieves the logging options associated with the GeneratedLogging instance.

```APIDOC
## pub fn options(&self) -> &[GeneratedLoggingOption]

### Description
Returns options in generated mapping order.
```

--------------------------------

### InterpolationOptions::new

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/interpolation/struct.InterpolationOptions.html

Creates a new instance of InterpolationOptions with a specified missing-variable policy.

```APIDOC
## pub const fn new(missing_variable: MissingVariablePolicy) -> Self

### Description
Creates a new InterpolationOptions instance using the requested missing-variable policy.

### Parameters
- **missing_variable** (MissingVariablePolicy) - Required - The policy to apply when a variable is missing.
```

--------------------------------

### Create a new GeneratedLongDevice

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/render/struct.GeneratedLongDevice.html

Constructs a new instance from safe resolved strings, rejecting inputs containing NUL bytes, newlines, or dollar signs.

```rust
pub fn new( source: GeneratedString, target: Option<GeneratedString>, permissions: Option<GeneratedString>, ) -> Result<Self, GenerationError>
```

--------------------------------

### BuildExtraHostEntry Definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/struct.BuildExtraHostEntry.html

The structure definition for BuildExtraHostEntry.

```rust
pub struct BuildExtraHostEntry { /* private fields */ }
```

--------------------------------

### DeployDefinition struct definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/struct.DeployDefinition.html

The primary structure definition for DeployDefinition, containing private fields.

```rust
pub struct DeployDefinition { /* private fields */ }
```

--------------------------------

### LoadedProject Struct Definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/loader/struct.LoadedProject.html

The primary structure for holding parsed Compose documents.

```rust
pub struct LoadedProject { /* private fields */ }
```

--------------------------------

### Define ProjectDeployReservationDevice struct

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/project/struct.ProjectDeployReservationDevice.html

The primary definition of the ProjectDeployReservationDevice struct.

```rust
pub struct ProjectDeployReservationDevice { /* private fields */ }
```

--------------------------------

### BuildDefinition Struct Definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/struct.BuildDefinition.html

The primary structure definition for BuildDefinition.

```rust
pub struct BuildDefinition { /* private fields */ }
```

--------------------------------

### Define Entrypoint Enum

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/enum.Entrypoint.html

The structure of the Entrypoint enum, which handles different entrypoint configurations including null, string, and list types.

```rust
pub enum Entrypoint {
    Null(SourceSpan),
    String(Located<String>),
    List {
        span: SourceSpan,
        values: Vec<Located<String>>,
    },
}
```

--------------------------------

### DeployReservationDeviceIds Struct Definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/struct.DeployReservationDeviceIds.html

The primary structure definition for holding resource-reservation device IDs.

```rust
pub struct DeployReservationDeviceIds { /* private fields */ }
```

--------------------------------

### Definition of DEPLOY_RESERVATION_DEVICE_OPTIONS_INVALID_KEY

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/constant.DEPLOY_RESERVATION_DEVICE_OPTIONS_INVALID_KEY.html

The constant is defined as a DiagnosticCode within the compose_lens::model module.

```rust
pub const DEPLOY_RESERVATION_DEVICE_OPTIONS_INVALID_KEY: DiagnosticCode;
```

--------------------------------

### select_profiles

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/profiles/index.html

Selects active services from a merged project using only caller-supplied profiles.

```APIDOC
## select_profiles

### Description
Selects active services from a merged project using only caller-supplied profiles.

### Function Signature
`pub fn select_profiles(...)`
```

--------------------------------

### Define BUILD_EXTRA_HOSTS_EXPECTED_STRING constant

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/constant.BUILD_EXTRA_HOSTS_EXPECTED_STRING.html

The constant is defined as a DiagnosticCode type.

```rust
pub const BUILD_EXTRA_HOSTS_EXPECTED_STRING: DiagnosticCode;
```

--------------------------------

### GeneratedNetworkDriverOption::new

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/render/struct.GeneratedNetworkDriverOption.html

Creates a new network driver option with a specified name and value. It validates that the name is non-empty and does not contain NUL characters.

```APIDOC
## pub fn new(name: impl Into<String>, value: GeneratedNetworkDriverOptionValue) -> Result<Self, GenerationError>

### Description
Creates one driver option with a non-empty key and a string or number value.

### Errors
Rejects an empty or NUL-bearing key and number spellings that are not exactly one YAML number scalar.
```

--------------------------------

### Define VersionRange structure

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/validation/struct.VersionRange.html

The internal structure definition for VersionRange.

```rust
pub struct VersionRange { /* private fields */ }
```

--------------------------------

### build_project_view

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/project/fn.build_project_view.html

Builds native values directly from a merged project without canonical rendering or reparsing. The operation performs no file, environment, provider, or runtime access.

```APIDOC
## build_project_view

### Description
Builds native values directly from a merged project without canonical rendering or reparsing. A matching selection filters inactive services; omitting it includes every service.

### Signature
`pub fn build_project_view(project: &MergedProject, selection: Option<&ProfileSelection>) -> ProjectViewResult`

### Parameters
- **project** (&MergedProject) - Required - The merged project to build from.
- **selection** (Option<&ProfileSelection>) - Optional - A profile selection to filter inactive services.

### Returns
- **ProjectViewResult** - The resulting project view.
```

--------------------------------

### ProjectSecurityOptionItem Struct Definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/project/struct.ProjectSecurityOptionItem.html

The primary structure definition for ProjectSecurityOptionItem.

```rust
pub struct ProjectSecurityOptionItem { /* private fields */ }
```

--------------------------------

### Definition of BUILD_SBOM_EXPECTED_BOOLEAN_OR_STRING

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/constant.BUILD_SBOM_EXPECTED_BOOLEAN_OR_STRING.html

The constant is defined as a DiagnosticCode within the compose_lens::model module.

```rust
pub const BUILD_SBOM_EXPECTED_BOOLEAN_OR_STRING: DiagnosticCode;
```

--------------------------------

### ProjectServiceHook Struct Definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/project/struct.ProjectServiceHook.html

The definition of the ProjectServiceHook struct.

```rust
pub struct ProjectServiceHook { /* private fields */ }
```

--------------------------------

### DeployReservationDeviceCapability struct definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/struct.DeployReservationDeviceCapability.html

The definition of the DeployReservationDeviceCapability struct.

```rust
pub struct DeployReservationDeviceCapability { /* private fields */ }
```

--------------------------------

### LoadedProject::is_valid

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/loader/struct.LoadedProject.html

Checks if the project loaded without errors.

```APIDOC
## pub fn is_valid(&self) -> bool

### Description
Reports whether loading emitted no error diagnostics.
```

--------------------------------

### LoadedProject::load

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/loader/struct.LoadedProject.html

Parses an ordered collection of DocumentInput into a LoadedProject instance.

```APIDOC
## pub fn load(inputs: impl IntoIterator<Item = DocumentInput>) -> Result<Self, ProjectLoadError>

### Description
Parses ordered, caller-supplied documents into a loaded project. No interpolation or merge is performed by this operation.

### Errors
Returns ProjectLoadError when no document is supplied, a source identifier is reused, or one source exceeds the syntax tree’s byte-offset capacity.
```

--------------------------------

### DeployRollbackConfig Struct Definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/struct.DeployRollbackConfig.html

The primary structure definition for the rollback configuration.

```rust
pub struct DeployRollbackConfig { /* private fields */ }
```

--------------------------------

### ConfigDefinition Structure Definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/struct.ConfigDefinition.html

The primary structure definition for ConfigDefinition.

```rust
pub struct ConfigDefinition { /* private fields */ }
```

--------------------------------

### Define ShortExtraHost struct

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/struct.ShortExtraHost.html

The definition of the ShortExtraHost struct with private fields.

```rust
pub struct ShortExtraHost { /* private fields */ }
```

--------------------------------

### select_profiles function signature

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/profiles/fn.select_profiles.html

The function signature for selecting active services from a merged project.

```rust
pub fn select_profiles(
    project: &MergedProject,
    request: &ProfileRequest,
) -> ProfileSelection
```

--------------------------------

### GeneratedLoggingOption::name

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/render/struct.GeneratedLoggingOption.html

Retrieves the key name of the logging option.

```APIDOC
## pub fn name(&self) -> &str

### Description
Returns the exact non-empty option key.
```

--------------------------------

### Accessing DEPLOY_RESERVATION_DEVICE_MISSING_CAPABILITIES

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/constant.DEPLOY_RESERVATION_DEVICE_MISSING_CAPABILITIES.html

The constant is defined as a DiagnosticCode within the compose_lens::model module.

```rust
pub const DEPLOY_RESERVATION_DEVICE_MISSING_CAPABILITIES: DiagnosticCode;
```

--------------------------------

### DNS_EXPECTED_STRING Constant Definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/constant.DNS_EXPECTED_STRING.html

The constant definition for the diagnostic code.

```rust
pub const DNS_EXPECTED_STRING: DiagnosticCode;
```

--------------------------------

### GeneratedPort constructor

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/render/struct.GeneratedPort.html

Creates a new instance of GeneratedPort, validating the target port and host address configuration.

```rust
pub fn new( target: u16, published: Option<u16>, host_ip: Option<String>, protocol: GeneratedProtocol, ) -> Result<Self, GenerationError>
```

--------------------------------

### ProjectDeployPlacement Struct Definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/project/struct.ProjectDeployPlacement.html

The primary definition of the ProjectDeployPlacement struct.

```rust
pub struct ProjectDeployPlacement { /* private fields */ }
```

--------------------------------

### Define ProjectLoggingOption struct

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/project/struct.ProjectLoggingOption.html

The definition of the ProjectLoggingOption struct with private fields.

```rust
pub struct ProjectLoggingOption { /* private fields */ }
```

--------------------------------

### is_empty()

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/project/struct.ProjectProviderOptions.html

Reports whether the effective options mapping has no valid or malformed entries.

```APIDOC
### pub fn is_empty(&self) -> bool

Reports whether the effective options mapping has no valid or malformed entries.
```

--------------------------------

### MapEnvironment Methods

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/interpolation/struct.MapEnvironment.html

Methods available for interacting with the MapEnvironment struct.

```APIDOC
## pub const fn new() -> Self

### Description
Creates an empty environment map.

## pub fn insert(&mut self, name: impl Into<String>, value: impl Into<String>) -> Option<EnvironmentValue>

### Description
Inserts a non-sensitive value and returns the replaced value, if any.

## pub fn insert_sensitive(&mut self, name: impl Into<String>, value: impl Into<String>) -> Option<EnvironmentValue>

### Description
Inserts a sensitive value and returns the replaced value, if any.

## pub fn insert_value(&mut self, name: impl Into<String>, value: EnvironmentValue) -> Option<EnvironmentValue>

### Description
Inserts an already classified value and returns the replaced value, if any.

## pub fn len(&self) -> usize

### Description
Returns the number of configured variables.

## pub fn is_empty(&self) -> bool

### Description
Reports whether no variables are configured.
```

--------------------------------

### Define ProjectBuildAdditionalContexts Enum

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/project/enum.ProjectBuildAdditionalContexts.html

The core enum definition for handling build contexts, marked as non-exhaustive to allow for future variants.

```rust
#[non_exhaustive]
pub enum ProjectBuildAdditionalContexts {
    Map(Vec<ProjectBuildAdditionalContextEntry>),
    List(Vec<ProjectValue<String>>),
}
```

--------------------------------

### Define BUILD_EXTRA_HOSTS_EXPECTED_FORM constant

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/constant.BUILD_EXTRA_HOSTS_EXPECTED_FORM.html

The constant is defined as a DiagnosticCode within the model module.

```rust
pub const BUILD_EXTRA_HOSTS_EXPECTED_FORM: DiagnosticCode;
```

--------------------------------

### Accessing DEPLOY_MODE_PORTABILITY

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/constant.DEPLOY_MODE_PORTABILITY.html

The constant is defined as a DiagnosticCode within the compose_lens::model module.

```rust
pub const DEPLOY_MODE_PORTABILITY: DiagnosticCode;
```

--------------------------------

### LoadedProject::interpolate

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/loader/struct.LoadedProject.html

Performs interpolation on the loaded documents.

```APIDOC
## pub fn interpolate(&self, environment: &dyn EnvironmentProvider) -> ProjectInterpolation

### Description
Interpolates each document independently, in file order, without modifying the project.
```

--------------------------------

### Accessing DEPLOY_UPDATE_CONFIG_ORDER_PORTABILITY

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/constant.DEPLOY_UPDATE_CONFIG_ORDER_PORTABILITY.html

The constant is defined as a DiagnosticCode within the compose_lens::model module.

```rust
pub const DEPLOY_UPDATE_CONFIG_ORDER_PORTABILITY: DiagnosticCode;
```

--------------------------------

### DiagnosticLabel::primary

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/diagnostic/struct.DiagnosticLabel.html

Creates a primary source label.

```APIDOC
## pub fn primary(span: SourceSpan, message: impl Into<String>) -> Self

### Description
Creates a primary source label associated with a given span and message.

### Parameters
- **span** (SourceSpan) - The source span to label.
- **message** (impl Into<String>) - The message to attach to the span.
```

--------------------------------

### fn validate_compatibility

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/validation/fn.validate_compatibility.html

Detects and classifies compatibility-sensitive constructs in the selected project view.

```APIDOC
## fn validate_compatibility

### Description
Detects and classifies compatibility-sensitive constructs in the selected project view.

### Signature
`pub fn validate_compatibility(project: &MergedProject, selection: Option<&ProfileSelection>, profile: CompatibilityProfile) -> CompatibilityReport`

### Parameters
- **project** (&MergedProject) - Required - The project to validate.
- **selection** (Option<&ProfileSelection>) - Optional - The specific profile selection to validate against.
- **profile** (CompatibilityProfile) - Required - The compatibility profile to use for validation.

### Returns
- **CompatibilityReport** - A report containing the results of the compatibility validation.
```

--------------------------------

### HOSTNAME_EXPECTED_STRING Constant Definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/constant.HOSTNAME_EXPECTED_STRING.html

The constant definition for the diagnostic code used when a hostname is not a YAML string.

```rust
pub const HOSTNAME_EXPECTED_STRING: DiagnosticCode;
```

--------------------------------

### IndentWidth API

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/render/struct.IndentWidth.html

Methods for interacting with the IndentWidth struct.

```APIDOC
## IndentWidth

### Description
Represents a valid number of spaces used for one canonical YAML indentation level.

### Constants
- **MIN** (u8): The smallest supported indentation width (1).
- **CANONICAL** (Self): The fixed width used by canonical-v1 output.

### Methods
- **new(spaces: u8) -> Option<Self>**
  Creates a validated indentation width. Returns None if the provided value is invalid.

- **spaces(self) -> u8**
  Returns the number of spaces in one indentation level.
```

--------------------------------

### Accessing DEPLOY_ROLLBACK_CONFIG_ORDER_PORTABILITY

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/constant.DEPLOY_ROLLBACK_CONFIG_ORDER_PORTABILITY.html

The constant is defined as a DiagnosticCode within the compose_lens::model module.

```rust
pub const DEPLOY_ROLLBACK_CONFIG_ORDER_PORTABILITY: DiagnosticCode;
```

--------------------------------

### Accessing DOCUMENT_ROOT_TYPE

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/constant.DOCUMENT_ROOT_TYPE.html

Displays the constant definition for the document root type.

```rust
pub const DOCUMENT_ROOT_TYPE: DiagnosticCode;
```

--------------------------------

### validate_compatibility Function Signature

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/validation/fn.validate_compatibility.html

The function signature for validating project compatibility.

```rust
pub fn validate_compatibility(
    project: &MergedProject,
    selection: Option<&ProfileSelection>,
    profile: CompatibilityProfile,
) -> CompatibilityReport
```

--------------------------------

### SourceId::new

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/source/struct.SourceId.html

Creates a new SourceId instance from a numeric value.

```APIDOC
## pub const fn new(value: u32) -> Self

### Description
Creates an identifier from a caller-managed numeric value.

### Parameters
- **value** (u32) - Required - The numeric identifier to assign to the source document.
```

--------------------------------

### BlkioWeightDevice struct definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/struct.BlkioWeightDevice.html

The definition of the BlkioWeightDevice struct.

```rust
pub struct BlkioWeightDevice { /* private fields */ }
```

--------------------------------

### Accessing DEPLOY_RESERVATION_DEVICE_OPTIONS_DUPLICATE_ITEM

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/constant.DEPLOY_RESERVATION_DEVICE_OPTIONS_DUPLICATE_ITEM.html

The constant is defined as a DiagnosticCode within the compose_lens::model module.

```rust
pub const DEPLOY_RESERVATION_DEVICE_OPTIONS_DUPLICATE_ITEM: DiagnosticCode;
```

--------------------------------

### Function Signature for render_canonical_with_formatting

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/render/fn.render_canonical_with_formatting.html

The function signature defines the required inputs for rendering a project with custom formatting.

```rust
pub fn render_canonical_with_formatting(
    project: &MergedProject,
    selection: Option<&ProfileSelection>,
    formatting: &CanonicalFormatting,
) -> CanonicalRender
```

--------------------------------

### Access GeneratedLongDevice fields

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/render/struct.GeneratedLongDevice.html

Methods to retrieve the source, target, and permissions from a GeneratedLongDevice instance.

```rust
pub const fn source(&self) -> &GeneratedString
pub const fn target(&self) -> Option<&GeneratedString>
pub const fn permissions(&self) -> Option<&GeneratedString>
```

--------------------------------

### DEPLOY_RESERVATION_DEVICE_ALLOCATION_SELECTOR_CONFLICT Definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/constant.DEPLOY_RESERVATION_DEVICE_ALLOCATION_SELECTOR_CONFLICT.html

The constant definition for the diagnostic code.

```rust
pub const DEPLOY_RESERVATION_DEVICE_ALLOCATION_SELECTOR_CONFLICT: DiagnosticCode;
```

--------------------------------

### DocumentOrigin::directory

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/loader/struct.DocumentOrigin.html

Retrieves the directory path associated with the DocumentOrigin.

```APIDOC
## pub fn directory(&self) -> &Path

### Description
Returns the caller-supplied directory associated with this document.
```

--------------------------------

### Hostname struct definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/struct.Hostname.html

The definition of the Hostname struct.

```rust
pub struct Hostname { /* private fields */ }
```

--------------------------------

### ComposeDefaults::platform

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/resolution/struct.ComposeDefaults.html

Retrieves the container platform associated with the ComposeDefaults instance.

```APIDOC
## pub const fn platform(self) -> ContainerPlatform

### Description
Returns the target container platform configured for this instance.
```

--------------------------------

### Accessing DEPLOY_ENDPOINT_MODE_PORTABILITY

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/constant.DEPLOY_ENDPOINT_MODE_PORTABILITY.html

The constant is defined as a DiagnosticCode within the model module.

```rust
pub const DEPLOY_ENDPOINT_MODE_PORTABILITY: DiagnosticCode;
```

--------------------------------

### GeneratedExtraHost Struct Definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/render/struct.GeneratedExtraHost.html

The internal structure definition for GeneratedExtraHost.

```rust
pub struct GeneratedExtraHost { /* private fields */ }
```

--------------------------------

### DEVICE_EXPECTED_STRING Constant Definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/constant.DEVICE_EXPECTED_STRING.html

The definition of the DEVICE_EXPECTED_STRING constant within the model module.

```rust
pub const DEVICE_EXPECTED_STRING: DiagnosticCode;
```

--------------------------------

### validate_compatibility

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/validation/index.html

Detects and classifies compatibility-sensitive constructs in the selected project view.

```APIDOC
## validate_compatibility

### Description
Detects and classifies compatibility-sensitive constructs in the selected project view.

### Signature
`pub fn validate_compatibility(...) -> CompatibilityReport`
```

--------------------------------

### Define ProjectCredentialSpec

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/project/struct.ProjectCredentialSpec.html

The structure definition for ProjectCredentialSpec.

```rust
pub struct ProjectCredentialSpec { /* private fields */ }
```

--------------------------------

### Define ProjectEnvironmentFile Enum

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/project/enum.ProjectEnvironmentFile.html

The structure of the ProjectEnvironmentFile enum, supporting both simple string paths and complex boxed long-form configurations.

```rust
pub enum ProjectEnvironmentFile {
    Short(String),
    Long(Box<ProjectLongEnvironmentFile>),
}
```

--------------------------------

### Define BUILD_DOCKERFILE_EXPECTED_NON_EMPTY constant

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/constant.BUILD_DOCKERFILE_EXPECTED_NON_EMPTY.html

The constant is defined as a DiagnosticCode type within the model module.

```rust
pub const BUILD_DOCKERFILE_EXPECTED_NON_EMPTY: DiagnosticCode;
```

--------------------------------

### BlkioDeviceRate struct definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/struct.BlkioDeviceRate.html

The definition of the BlkioDeviceRate struct.

```rust
pub struct BlkioDeviceRate { /* private fields */ }
```

--------------------------------

### CapabilityAddItem Definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/struct.CapabilityAddItem.html

The definition of the CapabilityAddItem struct.

```rust
pub struct CapabilityAddItem { /* private fields */ }
```

--------------------------------

### ProjectViewResult Definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/project/struct.ProjectViewResult.html

The definition of the ProjectViewResult struct.

```rust
pub struct ProjectViewResult { /* private fields */ }
```

--------------------------------

### BuildExtraHosts Enum Definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/enum.BuildExtraHosts.html

The enum definition showing the List and Map variants used for capturing host mappings.

```rust
pub enum BuildExtraHosts {
    List {
        span: SourceSpan,
        values: Vec<Located<String>>,
    },
    Map {
        span: SourceSpan,
        entries: Vec<BuildExtraHostEntry>,
    },
}
```

--------------------------------

### Define ProjectLabels Struct

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/project/struct.ProjectLabels.html

The definition of the ProjectLabels struct with private fields.

```rust
pub struct ProjectLabels { /* private fields */ }
```

--------------------------------

### Define BUILD_EXTRA_HOSTS_DUPLICATE_ITEM constant

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/constant.BUILD_EXTRA_HOSTS_DUPLICATE_ITEM.html

The constant is defined as a DiagnosticCode within the model module.

```rust
pub const BUILD_EXTRA_HOSTS_DUPLICATE_ITEM: DiagnosticCode;
```

--------------------------------

### ProjectDeployPlacementPreference Struct Definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/project/struct.ProjectDeployPlacementPreference.html

The definition of the ProjectDeployPlacementPreference struct.

```rust
pub struct ProjectDeployPlacementPreference { /* private fields */ }
```

--------------------------------

### DNS_OPT_EXPECTED_STRING Constant Definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/constant.DNS_OPT_EXPECTED_STRING.html

The constant is defined as a DiagnosticCode type.

```rust
pub const DNS_OPT_EXPECTED_STRING: DiagnosticCode;
```

--------------------------------

### Definition of BUILD_NO_CACHE_EXPECTED_BOOLEAN_OR_STRING

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/constant.BUILD_NO_CACHE_EXPECTED_BOOLEAN_OR_STRING.html

The constant is defined as a DiagnosticCode within the compose_lens::model module.

```rust
pub const BUILD_NO_CACHE_EXPECTED_BOOLEAN_OR_STRING: DiagnosticCode;
```

--------------------------------

### resolve_paths

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/resolution/fn.resolve_paths.html

Finds and lexically resolves paths covered by the initial conversion boundary.

```APIDOC
## resolve_paths

### Description
Finds and lexically resolves paths covered by the initial conversion boundary.

### Signature
`pub fn resolve_paths(project: &MergedProject, selection: Option<&ProfileSelection>, context: &PathContext) -> PathResolution`

### Parameters
- **project** (&MergedProject) - The project to resolve paths within.
- **selection** (Option<&ProfileSelection>) - Optional profile selection criteria.
- **context** (&PathContext) - The path context used for resolution.

### Returns
- **PathResolution** - The result of the path resolution process.
```

--------------------------------

### Accessing DEPLOY_RESERVATION_DEVICE_CAPABILITY_DUPLICATE_ITEM

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/constant.DEPLOY_RESERVATION_DEVICE_CAPABILITY_DUPLICATE_ITEM.html

The constant is defined as a DiagnosticCode within the compose_lens::model module.

```rust
pub const DEPLOY_RESERVATION_DEVICE_CAPABILITY_DUPLICATE_ITEM: DiagnosticCode;
```

--------------------------------

### GeneratedNetworkDefinition Struct Definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/render/struct.GeneratedNetworkDefinition.html

The primary structure definition for network configurations.

```rust
pub struct GeneratedNetworkDefinition { /* private fields */ }
```

--------------------------------

### SourceSpan Methods

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/source/struct.SourceSpan.html

Methods to retrieve information about the span's range and source identifier.

```APIDOC
## pub const fn source_id(self) -> SourceId
Returns the source document identifier.

## pub const fn start(self) -> usize
Returns the inclusive start byte offset.

## pub const fn end(self) -> usize
Returns the exclusive end byte offset.

## pub fn range(self) -> Range<usize>
Returns the half-open byte range.

## pub const fn len(self) -> usize
Returns the span length in bytes.

## pub const fn is_empty(self) -> bool
Reports whether this is an empty span.

## pub const fn contains(self, byte_offset: usize) -> bool
Reports whether the byte offset is inside the half-open span.
```

--------------------------------

### DNS_OPT_EXPECTED_SEQUENCE Constant Definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/constant.DNS_OPT_EXPECTED_SEQUENCE.html

The definition of the DNS_OPT_EXPECTED_SEQUENCE constant within the model module.

```rust
pub const DNS_OPT_EXPECTED_SEQUENCE: DiagnosticCode;
```

--------------------------------

### ProjectDeployResources struct definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/project/struct.ProjectDeployResources.html

The definition of the ProjectDeployResources struct.

```rust
pub struct ProjectDeployResources { /* private fields */ }
```

--------------------------------

### ProjectPreStartHook Enum Definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/project/enum.ProjectPreStartHook.html

The definition of the ProjectPreStartHook enum, which is marked as non-exhaustive and includes variants for service hooks and unmodeled items.

```rust
#[non_exhaustive]
pub enum ProjectPreStartHook {
    Hook(Box<ProjectPreStartServiceHook>),
    Unmodeled,
}
```

--------------------------------

### ProjectBlkioWeightDeviceForm Enum Definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/project/enum.ProjectBlkioWeightDeviceForm.html

The definition of the non-exhaustive ProjectBlkioWeightDeviceForm enum.

```rust
#[non_exhaustive]
pub enum ProjectBlkioWeightDeviceForm {
    Mapping,
    Unmodeled,
}
```

--------------------------------

### HostAddress Definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/struct.HostAddress.html

The structure definition for HostAddress, which contains private fields.

```rust
pub struct HostAddress { /* private fields */ }
```

--------------------------------

### GeneratedMount::anonymous

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/render/struct.GeneratedMount.html

Creates a long-form anonymous-volume mount. Rejects an empty or NUL-bearing target.

```APIDOC
### pub fn anonymous(target: impl Into<String>, read_only: bool) -> Result<Self, GenerationError>

Creates a long-form anonymous-volume mount.
```

--------------------------------

### ComposeDocumentBuilder::add_service

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/render/struct.ComposeDocumentBuilder.html

Adds a service to the Compose document.

```APIDOC
## pub fn add_service(&mut self, service: GeneratedService) -> Result<(), GenerationError>

### Description
Adds one uniquely named service in output order. Returns GenerationError::DuplicateName for a duplicate service name.
```

--------------------------------

### ComposeDocument Definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/struct.ComposeDocument.html

The primary structure definition for a source-aware native Compose document.

```rust
pub struct ComposeDocument { /* private fields */ }
```

--------------------------------

### GeneratedResource struct definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/render/struct.GeneratedResource.html

The primary structure for defining a network or volume lifecycle.

```rust
pub struct GeneratedResource { /* private fields */ }
```

--------------------------------

### Function signature for interpolate_document_with_options

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/interpolation/fn.interpolate_document_with_options.html

The function signature defines the required parameters for document interpolation, including the document, environment provider, and interpolation options.

```rust
pub fn interpolate_document_with_options(
    document: &SyntaxDocument,
    environment: &dyn EnvironmentProvider,
    options: InterpolationOptions,
) -> DocumentInterpolation
```

--------------------------------

### Devices struct definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/struct.Devices.html

The definition of the Devices struct as an ordered service sequence.

```rust
pub struct Devices { /* private fields */ }
```

--------------------------------

### DnsOptions struct definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/struct.DnsOptions.html

The definition of the DnsOptions struct, which contains private fields.

```rust
pub struct DnsOptions { /* private fields */ }
```

--------------------------------

### VOLUME_EXTERNAL_DRIVER_CONFIGURATION Constant Definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/constant.VOLUME_EXTERNAL_DRIVER_CONFIGURATION.html

The constant definition for the diagnostic code used in volume configuration analysis.

```rust
pub const VOLUME_EXTERNAL_DRIVER_CONFIGURATION: DiagnosticCode;
```

--------------------------------

### LOGGING_OPTION_EMPTY_KEY Definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/constant.LOGGING_OPTION_EMPTY_KEY.html

The constant is defined as a DiagnosticCode type.

```rust
pub const LOGGING_OPTION_EMPTY_KEY: DiagnosticCode;
```

--------------------------------

### Define EnvironmentFileFormat struct

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/struct.EnvironmentFileFormat.html

The definition of the EnvironmentFileFormat struct with private fields.

```rust
pub struct EnvironmentFileFormat { /* private fields */ }
```

--------------------------------

### GeneratedPort::new

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/render/struct.GeneratedPort.html

Creates a new instance of a generated port. It validates the input parameters and may return a GenerationError if the configuration is invalid (e.g., target port zero, invalid host address, or invalid SCTP configuration).

```APIDOC
## fn new(target: u16, published: Option<u16>, host_ip: Option<String>, protocol: GeneratedProtocol) -> Result<Self, GenerationError>

### Description
Creates a generated port without normalizing its declared transport. Rejects target port zero, an empty/NUL-bearing host address, and an SCTP host address without a published port.

### Parameters
- **target** (u16) - The container port.
- **published** (Option<u16>) - The optional host port.
- **host_ip** (Option<String>) - The optional host-address spelling.
- **protocol** (GeneratedProtocol) - The transport protocol.

### Returns
- **Result<Self, GenerationError>** - Returns the new GeneratedPort instance or a GenerationError if validation fails.
```

--------------------------------

### DiagnosticLabel::secondary

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/diagnostic/struct.DiagnosticLabel.html

Creates a secondary source label.

```APIDOC
## pub fn secondary(span: SourceSpan, message: impl Into<String>) -> Self

### Description
Creates a secondary source label associated with a given span and message.

### Parameters
- **span** (SourceSpan) - The source span to label.
- **message** (impl Into<String>) - The message to attach to the span.
```

--------------------------------

### EXTRA_HOST_INVALID_ENTRY Constant Definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/constant.EXTRA_HOST_INVALID_ENTRY.html

The constant definition for the invalid extra_hosts entry diagnostic code.

```rust
pub const EXTRA_HOST_INVALID_ENTRY: DiagnosticCode;
```

--------------------------------

### Build Enum Definition

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/model/enum.Build.html

The structure of the Build enum, which can be either a scalar context or a build definition.

```rust
pub enum Build {
    Context(Located<String>),
    Definition(BuildDefinition),
}
```

--------------------------------

### GeneratedEnvironment::literal

Source: https://docs.rs/compose-lens/0.1.16/compose_lens/render/struct.GeneratedEnvironment.html

Creates a literal NAME=value environment entry. Rejects names that are empty, contain NUL bytes, or contain '='.

```APIDOC
## pub fn literal(name: impl Into<String>, value: GeneratedString) -> Result<Self, GenerationError>

### Description
Creates a literal `NAME=value` entry.

### Errors
Rejects an empty/NUL-bearing name or a name containing '='.
```
Tokens:
Raw