uv-resolver 0.0.63

This is an internal component crate of uv
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
use std::collections::BTreeSet;
use std::fmt;

use rustc_hash::FxHashMap;
use serde::Serialize;
use toml_edit::Value;
use toml_writer::{TomlWrite, WriteTomlValue};
use uv_distribution_types::{RequiresPython, SimplifiedMarkerTree};
use uv_fs::PortablePath;
use uv_normalize::PackageName;
use uv_pep508::MarkerTree;
use uv_pypi_types::ConflictKind;

use super::{
    Dependency, DirectSource, ExcludeNewerOverride, ExcludeNewerValue, ForkStrategy, Lock, Package,
    PackageId, PrereleaseMode, RegistrySource, ResolutionMode, ResolverManifest, ResolverOptions,
    Source, SourceDist, Wheel, WheelWireSource, simplified_universal_markers,
};

/// Serializes a lockfile directly while preserving the canonical `uv.lock` layout.
pub(super) fn to_toml(lock: &Lock) -> Result<String, toml_edit::ser::Error> {
    let mut writer = LockWriter::default();
    write_lock(&mut writer, lock).map_err(|error| match error {
        WriteError::Format => {
            toml_edit::ser::Error::Custom("failed to write lockfile to a string".to_string())
        }
        WriteError::Serialize(error) => error,
    })?;
    Ok(writer.output)
}

fn write_lock(writer: &mut LockWriter, lock: &Lock) -> Result<(), WriteError> {
    // Catch a lockfile where the union of fork markers doesn't cover the supported
    // environments.
    debug_assert!(lock.check_marker_coverage().is_ok());

    writer.key_value("version", lock.version)?;
    if lock.revision > 0 {
        writer.key_value("revision", lock.revision)?;
    }
    writer.key_value("requires-python", lock.requires_python.to_string())?;

    if !lock.fork_markers.is_empty() {
        let markers = simplified_universal_markers(&lock.fork_markers, &lock.requires_python);
        if !markers.is_empty() {
            writer.key_multiline_array("resolution-markers", markers, |writer, marker| {
                writer.value(&marker)
            })?;
        }
    }

    // The simplified marker space covered by this resolution.
    let simplified_environment =
        SimplifiedMarkerTree::new(&lock.requires_python, lock.fork_markers_union())
            .as_simplified_marker_tree();

    if !lock.supported_environments.is_empty() {
        let markers = lock
            .supported_environments
            .iter()
            .copied()
            .map(|marker| SimplifiedMarkerTree::new(&lock.requires_python, marker))
            .filter_map(SimplifiedMarkerTree::try_to_string);
        writer.key_multiline_array("supported-markers", markers, |writer, marker| {
            writer.value(&marker)
        })?;
    }

    if !lock.required_environments.is_empty() {
        let markers = lock
            .required_environments
            .iter()
            .copied()
            .map(|marker| SimplifiedMarkerTree::new(&lock.requires_python, marker))
            .filter_map(SimplifiedMarkerTree::try_to_string);
        writer.key_multiline_array("required-markers", markers, |writer, marker| {
            writer.value(&marker)
        })?;
    }

    if !lock.conflicts.is_empty() {
        writer.key_start("conflicts")?;
        writer.raw("[");
        for (index, set) in lock.conflicts.iter().enumerate() {
            if index > 0 {
                writer.raw(", ");
            }
            writer.raw("[\n");
            for item in set.iter() {
                writer.raw("    ");
                let mut first = true;
                writer.start_inline_table();
                writer.inline_value(&mut first, "package", item.package().as_ref())?;
                match item.kind() {
                    ConflictKind::Project => {}
                    ConflictKind::Extra(extra) => {
                        writer.inline_value(&mut first, "extra", extra.as_ref())?;
                    }
                    ConflictKind::Group(group) => {
                        writer.inline_value(&mut first, "group", group.as_ref())?;
                    }
                }
                writer.finish_inline_table(first);
                writer.raw(",\n");
            }
            writer.raw("]");
        }
        writer.raw("]\n");
    }

    write_options(writer, &lock.options)?;
    write_manifest(writer, &lock.manifest)?;

    // Count the number of packages for each package name. When there's only one package for a
    // particular package name (the overwhelmingly common case), we can omit some data (like
    // source and version) on dependency edges since it is strictly redundant.
    let mut dist_count_by_name: FxHashMap<PackageName, u64> = FxHashMap::default();
    for package in &lock.packages {
        *dist_count_by_name
            .entry(package.id.name.clone())
            .or_default() += 1;
    }

    for package in &lock.packages {
        write_package(
            writer,
            package,
            &lock.requires_python,
            simplified_environment,
            &dist_count_by_name,
        )?;
    }

    Ok(())
}

fn write_options(writer: &mut LockWriter, options: &ResolverOptions) -> Result<(), WriteError> {
    let has_options = options.resolution_mode != ResolutionMode::default()
        || options.prerelease_mode != PrereleaseMode::default()
        || options.fork_strategy != ForkStrategy::default()
        || !options.exclude_newer.is_empty();
    if !has_options {
        return Ok(());
    }

    writer.table(&["options"])?;
    if options.resolution_mode != ResolutionMode::default() {
        writer.key_value("resolution-mode", options.resolution_mode.to_string())?;
    }
    if options.prerelease_mode != PrereleaseMode::default() {
        writer.key_value("prerelease-mode", options.prerelease_mode.to_string())?;
    }
    if options.fork_strategy != ForkStrategy::default() {
        writer.key_value("fork-strategy", options.fork_strategy.to_string())?;
    }

    let exclude_newer = &options.exclude_newer;
    if let Some(global) = &exclude_newer.global {
        if let Some(span) = global.span() {
            writer.key_start("exclude-newer")?;
            writer.value(ExcludeNewerValue::PLACEHOLDER)?;
            writer.raw(" # This has no effect and is included for backwards compatibility when using relative exclude-newer values.\n");
            writer.key_value("exclude-newer-span", span.to_string())?;
        } else {
            writer.key_value("exclude-newer", global.to_string())?;
        }
    }

    if !exclude_newer.package.is_empty() {
        writer.table(&["options", "exclude-newer-package"])?;
        for (name, setting) in &exclude_newer.package {
            match setting {
                ExcludeNewerOverride::Enabled(value) => {
                    if let Some(span) = value.span() {
                        writer.key_start(name.as_ref())?;
                        let mut first = true;
                        writer.start_inline_table();
                        writer.inline_value(
                            &mut first,
                            "timestamp",
                            ExcludeNewerValue::PLACEHOLDER,
                        )?;
                        writer.inline_value(&mut first, "span", span.to_string())?;
                        writer.finish_inline_table(first);
                        writer.raw("\n");
                    } else {
                        writer.key_value(name.as_ref(), value.to_string())?;
                    }
                }
                ExcludeNewerOverride::Disabled => {
                    writer.key_value(name.as_ref(), false)?;
                }
            }
        }
    }

    Ok(())
}

fn write_manifest(writer: &mut LockWriter, manifest: &ResolverManifest) -> Result<(), WriteError> {
    let has_dependency_groups = manifest
        .dependency_groups
        .values()
        .any(|requirements| !requirements.is_empty());
    let has_manifest = !manifest.members.is_empty()
        || !manifest.requirements.is_empty()
        || !manifest.constraints.is_empty()
        || !manifest.overrides.is_empty()
        || !manifest.excludes.is_empty()
        || !manifest.build_constraints.is_empty()
        || has_dependency_groups
        || !manifest.dependency_metadata.is_empty();
    if !has_manifest {
        return Ok(());
    }

    writer.table(&["manifest"])?;
    if !manifest.members.is_empty() {
        writer.key_multiline_array("members", &manifest.members, |writer, member| {
            writer.value(member.as_ref())
        })?;
    }
    write_serialized_non_empty_array(writer, "requirements", &manifest.requirements)?;
    write_serialized_non_empty_array(writer, "constraints", &manifest.constraints)?;
    write_serialized_non_empty_array(writer, "overrides", &manifest.overrides)?;
    write_serialized_non_empty_array(writer, "excludes", &manifest.excludes)?;
    write_serialized_non_empty_array(writer, "build-constraints", &manifest.build_constraints)?;

    if has_dependency_groups {
        writer.table(&["manifest", "dependency-groups"])?;
        for (group, requirements) in &manifest.dependency_groups {
            if requirements.is_empty() {
                continue;
            }
            write_serialized_non_empty_array(writer, group.as_ref(), requirements)?;
        }
    }

    for metadata in &manifest.dependency_metadata {
        writer.array_of_tables(&["manifest", "dependency-metadata"])?;
        writer.key_value("name", metadata.name.as_ref())?;
        if let Some(version) = metadata.version.as_ref() {
            writer.key_value("version", version.to_string())?;
        }
        if !metadata.requires_dist.is_empty() {
            let value = serialize_value(&metadata.requires_dist)?;
            writer.key_value("requires-dist", value)?;
        }
        if let Some(requires_python) = metadata.requires_python.as_ref() {
            writer.key_value("requires-python", requires_python.to_string())?;
        }
        if !metadata.provides_extra.is_empty() {
            let value = serialize_value(&metadata.provides_extra)?;
            writer.key_value("provides-extras", value)?;
        }
    }

    Ok(())
}

fn write_package(
    writer: &mut LockWriter,
    package: &Package,
    requires_python: &RequiresPython,
    simplified_environment: MarkerTree,
    dist_count_by_name: &FxHashMap<PackageName, u64>,
) -> Result<(), WriteError> {
    writer.array_of_tables(&["package"])?;
    write_package_id(writer, &package.id, None, PackageIdLocation::Table)?;

    if !package.fork_markers.is_empty() {
        let markers = simplified_universal_markers(&package.fork_markers, requires_python);
        if !markers.is_empty() {
            writer.key_multiline_array("resolution-markers", markers, |writer, marker| {
                writer.value(&marker)
            })?;
        }
    }

    if !package.dependencies.is_empty() {
        writer.key_multiline_array(
            "dependencies",
            &package.dependencies,
            |writer, dependency| {
                write_dependency_inline(
                    writer,
                    dependency,
                    simplified_environment,
                    dist_count_by_name,
                )
            },
        )?;
    }

    if let Some(source_dist) = &package.sdist {
        writer.key_start("sdist")?;
        write_source_dist_inline(writer, source_dist)?;
        writer.raw("\n");
    }

    if !package.wheels.is_empty() {
        writer.key_multiline_array("wheels", &package.wheels, write_wheel_inline)?;
    }

    if package
        .optional_dependencies
        .values()
        .any(|dependencies| !dependencies.is_empty())
    {
        writer.table(&["package", "optional-dependencies"])?;
        for (extra, dependencies) in &package.optional_dependencies {
            if dependencies.is_empty() {
                continue;
            }
            writer.key_multiline_array(extra.as_ref(), dependencies, |writer, dependency| {
                write_dependency_inline(
                    writer,
                    dependency,
                    simplified_environment,
                    dist_count_by_name,
                )
            })?;
        }
    }

    if package
        .dependency_groups
        .values()
        .any(|dependencies| !dependencies.is_empty())
    {
        writer.table(&["package", "dev-dependencies"])?;
        for (group, dependencies) in &package.dependency_groups {
            if dependencies.is_empty() {
                continue;
            }
            writer.key_multiline_array(group.as_ref(), dependencies, |writer, dependency| {
                write_dependency_inline(
                    writer,
                    dependency,
                    simplified_environment,
                    dist_count_by_name,
                )
            })?;
        }
    }

    let metadata = &package.metadata;
    let has_metadata = !metadata.requires_dist.is_empty()
        || !metadata.dependency_groups.is_empty()
        || !metadata.provides_extra.is_empty();
    if has_metadata {
        writer.table(&["package", "metadata"])?;
        write_serialized_non_empty_array(writer, "requires-dist", &metadata.requires_dist)?;
        if !metadata.provides_extra.is_empty() {
            writer.key_start("provides-extras")?;
            writer.array(&metadata.provides_extra, |writer, extra| {
                writer.value(extra.as_ref())
            })?;
            writer.raw("\n");
        }

        if !metadata.dependency_groups.is_empty() {
            writer.table(&["package", "metadata", "requires-dev"])?;
            for (group, requirements) in &metadata.dependency_groups {
                write_serialized_array(writer, group.as_ref(), requirements)?;
            }
        }
    }

    Ok(())
}

/// Writes a package identity, omitting fields that a unique package name makes redundant.
///
/// Passing no distribution counts forces the full version and source identity to be written.
fn write_package_id(
    writer: &mut LockWriter,
    package_id: &PackageId,
    dist_count_by_name: Option<&FxHashMap<PackageName, u64>>,
    mut location: PackageIdLocation<'_>,
) -> Result<(), WriteError> {
    let count = dist_count_by_name.and_then(|map| map.get(&package_id.name).copied());
    location.value(writer, "name", package_id.name.as_ref())?;
    if count.is_none_or(|count| count > 1) {
        if let Some(version) = &package_id.version {
            location.value(writer, "version", version.to_string())?;
        }
        location.nested_value(writer, "source", |writer| {
            write_source_inline(writer, &package_id.source)
        })?;
    }
    Ok(())
}

enum PackageIdLocation<'a> {
    Table,
    Inline(&'a mut bool),
}

impl PackageIdLocation<'_> {
    fn value(
        &mut self,
        writer: &mut LockWriter,
        key: &str,
        value: impl WriteTomlValue,
    ) -> Result<(), WriteError> {
        match self {
            Self::Table => writer.key_value(key, value),
            Self::Inline(first) => writer.inline_value(first, key, value),
        }
    }

    fn nested_value(
        &mut self,
        writer: &mut LockWriter,
        key: &str,
        write_value: impl FnOnce(&mut LockWriter) -> Result<(), WriteError>,
    ) -> Result<(), WriteError> {
        match self {
            Self::Table => {
                writer.key_start(key)?;
                write_value(writer)?;
                writer.raw("\n");
            }
            Self::Inline(first) => {
                writer.inline_key_start(first, key)?;
                write_value(writer)?;
            }
        }
        Ok(())
    }
}

fn write_source_inline(writer: &mut LockWriter, source: &Source) -> Result<(), WriteError> {
    let mut first = true;
    writer.start_inline_table();
    match source {
        Source::Registry(source) => match source {
            RegistrySource::Url(url) => {
                writer.inline_value(&mut first, "registry", url.as_ref())?;
            }
            RegistrySource::Path(path) => {
                writer.inline_value(
                    &mut first,
                    "registry",
                    PortablePath::from(path).to_string(),
                )?;
            }
        },
        Source::Git(url, _) => {
            writer.inline_value(&mut first, "git", url.as_ref())?;
        }
        Source::Direct(url, DirectSource { subdirectory }) => {
            writer.inline_value(&mut first, "url", url.as_ref())?;
            if let Some(subdirectory) = subdirectory {
                writer.inline_value(
                    &mut first,
                    "subdirectory",
                    PortablePath::from(subdirectory).to_string(),
                )?;
            }
        }
        Source::Path(path) => {
            writer.inline_value(&mut first, "path", PortablePath::from(path).to_string())?;
        }
        Source::Directory(path) => {
            writer.inline_value(
                &mut first,
                "directory",
                PortablePath::from(path).to_string(),
            )?;
        }
        Source::Editable(path) => {
            writer.inline_value(&mut first, "editable", PortablePath::from(path).to_string())?;
        }
        Source::Virtual(path) => {
            writer.inline_value(&mut first, "virtual", PortablePath::from(path).to_string())?;
        }
    }
    writer.finish_inline_table(first);
    Ok(())
}

fn write_source_dist_inline(
    writer: &mut LockWriter,
    source_dist: &SourceDist,
) -> Result<(), WriteError> {
    let mut first = true;
    writer.start_inline_table();
    match source_dist {
        SourceDist::Metadata { .. } => {}
        SourceDist::Url { url, .. } => {
            writer.inline_value(&mut first, "url", url.as_ref())?;
        }
        SourceDist::Path { path, .. } => {
            writer.inline_value(&mut first, "path", PortablePath::from(path).to_string())?;
        }
    }
    if let Some(hash) = source_dist.hash() {
        writer.inline_value(&mut first, "hash", hash.to_string())?;
    }
    if let Some(size) = source_dist.size() {
        writer.inline_value(&mut first, "size", size)?;
    }
    if let Some(upload_time) = source_dist.upload_time() {
        writer.inline_value(&mut first, "upload-time", upload_time.to_string())?;
    }
    writer.finish_inline_table(first);
    Ok(())
}

fn write_wheel_inline(writer: &mut LockWriter, wheel: &Wheel) -> Result<(), WriteError> {
    let mut first = true;
    writer.start_inline_table();
    match &wheel.url {
        WheelWireSource::Url { url } => {
            writer.inline_value(&mut first, "url", url.as_ref())?;
        }
        WheelWireSource::Path { path } => {
            writer.inline_value(&mut first, "path", PortablePath::from(path).to_string())?;
        }
        WheelWireSource::Filename { filename } => {
            writer.inline_value(&mut first, "filename", filename.to_string())?;
        }
    }
    if let Some(hash) = &wheel.hash {
        writer.inline_value(&mut first, "hash", hash.to_string())?;
    }
    if let Some(size) = wheel.size {
        writer.inline_value(&mut first, "size", size)?;
    }
    if let Some(upload_time) = wheel.upload_time {
        writer.inline_value(&mut first, "upload-time", upload_time.to_string())?;
    }
    if let Some(zstd) = &wheel.zstd {
        writer.inline_key_start(&mut first, "zstd")?;
        let mut zstd_first = true;
        writer.start_inline_table();
        if let Some(hash) = &zstd.hash {
            writer.inline_value(&mut zstd_first, "hash", hash.to_string())?;
        }
        if let Some(size) = zstd.size {
            writer.inline_value(&mut zstd_first, "size", size)?;
        }
        writer.finish_inline_table(zstd_first);
    }
    writer.finish_inline_table(first);
    Ok(())
}

/// Writes a dependency edge without identity or marker data implied by the enclosing resolution.
fn write_dependency_inline(
    writer: &mut LockWriter,
    dependency: &Dependency,
    simplified_environment: MarkerTree,
    dist_count_by_name: &FxHashMap<PackageName, u64>,
) -> Result<(), WriteError> {
    let mut first = true;
    writer.start_inline_table();

    write_package_id(
        writer,
        &dependency.package_id,
        Some(dist_count_by_name),
        PackageIdLocation::Inline(&mut first),
    )?;

    if !dependency.extra.is_empty() {
        writer.inline_key_start(&mut first, "extra")?;
        writer.array(&dependency.extra, |writer, extra| {
            writer.value(extra.as_ref())
        })?;
    }

    // Avoid restating the resolution's environment on every dependency edge.
    if let Some(marker) = dependency
        .simplified_marker
        .as_simplified_marker_tree()
        .restrict(simplified_environment)
        .try_to_string()
    {
        writer.inline_value(&mut first, "marker", &marker)?;
    }

    writer.finish_inline_table(first);
    Ok(())
}

/// Writes a Serde-backed array, omitting the key when the array is empty.
fn write_serialized_non_empty_array<T: Serialize>(
    writer: &mut LockWriter,
    key: &str,
    values: &BTreeSet<T>,
) -> Result<(), WriteError> {
    if values.is_empty() {
        return Ok(());
    }
    write_serialized_array(writer, key, values)
}

/// Writes a Serde-backed array using the canonical layout for its cardinality.
///
/// Empty and single-element arrays stay on one line, while larger arrays place each element on
/// its own line. Unlike [`write_serialized_non_empty_array`], this retains empty dependency groups.
fn write_serialized_array<T: Serialize>(
    writer: &mut LockWriter,
    key: &str,
    values: &BTreeSet<T>,
) -> Result<(), WriteError> {
    writer.key_start(key)?;
    let write_value = |writer: &mut LockWriter, value: &T| {
        let value = serialize_value(value)?;
        writer.value(value)
    };
    if values.len() <= 1 {
        writer.array(values, write_value)?;
        writer.raw("\n");
    } else {
        writer.multiline_array(values, write_value)?;
    }
    Ok(())
}

/// Adapts values without native `toml_writer` support through Serde's TOML value serializer.
struct SerializedValue(Value);

impl WriteTomlValue for SerializedValue {
    fn write_toml_value<W: TomlWrite + ?Sized>(&self, writer: &mut W) -> fmt::Result {
        writer.write_str(&self.0.to_string())
    }
}

fn serialize_value<T: Serialize + ?Sized>(value: &T) -> Result<SerializedValue, WriteError> {
    Ok(SerializedValue(Serialize::serialize(
        value,
        toml_edit::ser::ValueSerializer::new(),
    )?))
}

#[derive(Debug)]
enum WriteError {
    Format,
    Serialize(toml_edit::ser::Error),
}

impl From<fmt::Error> for WriteError {
    fn from(_: fmt::Error) -> Self {
        Self::Format
    }
}

impl From<toml_edit::ser::Error> for WriteError {
    fn from(error: toml_edit::ser::Error) -> Self {
        Self::Serialize(error)
    }
}

/// Emits TOML while retaining the established whitespace and inline-table layout of `uv.lock`.
#[derive(Default)]
struct LockWriter {
    output: String,
}

impl LockWriter {
    fn raw(&mut self, value: &str) {
        self.output.push_str(value);
    }

    fn key(&mut self, key: &str) -> fmt::Result {
        self.output.key(key)
    }

    fn value(&mut self, value: impl WriteTomlValue) -> Result<(), WriteError> {
        self.output.value(value)?;
        Ok(())
    }

    fn key_start(&mut self, key: &str) -> Result<(), WriteError> {
        self.key(key)?;
        self.raw(" = ");
        Ok(())
    }

    fn key_value(&mut self, key: &str, value: impl WriteTomlValue) -> Result<(), WriteError> {
        self.key_start(key)?;
        self.value(value)?;
        self.raw("\n");
        Ok(())
    }

    fn table(&mut self, path: &[&str]) -> Result<(), WriteError> {
        self.header(path, false)
    }

    fn array_of_tables(&mut self, path: &[&str]) -> Result<(), WriteError> {
        self.header(path, true)
    }

    /// Starts a table header on a new line, separating it from the preceding table body.
    fn header(&mut self, path: &[&str], array: bool) -> Result<(), WriteError> {
        self.raw("\n");
        if array {
            self.raw("[[");
        } else {
            self.raw("[");
        }
        for (index, key) in path.iter().enumerate() {
            if index > 0 {
                self.raw(".");
            }
            self.key(key)?;
        }
        if array {
            self.raw("]]\n");
        } else {
            self.raw("]\n");
        }
        Ok(())
    }

    fn key_multiline_array<I, T, F>(
        &mut self,
        key: &str,
        values: I,
        write_value: F,
    ) -> Result<(), WriteError>
    where
        I: IntoIterator<Item = T>,
        F: FnMut(&mut Self, T) -> Result<(), WriteError>,
    {
        self.key_start(key)?;
        self.multiline_array(values, write_value)
    }

    fn multiline_array<I, T, F>(&mut self, values: I, mut write_value: F) -> Result<(), WriteError>
    where
        I: IntoIterator<Item = T>,
        F: FnMut(&mut Self, T) -> Result<(), WriteError>,
    {
        self.raw("[\n");
        for value in values {
            self.raw("    ");
            write_value(self, value)?;
            self.raw(",\n");
        }
        self.raw("]\n");
        Ok(())
    }

    fn array<I, T, F>(&mut self, values: I, mut write_value: F) -> Result<(), WriteError>
    where
        I: IntoIterator<Item = T>,
        F: FnMut(&mut Self, T) -> Result<(), WriteError>,
    {
        self.raw("[");
        for (index, value) in values.into_iter().enumerate() {
            if index > 0 {
                self.raw(", ");
            }
            write_value(self, value)?;
        }
        self.raw("]");
        Ok(())
    }

    fn start_inline_table(&mut self) {
        self.raw("{");
    }

    fn finish_inline_table(&mut self, first: bool) {
        if !first {
            self.raw(" ");
        }
        self.raw("}");
    }

    /// Writes the separator and key for the next inline-table entry.
    fn inline_key_start(&mut self, first: &mut bool, key: &str) -> Result<(), WriteError> {
        if *first {
            self.raw(" ");
            *first = false;
        } else {
            self.raw(", ");
        }
        self.key_start(key)
    }

    fn inline_value(
        &mut self,
        first: &mut bool,
        key: &str,
        value: impl WriteTomlValue,
    ) -> Result<(), WriteError> {
        self.inline_key_start(first, key)?;
        self.value(value)
    }
}

#[cfg(test)]
mod tests {
    use super::{LockWriter, Value};

    #[test]
    fn string_encoding_matches_toml_edit() {
        for value in [
            "",
            "https://example.com/packages/example-1.0.0-py3-none-any.whl",
            "it's valid",
            "unicode-λ",
            "contains\"quote",
            r"contains\backslash",
            "contains\ttab",
            "contains\nnewline",
            "contains\u{7f}delete",
        ] {
            let mut writer = LockWriter::default();
            writer.value(value).expect("writing to a string succeeds");
            assert_eq!(writer.output, Value::from(value).to_string());
        }
    }
}