The Perl and Raku Conference 2025: Greenville, South Carolina - June 27-29 Learn more

SAMYOUNG / EBook-Ishmael-0.05 / lib / EBook / Ishmael / EBook / PDB / Record.pm 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
—
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142

              
package EBook::Ishmael::EBook::PDB::Record;
use 5.016;
our $VERSION = '0.05';
use strict;
use warnings;
sub new {
        my $class  = shift;
        my $data   = shift;
        my $params = shift;
        my $self = {
                Data => $data,
                Off  => $params->{Offset},
                Attr => $params->{Attributes},
                UID  => $params->{UID},
        };
        return bless $self, $class;
}
sub data {
        my $self = shift;
        return $self->{Data};
}
sub offset {
        my $self = shift;
        return $self->{Off};
}
sub attributes {
        my $self = shift;
        return $self->{Attr};
}
sub uid {
        my $self = shift;
        return $self->{UID};
}
1;
=head1 NAME
EBook::Ishmael::EBook::PDB::Record - L<ishmael> PDB record interface
=head1 SYNOPSIS
  use EBook::Ishmael::EBook::PDB::Record;
  my $rec = EBook::Ishmael::EBook::PDB::Record->new(
      $data,
      {
          Offset => $offset,
          Attributes => $attr,
          UID => $uid
      }
  );
=head1 DESCRIPTION
B<EBook::Ishmael::EBook::PDB::Record> is a module that provides an interface
for reading Palm PDB records. For L<ishmael> user documentation, you should
consult its manual (this is developer documentation).
=head1 METHODS
=head2 $r = EBook::Ishmael::EBook::PDB::Record->new($data, $info)
Returns a blessed B<EBook::Ishmael::EBook::PDB::Record> object. C<$data> is a
scalar holding the record's data, C<$info> is a hash ref of the record's info
data.
=over 4
=item Off
The record's offset.
=item Attributes
The record's attribute bitfield.
=item UID
The record's UID.
=back
=head2 $d = $r->data()
Returns the record's data.
=head2 $o = $r->offset()
Returns the record's offset.
=head2 $a = $r->attributes()
Returns the record's attribute bitfield.
=head2 $u = $r->uid()
Returns the record's UID.
=head1 AUTHOR
Written by Samuel Young, E<lt>samyoung12788@gmail.comE<gt>.
This project's source can be found on its
L<Codeberg Page|https://codeberg.org/1-1sam/ishmael>. Comments and pull
requests are welcome!
=head1 COPYRIGHT
Copyright (C) 2025 Samuel Young
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
=head1 SEE ALSO
L<EBook::Ishmael::EBook::PDB>
=cut