<!-- GENERATED by docs/sphinx/bin/20-reference (p5) from Peta/XS.rs (xs_magic). Do not edit. -->

```{index} single: magic; Peta::XS function
```
```{index} single: Peta::XS::magic; Perl function
```

# magic

Inventory of the magic attached to the variable `$ref` points at.

## Synopsis

```perl
use Peta::XS ':facts';
tie my %h, 'Some::Tie';
for my $m (magic(\%h)) {
    printf "type=%s get=%d set=%d\n", $m->{type}, $m->{get}, $m->{set};
}
```

## What you get back

One hashref per attachment, in chain order (most recently attached
first, mirroring perl's prepend discipline): `type` is perl's
public one-character magic type (the `perlguts` vocabulary - 'P'
tied array/hash, 'q' tied scalar, '~' extension magic as used by
[`cast`](cast)), `get`/`set` are booleans saying whether the
attachment hooks reads/writes. In scalar context: the number of
attachments. An unmagical variable yields an empty list / 0.

## Examples

```perl
my $plain = 1;
say scalar magic(\$plain);          # 0

## is this hash really tied?

tie my %cfg, 'Config::Tied';
my ($m) = magic(\%cfg);
say "tied!" if $m && $m->{type} eq 'P';

## see your own wizards (and their hook shape) from the outside

use Peta::XS ':magic';
my $w = wizard(get => sub { });
my $x = 1;
cast(\$x, $w);
my @mg = magic(\$x);                # ({ type => '~', get => 1, set => 1 })

## debugging aid: why is every read of $slow slow?

printf "%s(get=%d,set=%d)\n", @{$_}{qw(type get set)}
    for magic(\$slow);
```

## See also

- [`cast`](cast) / [`dispell`](dispell) - attach and detach '~' magic.
- [`refcount`](refcount), [`value_slots`](value_slots) - the other facts.
- `perldoc perlguts` - the magic type vocabulary.