Skip to main content

Crate r_description

Crate r_description 

Source
Expand description

Lossless, failure-tolerant access to R package DESCRIPTION files.

Description preserves the input exactly. Raw accessors never parse semantic values; their typed counterparts report errors for only the field declaration being inspected.

Structs§

CollectionEntry
One valid collection entry, retaining its declaration and relative spans.
CollectionIssue
One collection issue, retaining its declaration and relative spans.
CollectionResult
Recovered semantic values merged from duplicate declarations.
Description
A lossless parsed R package DESCRIPTION document.
DescriptionBuilder
Canonical single-record DESCRIPTION builder.
Field
Typed valid DCF field.
FieldName
A validated, case-sensitive DCF field name.
FormatStyle
Formatting choices used by canonical builders.
InvalidFieldName
Error returned for a field name outside the portable R DCF grammar.
InvalidLogicalValue
Error returned when logical text cannot be represented without ambiguity.
LogicalValue
An owned logical value, with physical line endings excluded.
NormalizationDiagnostic
One reason a DESCRIPTION document could not be normalized safely.
NormalizationError
Atomic whole-document normalization failure.
Parse
Persistent parse result owning only a Rowan green tree and shared diagnostics.
Record
Typed DCF record.
Relation
A case-sensitive package name and optional version requirement.
Remote
A parsed remote specification.
SourceSpan
A byte span in the UTF-8 source text.
SyntaxDiagnostic
A parser diagnostic with a stable category and byte span.
Url
A parsed URL record.
Validation
Complete validation result in deterministic source/check order.
ValidationIssue
A validation issue with stable identity and source location.
ValueText
Owned unfolded field text and the enclosing physical source range.

Enums§

CollectionEditError
Failure to serialize or apply a typed collection edit.
EditError
Failure to apply a structured edit.
LineEnding
A physical line-ending convention.
Severity
Validation issue severity.
SyntaxDiagnosticKind
Stable category assigned to a parse diagnostic.