内容

名称

Test2::Event::Generic - 通用事件类型。

描述

这是一个通用事件,允许您自定义事件 API 中的所有字段。如果您需要一个自定义事件,而该事件不适合作为已发布的可重用事件子类,则此方法很有用。

概要

use Test2::API qw/context/;

sub send_custom_fail {
    my $ctx = shift;

    $ctx->send_event('Generic', causes_fail => 1, summary => 'The sky is falling');

    $ctx->release;
}

send_custom_fail();

方法

$e->facet_data($data)
$data = $e->facet_data

获取或设置方面数据(参见 Test2::Event)。如果未设置方面数据,则将调用 Test2::Event->facet_data 以从其他数据生成方面。

$e->callback($hub)

如果设置了自定义回调,则调用它,否则不执行任何操作。

$e->set_callback(sub { ... })

设置自定义回调。自定义回调必须是代码引用。回调的第一个参数将是事件本身,第二个参数将是使用回调的 Test2::Event::Hub

$bool = $e->causes_fail
$e->set_causes_fail($bool)

获取/设置 causes_fail 属性。默认值为 0

$bool = $e->diagnostics
$e->set_diagnostics($bool)

获取/设置 diagnostics 属性。默认值为 0

$bool_or_undef = $e->global
@bool_or_empty = $e->global
$e->set_global($bool_or_undef)

获取/设置 diagnostics 属性。默认值为一个空列表,在标量上下文中为 undef。

$bool = $e->increments_count
$e->set_increments_count($bool)

获取/设置 increments_count 属性。默认值为 0

$bool = $e->no_display
$e->set_no_display($bool)

获取/设置 no_display 属性。默认值为 0

@plan = $e->sets_plan

如果此事件设置了计划,则获取计划。计划是一个最多包含 3 个项目的列表:($count, $directive, $reason)$count 必须定义,其他项可以是 undef,或者根本不存在。

$e->set_sets_plan(\@plan)

设置计划。您必须传入一个最多包含 3 个元素的数组引用。

$summary = $e->summary
$e->set_summary($summary_or_undef)

获取/设置摘要。这将默认为事件包 'Test2::Event::Generic'。您可以将其设置为任何值。将其设置为 undef 将将其重置为默认值。

$int_or_undef = $e->terminate
@int_or_empty = $e->terminate
$e->set_terminate($int_or_undef)

这将获取/设置 terminate 属性。这在标量上下文中默认为 undef,或在列表上下文中默认为空列表。将其设置为 undef 将完全清除它。这必须设置为正整数(0 或更大)。

SOURCE

Test2 的源代码库可以在 http://github.com/Test-More/test-more/ 找到。

MAINTAINERS

Chad Granum <[email protected]>

AUTHORS

Chad Granum <[email protected]>

COPYRIGHT

Copyright 2020 Chad Granum <[email protected]>.

本程序是自由软件;您可以根据与 Perl 本身相同的条款重新发布和/或修改它。

参见 https://dev.perl5.cn/licenses/