Mojo::JSON::Pointer(3pm) - Man pages

Mojo::JSON::Pointer(3pUser Contributed Perl DocumentatMojo::JSON::Pointer(3pm)

NAME
       Mojo::JSON::Pointer - JSON Pointers

SYNOPSIS
         use Mojo::JSON::Pointer;

         my $pointer = Mojo::JSON::Pointer->new({foo => [23, 'bar']});
         say $pointer->get('/foo/1');
         say 'Contains "/foo".' if $pointer->contains('/foo');

DESCRIPTION
       Mojo::JSON::Pointer is an implementation of RFC 6901
       <https://tools.ietf.org/html/rfc6901>.

ATTRIBUTES
       Mojo::JSON::Pointer implements the following attributes.

   data
         my $data = $pointer->data;
         $pointer = $pointer->data({foo => 'bar'});

       Data structure to be processed.

METHODS
       Mojo::JSON::Pointer inherits all methods from Mojo::Base and implements
       the following new ones.

   contains
         my $bool = $pointer->contains('/foo/1');

       Check if "data" contains a value that can be identified with the given
       JSON Pointer.

         # True
         Mojo::JSON::Pointer->new('just a string')->contains('');
         Mojo::JSON::Pointer->new({'♥' => 'mojolicious'})->contains('/♥');
         Mojo::JSON::Pointer->new({foo => 'bar', baz => [4, 5]})->contains('/foo');
         Mojo::JSON::Pointer->new({foo => 'bar', baz => [4, 5]})->contains('/baz/1');

         # False
         Mojo::JSON::Pointer->new({'♥' => 'mojolicious'})->contains('/☃');
         Mojo::JSON::Pointer->new({foo => 'bar', baz => [4, 5]})->contains('/bar');
         Mojo::JSON::Pointer->new({foo => 'bar', baz => [4, 5]})->contains('/baz/9');

   get
         my $value = $pointer->get('/foo/bar');

       Extract value from "data" identified by the given JSON Pointer.

         # "just a string"
         Mojo::JSON::Pointer->new('just a string')->get('');

         # "mojolicious"
         Mojo::JSON::Pointer->new({'♥' => 'mojolicious'})->get('/♥');

         # "bar"
         Mojo::JSON::Pointer->new({foo => 'bar', baz => [4, 5, 6]})->get('/foo');

         # "4"
         Mojo::JSON::Pointer->new({foo => 'bar', baz => [4, 5, 6]})->get('/baz/0');

         # "6"
         Mojo::JSON::Pointer->new({foo => 'bar', baz => [4, 5, 6]})->get('/baz/2');

   new
         my $pointer = Mojo::JSON::Pointer->new;
         my $pointer = Mojo::JSON::Pointer->new({foo => 'bar'});

       Build new Mojo::JSON::Pointer object.

SEE ALSO
       Mojolicious, Mojolicious::Guides, <https://mojolicious.org>.

perl v5.36.0                      2022-12-22          Mojo::JSON::Pointer(3pm)

Generated by dwww version 1.15 on Tue Jun 25 04:05:26 CEST 2024.