Enum GeneratedEnvironmentFile 

#[non_exhaustive]
pub enum GeneratedEnvironmentFile {
    Short(GeneratedString),
    Long {
        path: GeneratedString,
        required: Option<bool>,
        format: Option<GeneratedEnvironmentFileFormat>,
    },
}

One ordered generated Compose env_file declaration.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Short(GeneratedString)

Scalar path syntax with Compose defaults.

Long

Mapping syntax with independently selected options.

Fields

path: GeneratedString

Environment-file path.

required: Option<bool>

Explicit required/optional behavior, or source-format default when omitted.

format: Option<GeneratedEnvironmentFileFormat>

Explicit parser mode, or source-format default when omitted.

Implementations

impl GeneratedEnvironmentFile

pub fn short(path: GeneratedString) -> Result<Self, GenerationError>

Creates one scalar short-syntax declaration.

Errors

Returns GenerationError::EmptyValue for an empty path. NUL-bearing paths are rejected while constructing GeneratedString.

pub fn long( path: GeneratedString, required: Option<bool>, format: Option<GeneratedEnvironmentFileFormat>, ) -> Result<Self, GenerationError>

Creates one mapping long-syntax declaration.

Errors

Returns GenerationError::EmptyValue for an empty path. NUL-bearing paths are rejected while constructing GeneratedString.

pub const fn path(&self) -> &GeneratedString

Returns the environment-file path through its explicit sensitivity boundary.

pub const fn required(&self) -> Option<bool>

Returns the explicitly selected required/optional behavior for long syntax.

pub const fn format(&self) -> Option<GeneratedEnvironmentFileFormat>

Returns the explicitly selected parser mode for long syntax.

pub const fn is_sensitive(&self) -> bool

Reports whether debug output must redact this declaration’s path.

Trait Implementations

impl Clone for GeneratedEnvironmentFile

fn clone(&self) -> GeneratedEnvironmentFile

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GeneratedEnvironmentFile

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for GeneratedEnvironmentFile

impl PartialEq for GeneratedEnvironmentFile

fn eq(&self, other: &GeneratedEnvironmentFile) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for GeneratedEnvironmentFile