Enum GenerationError 

#[non_exhaustive]
pub enum GenerationError {
    EmptyValue(&'static str),
    ContainsNul(&'static str),
    ContainsLineBreak(&'static str),
    InvalidEnvironmentName,
    InvalidContainerName,
    InvalidHostname,
    InvalidPullPolicyDuration,
    InvalidPidsLimit,
    InvalidShmSize,
    InvalidMemLimit,
    InvalidDnsValue,
    InvalidDnsOptionValue,
    InvalidDnsSearchValue,
    InvalidExposeValue,
    InvalidSecurityOptionValue,
    InvalidAnnotationName,
    InvalidAnnotationValue,
    InvalidFileResourceName,
    InvalidFileResourcePath,
    InvalidTmpfsItem,
    InvalidDeviceValue(&'static str),
    InvalidSysctlName,
    InvalidSysctlValue,
    InvalidLoggingOptionNumber,
    InvalidNetworkDriverOptionNumber,
    InvalidVolumeDriverOptionNumber,
    InvalidUlimitName,
    InvalidUlimitValue,
    MissingUlimitRangeMember(&'static str),
    InvalidStopGracePeriod,
    InvalidShortComponent(&'static str),
    InvalidSelinuxBind,
    InvalidServiceRuntimeField(&'static str),
    DuplicateField(&'static str),
    DuplicateName {
        kind: &'static str,
        name: String,
    },
    DuplicateItem(&'static str),
    InvalidPort,
    UnrepresentableSctpHostIp,
    MissingService,
    InternalInvariant(&'static str),
}

A generated Compose construction request is invalid or cannot be represented safely.

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.

EmptyValue(&'static str)

A required value is empty.

ContainsNul(&'static str)

A value contains a NUL byte and cannot represent native container intent safely.

ContainsLineBreak(&'static str)

A value contains a carriage return or line feed where one YAML string item is required.

InvalidEnvironmentName

An environment name contains Compose list-form’s = separator.

InvalidContainerName

A custom container name does not satisfy Compose’s portable name grammar.

InvalidHostname

A service hostname is empty, deferred, or outside the conservative RFC-1123 grammar.

InvalidPullPolicyDuration

A custom pull interval does not match the documented Compose duration grammar.

InvalidPidsLimit

A finite PID limit is not a positive integral decimal.

InvalidShmSize

A service shared-memory amount is not a canonical positive ASCII decimal.

InvalidMemLimit

A service memory-limit amount is not a canonical positive ASCII decimal.

InvalidDnsValue

A generated DNS server is empty, multiline, NUL-bearing, or expression-shaped.

InvalidDnsOptionValue

A generated DNS resolver option is empty, multiline, NUL-bearing, or expression-shaped.

InvalidDnsSearchValue

A generated DNS search domain is empty, multiline, NUL-bearing, or expression-shaped.

InvalidExposeValue

A generated exposed-port item is unsafe or outside the documented decimal grammar.

InvalidSecurityOptionValue

A generated security option is empty, deferred, multiline, or NUL-bearing.

InvalidAnnotationName

A generated annotation name is empty, deferred, multiline, or NUL-bearing.

InvalidAnnotationValue

A generated annotation value is deferred, multiline, or NUL-bearing.

InvalidFileResourceName

A generated top-level config or secret name is not a resolved single-line identifier.

InvalidFileResourcePath

A generated top-level config or secret file value is not a resolved single-line value.

InvalidTmpfsItem

A service-level temporary-filesystem item is deferred, malformed, or provider-dependent.

InvalidDeviceValue(&'static str)

A generated short device or long-device member is empty where required, multiline, or deferred.

InvalidSysctlName

A generated sysctl mapping name is empty, multiline, NUL-bearing, or expression-shaped.

InvalidSysctlValue

A generated sysctl value or list item is multiline, NUL-bearing, or expression-shaped.

InvalidLoggingOptionNumber

A generated logging option number is not one complete YAML number scalar.

InvalidNetworkDriverOptionNumber

A generated network driver option number is not one complete YAML number scalar.

InvalidVolumeDriverOptionNumber

A generated volume driver option number is not one complete YAML number scalar.

InvalidUlimitName

A generated ulimit name is outside the portable lowercase ASCII grammar.

InvalidUlimitValue

A generated ulimit value is outside the supported portable decimal or unlimited set.

MissingUlimitRangeMember(&'static str)

A generated ulimit range omitted its required soft or hard member.

InvalidStopGracePeriod

A stop grace period does not match the raw-preserving policy based on documented Compose units.

InvalidShortComponent(&'static str)

A short-form component contains its reserved separator.

InvalidSelinuxBind

A short bind spelling needed for SELinux cannot be encoded unambiguously.

InvalidServiceRuntimeField(&'static str)

A raw generated service-runtime field is empty, deferred, multiline, or outside its safe syntax subset.

DuplicateField(&'static str)

A singleton field was configured more than once.

DuplicateName

A named generated collection contains the same name more than once.

Fields

kind: &'static str

Collection whose name collided.

name: String

Duplicate non-sensitive name.

DuplicateItem(&'static str)

A generated sequence contains an exact duplicate item.

InvalidPort

A generated port used target port zero.

UnrepresentableSctpHostIp

An SCTP port selected a host address without a published port.

MissingService

A generated project contains no services.

InternalInvariant(&'static str)

ComposeLens could not parse its own deterministic generated bytes.

Trait Implementations

impl Clone for GenerationError

fn clone(&self) -> GenerationError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GenerationError

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

Formats the value using the given formatter.

impl Display for GenerationError

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

Formats the value using the given formatter.

impl Eq for GenerationError

impl Error for GenerationError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl PartialEq for GenerationError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for GenerationError