|
Unix VPS
Support
FAQ
Network
Miscellaneous
|
| Data::HexDump::Range::Gather(3) | User Contributed Perl Documentation | Data::HexDump::Range::Gather(3) |
NAME
Data::HexDump::Range::Gather - Handles gathering of binary data for Data::HexDump::RangeSYNOPSIS
DESCRIPTION
DOCUMENTATION
SUBROUTINES/METHODS
Subroutines prefixed with [P] are not part of the public API and shall not be used directly.[P] _gather($range_description, $data, $offset, $size)
Creates an internal data structure from the data to dump.$hdr->_gather($container, $range_description, $data, $size)
Arguments - See gather
- $container - an array reference or undef - where the gathered data
- $range_description - See gather
- $data - See gather
- $offset - See gather
- $size - See gather
Returns -
- $container - the gathered data
- $used_data - integer - the location in the data where the dumping ended
Exceptions dies if passed invalid parameters
[P] create_range_provider($range_description)
Transforms the user supplied ranges into an internal formatArguments -
- •
- $range_description - An array reference or a subroutine reference
Returns - Array reference - ranges in internal format
Exceptions - None
[P] unpack_range_size($self, $range_name, $size, $used_data)
Verifies the size field from a range descritpion and generates unpack formatArguments -
- $self
- $range_name
- $size
- $used_data
Returns - A list
- $is_header - Boolean -
- $is_comment - Boolean -
- $is_bitfield - Boolean -
- $range_size - Integer
- $unpack_format - A String - formated according to pack.
Exceptions - Croaks with an error messge if the input data is invalid
[P] create_ranges($range_description)
Transforms the user supplied ranges into an internal formatArguments -
- •
- $range_description - See gather
Returns - Array ference - ranges in internal format
Exceptions - Croaks with an error messge if the input data is invalid
[P] create_ranges_from_string($range_description)
Transforms the user supplied ranges into an internal formatArguments -
- •
- $range_description - A string - See gather
Returns - Array ference - ranges in internal format
Exceptions - Croaks with an error messge if the input data is invalid
[P] create_ranges_from_array_ref($range_description)
transforms the user supplied ranges into an internal formatArguments -
- •
- $range_description - An array reference - See gather
Returns - Returns - Array ference - ranges in internal format
Exceptions - Croaks with an error messge if the input data is invalid
[P] flatten($range_description)
transforms the user supplied ranges into an internal formatArguments -
- •
- $range_description - See gather
Returns - Nothing
Exceptions - Croaks with an error messge if the input data is invalid
BUGS AND LIMITATIONS
None so far.AUTHOR
Nadim ibn hamouda el Khemir
CPAN ID: NKH
mailto: nadim@cpan.org
COPYRIGHT AND LICENSE
Copyright Nadim Khemir 2010.This program is free software; you can redistribute it and/or modify it under the terms of either:
- the GNU General Public License as published by the Free Software Foundation; either version 1, or (at your option) any later version, or
- the Artistic License version 2.0.
SUPPORT
You can find documentation for this module with the perldoc command.
perldoc Data::HexDump::Range
You can also look for information at:
- AnnoCPAN: Annotated CPAN documentation
<http://annocpan.org/dist/Data-HexDump-Range>
- RT: CPAN's request tracker
Please report any bugs or feature requests to L <bug-data-hexdump-range@rt.cpan.org>.
We will be notified, and then you'll automatically be notified of progress on your bug as we make changes.
- Search CPAN
<http://search.cpan.org/dist/Data-HexDump-Range>
SEE ALSO
Data::HexDump::Range| 2022-04-08 | perl v5.32.1 |
Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.