facet-path 0.42.0

Path tracking for navigating Facet type structures
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

//! Snapshot tests for pretty path formatting (with miette)

#![cfg(feature = "pretty")]

use facet::Facet;
use facet_path::{Path, PathStep};

#[test]
fn test_pretty_simple_field() {
    facet_testhelpers::setup();

    #[derive(Facet)]
    #[allow(dead_code)]
    struct Config {
        name: String,
        max_retries: u8,
        enabled: bool,
    }

    let mut path = Path::new();
    path.push(PathStep::Field(1)); // max_retries

    let formatted = path.format_pretty_no_color(
        Config::SHAPE,
        "unsupported scalar type",
        Some("consider using a different type".to_string()),
    );
    insta::assert_snapshot!(formatted);
}

#[test]
fn test_pretty_nested_struct() {
    facet_testhelpers::setup();

    #[derive(Facet)]
    #[allow(dead_code)]
    struct Inner {
        value: i32,
    }

    #[derive(Facet)]
    #[allow(dead_code)]
    struct Outer {
        label: String,
        inner: Inner,
    }

    let mut path = Path::new();
    path.push(PathStep::Field(1)); // inner
    path.push(PathStep::Field(0)); // value

    let formatted = path.format_pretty_no_color(Outer::SHAPE, "type not supported", None);
    insta::assert_snapshot!(formatted);
}

#[test]
fn test_pretty_vec_index() {
    facet_testhelpers::setup();

    #[derive(Facet)]
    #[allow(dead_code)]
    struct Item {
        id: u32,
    }

    #[derive(Facet)]
    #[allow(dead_code)]
    struct Container {
        items: Vec<Item>,
    }

    let mut path = Path::new();
    path.push(PathStep::Field(0)); // items
    path.push(PathStep::Index(2)); // [2]
    path.push(PathStep::Field(0)); // id

    let formatted = path.format_pretty_no_color(
        Container::SHAPE,
        "error at index",
        Some("check your data".to_string()),
    );
    insta::assert_snapshot!(formatted);
}

#[test]
fn test_pretty_enum_variant() {
    facet_testhelpers::setup();

    #[derive(Facet)]
    #[repr(C)]
    #[allow(dead_code)]
    enum Message {
        Simple,
        WithData { value: u32, name: String },
    }

    let mut path = Path::new();
    path.push(PathStep::Variant(1)); // WithData
    path.push(PathStep::Field(1)); // name

    let formatted = path.format_pretty_no_color(Message::SHAPE, "variant field error", None);
    insta::assert_snapshot!(formatted);
}

#[test]
fn test_pretty_no_help() {
    facet_testhelpers::setup();

    #[derive(Facet)]
    #[allow(dead_code)]
    struct Simple {
        value: u8,
    }

    let mut path = Path::new();
    path.push(PathStep::Field(0));

    let formatted = path.format_pretty_no_color(Simple::SHAPE, "error without help", None);
    insta::assert_snapshot!(formatted);
}