Quadlet Lens

https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/
Admin
Quadlet Lens provides loss-aware parsing, validation, and rendering of version-aware Quadlet...
Tokens:8,640
Snippets:156
Trust Score:9.1
Update:1 month ago
Show doc for...
Tokens:
Raw
### PodmanTarget::new

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/capability/struct.PodmanTarget.html

Creates a new PodmanTarget instance with a specified minimum version and an optional maximum version. Returns an error if the provided range is invalid.

```APIDOC
## pub fn new(minimum: PodmanVersion, maximum: Option<PodmanVersion>) -> Result<Self, CatalogueError>

### Description
Creates a coherent target range for Podman versions. 

### Parameters
- **minimum** (PodmanVersion) - Required - The minimum required Podman version.
- **maximum** (Option<PodmanVersion>) - Optional - The maximum allowed Podman version.

### Errors
Returns `CatalogueError::InvalidRange` if the range is inverted (i.e., minimum is greater than maximum).
```

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

### SyntaxDocument::source

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/syntax/struct.SyntaxDocument.html

Retrieves the complete source text and its location lookup information.

```APIDOC
## pub const fn source(&self) -> &SourceText

### Description
Returns the complete source text and its associated location lookup data.
```

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

### Memory::new

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/render/struct.Memory.html

Creates a new Memory instance from a string representation of a memory limit.

```APIDOC
## pub fn new(memory: impl Into<String>) -> Result<Self, MemoryError>

### Description
Creates a positive memory limit from exact native spelling. The input must be a positive ASCII-decimal amount followed by an optional unit (b, k, m, or g).

### Errors
- MemoryError::Empty: If the input text is empty.
- MemoryError::InvalidFormat: If the format is not a valid ASCII-decimal amount with an optional unit.
- MemoryError::Zero: If the amount is zero.
```

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

### Create and access PodmanTarget

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/capability/struct.PodmanTarget.html

Methods for creating a new target range and retrieving the minimum or maximum version bounds.

```rust
pub fn new( minimum: PodmanVersion, maximum: Option<PodmanVersion>, ) -> Result<Self, CatalogueError>
```

```rust
pub const fn minimum(self) -> PodmanVersion
```

```rust
pub const fn maximum(self) -> Option<PodmanVersion>
```

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

### Define EntryLine struct

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/syntax/struct.EntryLine.html

The definition of the EntryLine struct with private fields.

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

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

### SyntaxDocument::render_preserved

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/syntax/struct.SyntaxDocument.html

Returns the original authored source bytes.

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

### Description
Returns the authored source bytes exactly as they were provided, unchanged.
```

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

### Define GeneratedQuadletDocument struct

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/render/struct.GeneratedQuadletDocument.html

The primary structure for holding a successfully generated and validated Quadlet document.

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

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

### CapabilityRecord Struct Definition

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/capability/struct.CapabilityRecord.html

The primary structure definition for a validated semantic capability.

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

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

### QuadletDocumentBuilder definition

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/render/struct.QuadletDocumentBuilder.html

The structure definition for the QuadletDocumentBuilder.

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

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

### PodmanTarget Accessors

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/capability/struct.PodmanTarget.html

Methods to retrieve the minimum and maximum version constraints from a PodmanTarget instance.

```APIDOC
## pub const fn minimum(self) -> PodmanVersion

### Description
Returns the `podmanMinimumVersion` defined in the target.

## pub const fn maximum(self) -> Option<PodmanVersion>

### Description
Returns the `podmanMaximumVersion` defined in the target, if one exists.
```

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

### SourceSpan Methods

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/source/struct.SourceSpan.html

Methods available on the SourceSpan struct for accessing range information.

```APIDOC
## pub const fn source_id(self) -> SourceId
Returns the source containing this span.

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

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

## pub const fn len(self) -> usize
Returns the length of the byte range.

## pub const fn is_empty(self) -> bool
Returns whether the range contains no bytes.
```

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

### SyntaxDocument::lines

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/syntax/struct.SyntaxDocument.html

Retrieves the physical lines of the document in the order they were authored.

```APIDOC
## pub fn lines(&self) -> &[SyntaxLine]

### Description
Returns a slice of physical lines in the order they appear in the authored source.
```

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

### classify_path function signature

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/path/fn.classify_path.html

The function signature for classifying path strings in the quadlet_lens crate.

```rust
pub fn classify_path(value: &str) -> PathForm
```

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

### SyntaxDocument::parse

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/syntax/struct.SyntaxDocument.html

Parses UTF-8 source text into an ordered physical line structure and associated diagnostics.

```APIDOC
## pub fn parse(source_id: SourceId, text: impl Into<String>) -> ParseResult

### Description
Parses the provided UTF-8 source text into ordered physical lines and structured diagnostics.

### Parameters
- **source_id** (SourceId) - Required - The identifier for the source being parsed.
- **text** (impl Into<String>) - Required - The source text content to parse.
```

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

### EntryValue::new

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/render/struct.EntryValue.html

Creates a new EntryValue instance from a string, validating that it does not contain line endings or NUL bytes.

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

### Description
Creates an exact native value that fits on one physical line.

### Parameters
- **value** (impl Into<String>) - Required - The string value to be stored.

### Errors
Returns `RenderError::InvalidValue` when the value contains a line ending or NUL byte.
```

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

### Define DependencyGraph struct

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/model/struct.DependencyGraph.html

The primary structure definition for managing document dependencies.

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

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

### ShmSize Definition

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/render/struct.ShmSize.html

The internal structure definition for ShmSize.

```rust
pub struct ShmSize(/* private fields */);
```

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

### VersionParseError Definition

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/capability/struct.VersionParseError.html

The definition of the VersionParseError struct.

```rust
pub struct VersionParseError(/* private fields */);
```

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

### EntryValue::as_str

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/render/struct.EntryValue.html

Retrieves the underlying string representation of the EntryValue.

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

### Description
Returns the exact native spelling of the stored value.
```

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

### Memory::as_str

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/render/struct.Memory.html

Retrieves the raw string representation of the memory limit.

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

### Description
Returns the exact native spelling of the memory limit as stored in the struct.
```

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

### Define PodmanTarget struct

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/capability/struct.PodmanTarget.html

The structure definition for PodmanTarget.

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

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

### Define PodmanVersion struct

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/capability/struct.PodmanVersion.html

The definition of the PodmanVersion struct with private fields.

```rust
pub struct PodmanVersion(/* private fields */);
```

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

### Define SyntaxLine struct

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/syntax/struct.SyntaxLine.html

The definition of the SyntaxLine struct with private fields.

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

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

### EvidenceRecord Struct Definition

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/capability/struct.EvidenceRecord.html

The primary structure definition for EvidenceRecord, which contains private fields.

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

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

### Define BuildKey Enum

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/model/enum.BuildKey.html

The BuildKey enum contains various variants for build configuration, marked as non-exhaustive.

```rust
#[non_exhaustive]
pub enum BuildKey {
Show 28 variants    ImageTag,
    SetWorkingDirectory,
    File,
    Target,
    Network,
    Label,
    BuildArg,
    Secret,
    Arch,
    Variant,
    Pull,
    PodmanArgs,
    Retry,
    RetryDelay,
    TLSVerify,
    ForceRM,
    GroupAdd,
    DNS,
    DNSOption,
    DNSSearch,
    AuthFile,
    IgnoreFile,
    Annotation,
    Environment,
    ContainersConfModule,
    GlobalArgs,
    ServiceName,
    Volume,
}
```

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

### Diagnostic struct definition

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/diagnostic/struct.Diagnostic.html

The primary structure definition for Diagnostic.

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

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

### UnsupportedRecord struct definition

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/capability/struct.UnsupportedRecord.html

The definition of the UnsupportedRecord struct.

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

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

### EntryValue Struct Definition

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/render/struct.EntryValue.html

The internal structure definition of EntryValue.

```rust
pub struct EntryValue(/* private fields */);
```

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

### Define ContinuationLine struct

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/syntax/struct.ContinuationLine.html

The structure definition for ContinuationLine.

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

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

### KnownBugRecord Struct Definition

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/capability/struct.KnownBugRecord.html

The definition of the KnownBugRecord struct.

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

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

### VolumeKey Enum Definition

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/model/enum.VolumeKey.html

The definition of the VolumeKey enum, which includes various configuration keys for Podman volumes.

```rust
#[non_exhaustive]
pub enum VolumeKey {
Show 16 variants    VolumeName,
    Driver,
    Options,
    Label,
    Device,
    Type,
    Copy,
    ContainersConfModule,
    GlobalArgs,
    PodmanArgs,
    User,
    Group,
    UID,
    GID,
    ServiceName,
    Image,
}
```

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

### PodKey Enum Definition

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/model/enum.PodKey.html

The definition of the PodKey enum, which includes various keys for pod configuration.

```rust
#[non_exhaustive]
pub enum PodKey {
    AddHost,
    PodName,
    PublishPort,
    Network,
    Volume,
    UserNS,
    ShmSize,
    ExitPolicy,
    StopTimeout,
    ServiceName,
}
```

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

### Label struct definition

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/diagnostic/struct.Label.html

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

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

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

### Define NetworkKey Enum

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/model/enum.NetworkKey.html

The structure of the NetworkKey enum, which includes various network configuration keys and is marked as non-exhaustive.

```rust
#[non_exhaustive]
pub enum NetworkKey {
    NetworkName,
    Driver,
    Options,
    Internal,
    IPv6,
    IPAMDriver,
    Subnet,
    Gateway,
    IPRange,
    Label,
}
```

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

### Define UnitFileName struct

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/model/struct.UnitFileName.html

The definition of the UnitFileName struct with private fields.

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

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

### Define SourcedText structure

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/model/struct.SourcedText.html

The internal definition of the SourcedText struct.

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

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

### ContainerKey Enum Definition

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/model/enum.ContainerKey.html

The non-exhaustive enum containing all supported container configuration keys.

```rust
#[non_exhaustive]
pub enum ContainerKey {
Show 63 variants    AddHost,
    Image,
    Exec,
    Environment,
    EnvironmentFile,
    PublishPort,
    Volume,
    Network,
    Pod,
    HealthCmd,
    PodmanArgs,
    HealthInterval,
    HealthRetries,
    HealthStartPeriod,
    HealthTimeout,
    Notify,
    User,
    Group,
    UserNS,
    GroupAdd,
    WorkingDir,
    ReadOnly,
    Secret,
    Label,
    Rootfs,
    ContainerName,
    Entrypoint,
    RunInit,
    StopSignal,
    StopTimeout,
    Pull,
    PidsLimit,
    HostName,
    ShmSize,
    DropCapability,
    AddCapability,
    Tmpfs,
    Sysctl,
    Ulimit,
    AddDevice,
    Memory,
    DNS,
    DNSOption,
    DNSSearch,
    ExposeHostPort,
    Annotation,
    AppArmor,
    NoNewPrivileges,
    SeccompProfile,
    SecurityLabelDisable,
    SecurityLabelFileType,
    SecurityLabelLevel,
    SecurityLabelNested,
    SecurityLabelType,
    Mask,
    Unmask,
    LogDriver,
    LogOpt,
    IP,
    IP6,
    NetworkAlias,
    ReloadCmd,
    ReloadSignal,
}
```

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

### Define EntryKind Enum

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/model/enum.EntryKind.html

The structure of the EntryKind enum, which categorizes various systemd-related keys.

```rust
#[non_exhaustive]
pub enum EntryKind {
    GenericSystemd,
    Container(ContainerKey),
    Pod(PodKey),
    Network(NetworkKey),
    Volume(VolumeKey),
    Unknown,
    Build(BuildKey),
    Image(ImageKey),
}
```

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

### SyntaxLineKind Enum Definition

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/syntax/enum.SyntaxLineKind.html

The definition of the SyntaxLineKind enum, representing the various types of lines found in a configuration file.

```rust
pub enum SyntaxLineKind {
    Blank,
    Comment(CommentLine),
    Section(SectionLine),
    Entry(EntryLine),
    Continuation(ContinuationLine),
    Invalid,
}
```

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

### Define QuadletParseResult struct

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/model/struct.QuadletParseResult.html

The structure definition for QuadletParseResult, which contains private fields.

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

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

### Define CommentLine struct

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/syntax/struct.CommentLine.html

The definition of the CommentLine struct with private fields.

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

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

### classify_path

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/path/index.html

Classifies a path spelling without expanding specifiers or applying key-specific rules.

```APIDOC
## classify_path

### Description
Classifies path spelling without expanding specifiers or applying key-specific rules.

### Signature
`pub fn classify_path(path: &str) -> PathForm`
```

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

### LineEnding Enum Definition

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/syntax/enum.LineEnding.html

The definition of the LineEnding enum with its three variants.

```rust
pub enum LineEnding {
    Lf,
    CrLf,
    None,
}
```

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

### PidsLimit struct definition

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/render/struct.PidsLimit.html

The internal structure of PidsLimit is private, preventing direct instantiation.

```rust
pub struct PidsLimit(/* private fields */);
```

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

### Define SystemdSection Enum

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/render/enum.SystemdSection.html

The definition of the SystemdSection enum, which is marked as non-exhaustive to allow for future additions.

```rust
#[non_exhaustive]
pub enum SystemdSection {
    Unit,
    Service,
    Install,
}
```

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

### DiagnosticCode Struct Definition

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/diagnostic/struct.DiagnosticCode.html

The definition of the DiagnosticCode struct.

```rust
pub struct DiagnosticCode(/* private fields */);
```

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

### Define CommentMarker Enum

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/syntax/enum.CommentMarker.html

The enum structure representing supported systemd comment markers.

```rust
pub enum CommentMarker {
    Hash,
    Semicolon,
}
```

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

### LineColumn Struct Definition

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/source/struct.LineColumn.html

The definition of the LineColumn struct with private fields.

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

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

### SystemdUnitKey Enum Definition

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/render/enum.SystemdUnitKey.html

The definition of the SystemdUnitKey enum, which includes variants for common systemd unit directives.

```rust
#[non_exhaustive]
pub enum SystemdUnitKey {
    Requires,
    Wants,
    After,
}
```

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

### UnitReference Struct Definition

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/model/struct.UnitReference.html

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

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

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

### Define SourceId struct

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/source/struct.SourceId.html

The definition of the SourceId struct with private fields.

```rust
pub struct SourceId(/* private fields */);
```

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

### Define ReferenceResolution Enum

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/model/enum.ReferenceResolution.html

The structure of the ReferenceResolution enum, which tracks the resolution state of a native unit reference.

```rust
#[non_exhaustive]
pub enum ReferenceResolution {
    Resolved {
        document_index: usize,
    },
    Missing,
    Ambiguous {
        candidates: usize,
    },
}
```

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

### Define VerificationLevel Enum

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/capability/enum.VerificationLevel.html

The non-exhaustive enum structure for VerificationLevel, containing Documentation and Generator variants.

```rust
#[non_exhaustive]
pub enum VerificationLevel {
    Documentation,
    Generator,
}
```

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

### ImageKey Enum Definition

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/model/enum.ImageKey.html

The ImageKey enum is marked as non-exhaustive, requiring a wildcard arm when matching.

```rust
#[non_exhaustive]
pub enum ImageKey {
    Image,
    ImageTag,
    ServiceName,
    AllTags,
    Arch,
    AuthFile,
    CertDir,
    ContainersConfModule,
    Creds,
    DecryptionKey,
    GlobalArgs,
    OS,
}
```

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

### Severity Enum Definition

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/diagnostic/enum.Severity.html

The core enum structure defining the available diagnostic severity levels.

```rust
pub enum Severity {
    Error,
    Warning,
    Note,
}
```

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

### Define QuadletUnitType Enum

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/model/enum.QuadletUnitType.html

The core enum definition for supported Quadlet unit types.

```rust
#[non_exhaustive]
pub enum QuadletUnitType {
    Container,
    Pod,
    Network,
    Volume,
    Build,
    Image,
}
```

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

### SectionLine struct definition

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/syntax/struct.SectionLine.html

The definition of the SectionLine struct.

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

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

### PathForm Enum Definition

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/path/enum.PathForm.html

The definition of the PathForm enum, which categorizes different types of path strings used in Quadlet.

```rust
#[non_exhaustive]
pub enum PathForm {
    AbsoluteLiteral,
    UnitRelativeLiteral,
    RelativeLiteral,
    SystemdSpecifier,
}
```

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

### SupportClassification Enum Definition

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/capability/enum.SupportClassification.html

The definition of the SupportClassification enum, which is marked as non-exhaustive.

```rust
#[non_exhaustive]
pub enum SupportClassification {
    Native,
    Fallback,
    Deprecated,
    Removed,
    Unsupported,
    Unknown,
    Broken,
}
```

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

### Define UnitReferenceKind Enum

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/model/enum.UnitReferenceKind.html

The definition of the UnitReferenceKind enum, which is marked as non-exhaustive to allow for future variants.

```rust
#[non_exhaustive]
pub enum UnitReferenceKind {
    Image,
    Build,
    Pod,
    Network,
    Volume,
}
```

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

### AuthoredValue Struct Definition

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/model/struct.AuthoredValue.html

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

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

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

### Define CanonicalRenderError Enum

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/syntax/enum.CanonicalRenderError.html

The enum is marked as non-exhaustive, requiring a wildcard arm when matching to accommodate future variants.

```rust
#[non_exhaustive]
pub enum CanonicalRenderError {
    InvalidSyntax(Vec<Diagnostic>),
    InvalidSourceSpan(SourceSpan),
}
```

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

### DocumentSetError Enum Definition

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/model/enum.DocumentSetError.html

The structure of the DocumentSetError enum, which is marked as non-exhaustive to allow for future expansion.

```rust
#[non_exhaustive]
pub enum DocumentSetError {
    InvalidUnitFileName(String),
    UnsupportedUnitFileExtension(String),
    UnitTypeMismatch {
        name: String,
        filename_type: QuadletUnitType,
        document_type: QuadletUnitType,
    },
    DuplicateSourceId(SourceId),
}
```

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

### Define ValueKind Enum

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/model/enum.ValueKind.html

The structure of the ValueKind enum, which includes variants for opaque values, paths, and unit references.

```rust
#[non_exhaustive]
pub enum ValueKind {
    Opaque,
    Path(PathForm),
    UnitReference(UnitReferenceKind),
}
```

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

### Define SectionKind Enum

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/model/enum.SectionKind.html

The core enum definition for SectionKind, marked as non-exhaustive to allow for future additions.

```rust
#[non_exhaustive]
pub enum SectionKind {
    Unit,
    Service,
    Install,
    Container,
    Pod,
    Network,
    Volume,
    Unknown,
    Build,
    Image,
}
```

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

### PidsLimitError Enum Definition

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/render/enum.PidsLimitError.html

The definition of the PidsLimitError enum, marked as non-exhaustive to allow for future variants.

```rust
#[non_exhaustive]
pub enum PidsLimitError {
    Empty,
    NonDecimal,
    Zero,
}
```

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

### Define CatalogueError Enum

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/capability/enum.CatalogueError.html

The CatalogueError enum is marked as non-exhaustive, requiring a wildcard arm when matching to accommodate potential future variants.

```rust
#[non_exhaustive]
pub enum CatalogueError {
    Decode(String),
    UnsupportedSchema(u32),
    InvalidIdentifier(String),
    DuplicateIdentifier(String),
    InvalidVersion {
        field: String,
        value: String,
    },
    InvalidRange(String),
    MissingEvidence {
        owner: String,
        evidence: String,
    },
    InvalidField(String),
}
```

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

### Define ShmSizeError Enum

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/render/enum.ShmSizeError.html

The structure of the ShmSizeError enum, which is marked as non-exhaustive to allow for future variant additions.

```rust
#[non_exhaustive]
pub enum ShmSizeError {
    Empty,
    InvalidFormat,
}
```

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

### RenderError Enum Definition

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/render/enum.RenderError.html

The definition of the RenderError enum, which includes various variants for different failure modes during Quadlet rendering.

```rust
#[non_exhaustive]
pub enum RenderError {
    InvalidValue,
    InvalidKey(String),
    WrongUnitType {
        document: QuadletUnitType,
        entry: QuadletUnitType,
    },
    DuplicateSingleton(String),
    ConflictingSingletons {
        existing: String,
        attempted: String,
    },
    InvalidDocument(Vec<Diagnostic>),
    TypedModel(TypedModelError),
}
```

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

### MemoryError Enum Definition

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/render/enum.MemoryError.html

The definition of the MemoryError enum, which is marked as non-exhaustive to allow for future variant additions.

```rust
#[non_exhaustive]
pub enum MemoryError {
    Empty,
    InvalidFormat,
    Zero,
}
```

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

### TypedModelError Enum Definition

Source: https://docs.rs/quadlet-lens/0.1.12/quadlet_lens/model/enum.TypedModelError.html

The definition of the TypedModelError enum, which is marked as non-exhaustive and contains an InvalidSourceSpan variant.

```rust
#[non_exhaustive]
pub enum TypedModelError {
    InvalidSourceSpan(SourceSpan),
}
```
Tokens:
Raw