<!-- GENERATED by docs/sphinx/bin/20-reference (p5) from reference/bundled/YAML/PP/Common.md. Do not edit. -->

```{index} single: YAML::PP::Common
```

# YAML::PP::Common

Constants and common functions

## SYNOPSIS

```perl
use YAML::PP::Common ':STYLES';
# or
use YAML::PP::Common qw/
    YAML_ANY_SCALAR_STYLE YAML_PLAIN_SCALAR_STYLE
    YAML_SINGLE_QUOTED_SCALAR_STYLE YAML_DOUBLE_QUOTED_SCALAR_STYLE
    YAML_LITERAL_SCALAR_STYLE YAML_FOLDED_SCALAR_STYLE
    YAML_QUOTED_SCALAR_STYLE

    YAML_ANY_SEQUENCE_STYLE
    YAML_BLOCK_SEQUENCE_STYLE YAML_FLOW_SEQUENCE_STYLE

    YAML_ANY_MAPPING_STYLE
    YAML_BLOCK_MAPPING_STYLE YAML_FLOW_MAPPING_STYLE
/;

use YAML::PP::Common ':PRESERVE';
# or
use YAML::PP::Common qw/
    PRESERVE_ALL PRESERVE_ORDER PRESERVE_SCALAR_STYLE PRESERVE_FLOW_STYLE
    PRESERVE_ALIAS
/:
```

## DESCRIPTION

This module provides common constants and functions for modules working with
YAML::PP events.

## FUNCTIONS

- event\_to\_test\_suite

    ```perl
    my $string = YAML::PP::Common::event_to_test_suite($event_prom_parser);
    ```

    For examples of the returned format look into this distributions's directory
    `yaml-test-suite` which is a copy of
    [https://github.com/yaml/yaml-test-suite](https://github.com/yaml/yaml-test-suite).

- test\_suite\_to\_event

    ```perl
    my $event = YAML::PP::Common::test_suite_to_event($str);
    ```

    Turns an event string in test suite format into an event hashref. Not complete
    yet.