Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
initial Buf docs
  • Loading branch information
moritz committed Jun 13, 2012
1 parent 48250ae commit 7034ce6
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions lib/Buf.pod
@@ -0,0 +1,31 @@
=begin pod
=head1 Buf
class Buf does Positional { ... }
A C<Buf> (short for buffer) is a binary string, and generally returned from
low-level IO operations. In the abstract it is just a list of integers, so
for example indexing into a C<Buf> with C<.[$idx]> returns an C<Int>.
=head2 Methods
=head3 new
method new(*@codes)
Creates a C<Buf> from a list of integers.
=head3 Bool
multi method Bool(Buf:D:)
Returns C<False> if and only if the buffer is empty.
=head3 elems
multi method elems(Buf:D:) returns Int:D
Returns the number of elements of the buffer.
=end pod

0 comments on commit 7034ce6

Please sign in to comment.