class Buf does Positional { ... }
A Buf (short for buffer) is a binary string, and generally returned from low-level IO operations ($io.read($number-of-by)) or from Str.encode. It can be used to for writing to IO handles as $io.write($buf).
In the abstract it is just a list of integers, so for example indexing into a Buf with .[$idx] returns an Int.
method new(*@codes)
Creates a Buf from a list of integers.
multi method Bool(Buf:D:)
Returns False if and only if the buffer is empty.
multi method elems(Buf:D:) returns Int:D
Returns the number of elements of the buffer.
multi method decode(Buf:D: Str:D $encoding = 'UTF-8') returns Str:D
Applies an encoding to turn the buffer into a Str.
method subbuf(Int $from, Int $len = self.elems) returns Buf:D
Extracts a part of the invocant buffer, statrting from the index with elements $from, and taking $len elements (or less if the buffer is shorter), and creates a new buffer as the result.
say Buf.new(1..10).subbuf(2, 4); # Buf:0x<03 04 05 06>
Full-size type graph image as SVGBuf does role Positional, which provides the following methods:
method of()
Returns the type constraint for elements of the positional container. Defaults to Mu.
Buf inherits from class Any, which provides the following methods:
multi method ACCEPTS(Any:D: Mu $other)
Returns True if $other === self (ie it checks object identity).
Interprets the invocant as a list and creates an any-Junction from it.
Interprets the invocant as a list and creates an all-Junction from it.
Interprets the invocant as a list and creates an one-Junction from it.
Interprets the invocant as a list and creates an none-Junction from it.
Buf inherits from class Mu, which provides the following methods:
multi sub defined(Mu) returns Bool:D multi method defined() returns Bool:D
Returns False on the type object, and True otherwise.
multi sub Bool(Mu) returns Bool:D multi method Bool() returns Bool:D
Returns False on the type object, and True otherwise.
multi method Str() returns Str
Returns a string representation of the invocant, intended to be machine readable.
multi sub gist(Mu) returns Str multi method gist() returns Str
Returns a string representation of the invocant, optimized for fast recognition by humans.
The default gist method in Mu re-dispatches to the perl method, but many built-in classes override it to something more specific.
multi sub perl(Mu) returns Str multi method perl() returns Str
Returns a Perlish representation of the object (i.e., can usually be reparsed to regenerate the object).
method clone(*%twiddles)
Creates a shallow clone of the invocant. If named arguments are passed to it, their values are used in every place where an attribute name matches the name of a named argument.
multi method new(*%attrinit)
Default method for constructing (create + initialize) new objects of a class. This method expects only named arguments which are then used to initialize attributes with accessors of the same name.
Classes may provide their own new method to override this default.
method bless(Mu $candidate, *%attrinit) returns Mu:D
Lower-level object construction method than new.
If you pass a Whatever as a candidate, it creates a new object of the same type as the invocant, and then uses the named arguments to initialize attributes.
If you pass something other than a Whatever object as a candidate, it simply does the attribute initialization on the $candidate.
In both cases, the object with the attributes initialized is returned.
You can use this method when writing custom constructors:
class Point {
has $.x;
has $.y;
multi method new($x, $y) {
self.bless(:$x, :$y);
}
}
my $p = Point.new(-1, 1);
(Though each time you write a custom constructor, remember that it makes subclassing harder).
method CREATE() returns Mu:D
Allocates a new object of the same type as the invocant, without initializating any attributes.
multi method print() returns Bool:D
Prints value to $*OUT after stringification using .Str method without newline at end.
multi method say() returns Bool:D
Prints value to $*OUT after stringification using .gist method with newline at end.
multi method ACCEPTS(Mu:U: $other)
Performs a type check. Returns True if $other conforms to the invocant (which is always a type object or failure).
This is the method that is triggered on smart-matching against type objects, for example in if $var ~~ Int { ... }.
multi method WHICH() returns ObjAt:D
Returns an object of type ObjAt which uniquely identifies the object. Value types override this method which makes sure that two equivalent objects return the same return value from WHICH.