Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Data::HexDump::Range::UsertContributed Perl DocuData::HexDump::Range::Split(3)

NAME
       Data::HexDump::Range::Split - Handles formating for
       Data::HexDump::Range

SYNOPSIS
DESCRIPTION
DOCUMENTATION
SUBROUTINES/METHODS
       Subroutines prefixed with [P] are not part of the public	API and	shall
       not be used directly.

   [P] split($collected_data)
       Split the collected data	into lines

       Arguments -

       o $container - Collected	data

       Returns -  An Array  containing column elements

       Exceptions

   [P] _split_horizontal($collected_data)
       Split the collected data	into horizontal	lines

       Arguments -

       o $container - Collected	data

       Returns -  An Array  containing column elements

       Exceptions

       o   $self -

       o   $visible - Boolean -	wether the range elements will be visible or
	   not.	used for alignment

       o   $range - the	range structure	created	by Gather

       o   $line - container for the range strings to be displayed

       o   $last_range - Boolean - wether the range is the last	one to be
	   displayed

       o   $total_dumped_data -	Integer	-  the amount of total data dumped so
	   far

       o   $dumped_data	- Integer - the	amount of byte dumped from the range
	   so far

       o   $size_to_dump - Integer - the amount	of data	to extract from	the
	   range

       o   $room_left -	Integer	- the amount of	space left in the line for the
	   dimped data

   [P] _split_vertical($collected_data)
       Split the collected data	into vertical lines

       Arguments -

       o $container - Collected	data

       Returns -  An Array  containing column elements

       Exceptions

   [P] _dump_range_horizontal(...)
       Splits a	range into a structure used for	horizontal display

       Arguments -

       o $self -

       o $visible - Boolean - wether the range elements	will be	visible	or
	 not. used for alignment

       o $range	- the range structure created by Gather

       o $line - container for the range strings to be displayed

       o $last_range - Boolean - wether	the range is the last one to be
	 displayed

       o $total_dumped_data - Integer -	 the amount of total data dumped so
	 far

       o $dumped_data -	Integer	- the amount of	byte dumped from the range so
	 far

       o $size_to_dump - Integer - the amount of data to extract from the
	 range

       o $room_left - Integer -	the amount of space left in the	line for the
	 dimped	data

       Returns -  Nothing. Stores the result in	the $line argument

       Exceptions

   [P] _dump_range_vertical()
       Splits a	range into a structure used for	vertical display

       Arguments -

       o $self -

       o $visible - Boolean - wether the range elements	will be	visible	or
	 not. used for alignment

       o $range	- the range structure created by Gather

       o $line - container for the range strings to be displayed

       o $dumped_data -	Integer	- the amount of	byte dumped from the range so
	 far

       o $total_dumped_data - Integer -	 the amount of total data dumped so
	 far

       o $size_to_dump - Integer - the amount of data to extract from the
	 range

       Returns -

       Exceptions

   [P] get_bitfield_lines($bitfield_description)
       Split the collected data	into lines

       Arguments -

       o $self - a Data::HexDump::Range	object

       o $bitfield_description -

       Returns - An Array  containing column elements,

       Exceptions None but will	embed an error in the element if any is	found

   [P] add_information($split_data)
       Add information,	according to the options passed	to the constructor, to
       the internal data.

       Arguments - See gather

       o $split_data - data returned by	_gather()

       Returns - Nothing

       Exceptions - None

   [P] get_information($split_data)
       Returns information, according to the options passed to the
       constructor, to the internal data.

       Arguments - See gather

       o $split_data - data returned by	_gather()

       Returns - Nothing

       Exceptions - None

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:

       o   the GNU General Public License as published by the Free Software
	   Foundation; either version 1, or (at	your option) any later
	   version, or

       o   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:

       o   AnnoCPAN: Annotated CPAN documentation

	   <http://annocpan.org/dist/Data-HexDump-Range>

       o   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.

       o   Search CPAN

	   <http://search.cpan.org/dist/Data-HexDump-Range>

SEE ALSO
       Data::HexDump::Range

POD ERRORS
       Hey! The	above document had some	coding errors, which are explained
       below:

       Around line 142:
	   '=item' outside of any '=over'

       Around line 324:
	   You forgot a	'=back'	before '=head2'

perl v5.24.1			  2017-07-02	Data::HexDump::Range::Split(3)

NAME | SYNOPSIS | DESCRIPTION | DOCUMENTATION | SUBROUTINES/METHODS | BUGS AND LIMITATIONS | AUTHOR | COPYRIGHT AND LICENSE | SUPPORT | SEE ALSO | POD ERRORS

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Data::HexDump::Range::Split&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help