method Capture

Table of Contents
1	class Int
1.1	(Int) method Capture
2	class RatStr
2.1	(RatStr) method Capture
3	class Mu
3.1	(Mu) method Capture
4	class Channel
4.1	(Channel) method Capture
5	class ComplexStr
5.1	(ComplexStr) method Capture
6	class Num
6.1	(Num) method Capture
7	class Range
7.1	(Range) method Capture
8	class Version
8.1	(Version) method Capture
9	class Supply
9.1	(Supply) method Capture
10	class Map
10.1	(Map) method Capture
11	class Capture
11.1	(Capture) method Capture
12	class Failure
12.1	(Failure) method Capture
13	class Str
13.1	(Str) method Capture
14	role Callable
14.1	(Callable) method Capture
15	class Signature
15.1	(Signature) method Capture
16	class Whatever
16.1	(Whatever) method Capture
17	class List
17.1	(List) method Capture
18	role Blob
18.1	(Blob) method Capture

Documentation for method Capture assembled from the following types:

class Int

From Int

class RatStr

From RatStr

class Mu

From Mu

(Mu) method Capture

Declared as:

method Capture(Mu:D: --> Capture:D)

Returns a Capture with named arguments corresponding to invocant's public attributes:

class Foo {
    has $.foo = 42;
    has $.bar = 70;
    method bar { 'something else' }
}.new.Capture.say; # OUTPUT: «\(:bar("something else"), :foo(42))␤»

class Channel

From Channel

(Channel) method Capture

Defined as:

method Capture(Channel:D --> Capture:D)

Equivalent to calling .List.Capture on the invocant.

class ComplexStr

From ComplexStr

class Num

From Num

class Range

From Range

(Range) method Capture

Defined as:

method Capture(Range --> Capture:D)

Returns a Capture with values of .min .max, .excludes-min, .excludes-max, .infinite, and .is-int as named arguments.

class Version

From Version

class Supply

From Supply

(Supply) method Capture

Defined as:

method Capture(Supply:D --> Capture:D)

Equivalent to calling .List.Capture on the invocant.

class Map

From Map

(Map) method Capture

Defined as:

method Capture(Map:D:)

Returns a Capture where each key, if any, has been converted to a named argument with the same value as it had in the original Map. The returned Capture will not contain any positional arguments.

my $map = Map.new('a' => 2, 'b' => 17);
my $capture = $map.Capture;
my-sub(|$capture);                                # RESULT: «2, 17» 
 
sub my-sub(:$a, :$b) {
    say "$a, $b"
}

class Capture

From Capture

(Capture) method Capture

Defined as:

method Capture(Capture:D: --> Capture:D)

Returns itself, i.e. the invocant.

say \(1,2,3, apples => 2).Capture; # OUTPUT: «\(1, 2, 3, :apples(2))␤»

class Failure

From Failure

(Failure) method Capture

Defined as:

method Capture()

Throws X::Cannot::Capture if the invocant is a type object or a handled Failure. Otherwise, throws the invocant's exception.

class Str

From Str

role Callable

From Callable

class Signature

From Signature

class Whatever

From Whatever

class List

From List

(List) method Capture

Defined as:

method Capture(--> Capture:D)

Returns a Capture where each Pair, if any, in the List has been converted to a named argument (with the key of the Pair stringified). All other elements in the List are converted to positional arguments in the order they are found, i.e. the first non pair item in the list becomes the first positional argument, which gets index 0, the second non pair item becomes the second positional argument, getting index 1 etc.

my $list = (7, 5, a => 2, b => 17);
my $capture = $list.Capture;
say $capture.keys;                                # OUTPUT: «(0 1 a b)␤» 
my-sub(|$capture);                                # RESULT: «7, 5, 2, 17» 
 
sub my-sub($first, $second, :$a, :$b) {
    say "$first, $second, $a, $b"
}

A more advanced example demonstrating the returned Capture being matched against a Signature.

my $list = (7, 5, a => 2, b => 17);
say so $list.Capture ~~ :($ where * == 7,$,:$a,:$b); # OUTPUT: «True␤» 
 
$list = (8, 5, a => 2, b => 17);
say so $list.Capture ~~ :($ where * == 7,$,:$a,:$b); # OUTPUT: «False␤»

role Blob

From Blob

(Blob) method Capture

Defined as:

method Capture(Blob:D)

Equivalent to calling .List.Capture on the invocant.