Serializers

The best supported snapshot experience is based on serde because it enables functionality such as redactions. When you assert on serde serializable types you can chose a variety of serialization formats. The example used for all of these is a list of two structs.

Debug

This is the only serializer in insta that does not use serde behind the scenes but instead uses the default std::fmt::Debug representation of a value. Because this is not based on the Serialize trait this serializer does not support redactions. To use it use the assert_debug_snapshot! macro:

insta::assert_debug_snapshot!(&user_list);
[
    User(
        id: 1,
        email: "root@example.com",
        is_admin: true,
    ),
    User(
        id: 2,
        email: "user@example.com",
        is_admin: false,
    ),
]

It's generally recommended to use the RON serializer instead if redactions are wanted.

YAML

This serializer is available by default and the recommended one for most situations. It's available through the assert_yaml_snapshot! macro:

insta::assert_yaml_snapshot!(&user_list);
- id: 1
  email: root@example.com
  is_admin: true
- id: 2
  email: user@example.com
  is_admin: false

This serializer is recommended because YAML is human readable and excellent at diffing because it is line based.

JSON

This serializer is also available by default but usually not recommended. It's available through the assert_json_snapshot! macro:

insta::assert_json_snapshot!(&user_list);
[
  {
    "id": 1,
    "email": "root@example.com",
    "is_admin": true
  },
  {
    "id": 2,
    "email": "user@example.com",
    "is_admin": false
  }
]

The JSON serializer is mainly useful if you are working with JSON APIs and you want to serialize the responses exactly as they happen from the API. However JSON itself is not ideal for diffs which makes it slightly less nice to work with compared to YAML.

TOML

TOML is a serialization format which is commonly used in configuration files. It diffs well but unfortunately it cannot represent all values that a serde serializer can produce. As such it's not enabled by default.

You need to activate it with the toml feature. Once enabled it gives you the assert_toml_snapshot! macro:

insta::assert_toml_snapshot!(&user_list_in_struct);
[[users]]
id = 1
email = 'root@example.com'
is_admin = true

[[users]]
id = 2
email = 'user@example.com'
is_admin = false

(Note that this example encloses the list in a top level struct as TOML cannot support toplevel arrays.)

RON

RON is a serialization format that contains Rust type names similar to Debug. It's excellent if you also need to assert on the types of values.

You need to activate it with the ron feature. Once enabled it gives you the assert_ron_snapshot! macro:

insta::assert_ron_snapshot!(&user_list);
[
  User(
    id: 1,
    email: "root@example.com",
    is_admin: true,
  ),
  User(
    id: 2,
    email: "user@example.com",
    is_admin: false,
  ),
]

CSV

CSV is also available as serialization format but it only works for some types of values.

You need to activate it with the csv feature. Once enabled it gives you the assert_csv_snapshot! macro:

insta::assert_csv_snapshot!(&user);
id,email,is_admin
1,root@example.com,true

(Note that this example uses a single item in the list as the CSV feature does not yet support multiple values.)

Found an issue? You can edit this page on GitHub.