NAME

Data::Hub::Courier - Courier services for hierarchical data addresses

SYNOPSIS

EXPORTS

Nothing exported by default

DEPENDENCIES

This module requires these other modules and libraries:

    Data::Hub::Subset
    Error::Simple
    Error::Programatic
    Perl::Module
    Data::Hub::Util
    Data::Hub::ExpandedSubset
    Perl::Comparison
    Data::Hub::Query

DESCRIPTION

EXAMPLES

This example:

  use Data::Hub::Courier;
  my $h = {
    A => {
      I => [
        'Hello'
      ],
    },
  };
  Data::Hub::Courier::set($h, '/A/I/1', 'World!');
  my $a = Data::Hub::Courier::get($h, '/A/I');
  join ' ', @$a;

will return:

  Hello World!

PUBLIC INTERFACE

append

Append an item on to the container

This example:

  # Append to an array
  my $h = {g=>[qw(a b)]};
  Data::Hub::Courier::append($h, '/g', 'c');
  join('', @{$$h{g}});

will return:

  abc

This example:

  # Append to a hash
  my $h = {g=>Data::OrderedHash->new(a => 1, b => 2)};
  Data::Hub::Courier::append($h, '/g', c => 3);
  join('', keys %{$$h{g}});

will return:

  abc

This example:

  # Append to a scalar
  my $h = {g=>str_ref('ab')};
  Data::Hub::Courier::append($h, '/g', 'c');
  ${$$h{g}};

will return:

  abc

prepend

Prepend an item on to the container

This example:

  # Prepend to an array
  my $h = {g=>[qw(b c)]};
  Data::Hub::Courier::prepend($h, '/g', 'a');
  join('', @{$$h{g}});

will return:

  abc

This example:

  # Prepend to a hash
  my $h = {g=>Data::OrderedHash->new(b => 2, c => 3)};
  Data::Hub::Courier::prepend($h, '/g', a => 1);
  join('', keys %{$$h{g}});

will return:

  abc

This example:

  # Prepend to a scalar
  my $h = {g=>str_ref('bc')};
  Data::Hub::Courier::prepend($h, '/g', 'a');
  ${$$h{g}};

will return:

  abc

PACKAGE INTERNALS

TODO

The items should be curried.

AUTHORS

    Ryan Gies <ryangies@cpan.org>

COPYRIGHT

    Copyright (C) 2014-2016 by Ryan Gies. All rights reserved.
    Copyright (C) 2006-2013 by Livesite Networks, LLC. All rights reserved.
    Copyright (C) 2000-2005 by Ryan Gies. All rights reserved.
    Redistribution and use in source and binary forms, with or without 
    modification, are permitted provided that the following conditions are met:
    * Redistributions of source code must retain the above copyright notice, 
    this list of conditions and the following disclaimer.
    * The origin of this software must not be misrepresented; you must not 
    claim that you wrote the original software. If you use this software in a 
    product, an acknowledgment in the product documentation would be 
    appreciated but is not required.
    * Altered source versions must be plainly marked as such, and must not be 
    misrepresented as being the original software.
    * The name of the author may not be used to endorse or promote products 
    derived from this software without specific prior written permission.

    THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED 
    WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 
    MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO 
    EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 
    OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 
    IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 
    OF SUCH DAMAGE.
    To the best of our knowledge, no patented algorithms have been used. However, we
    do not have the resources to carry out a patent search, and therefore cannot 
    give any guarantee of the above statement.