The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Stencil::Error

ABSTRACT

Represents a Stencil exception

SYNOPSIS

use Stencil::Data;
use Stencil::Error;
use Stencil::Repo;
use Stencil::Space;

my $repo = Stencil::Repo->new;
my $error = Stencil::Error->new;
my $data = Stencil::Data->new(repo => $repo, name => 'foo');
my $space = Stencil::Space->new(repo => $repo, name => 'test');

DESCRIPTION

This package provides an error class which represents a Stencil exception.

INHERITS

This package inherits behaviors from:

Data::Object::Exception

LIBRARIES

This package uses type constraints from:

Types::Standard

FUNCTIONS

This package implements the following functions:

on_source_data

on_source_data(Str $class, Object $self, Object $match) : Object

The on_source_data method returns an exception object for sources without __DATA__ sections.

on_source_data example #1
# given: synopsis

my $result = Stencil::Error->on_source_data($space, $space->locate);

# $result->id
# $result->message
# $result->context

on_source_load

on_source_load(Str $class, Object $self, Object $match) : Object

The on_source_load method returns an exception object for unloadable sources.

on_source_load example #1
# given: synopsis

my $result = Stencil::Error->on_source_load($space, $space->locate);

# $result->id
# $result->message
# $result->context

on_source_section

on_source_section(Str $class, Object $self, Object $match, Str $ref) : Object

The on_source_section method returns an exception object for sources without a requested template.

on_source_section example #1
# given: synopsis

my $result = Stencil::Error->on_source_section($space, $space->locate, 'setup');

# $result->id
# $result->message
# $result->context

on_source_test

on_source_test(Str $class, Object $self, Object $match) : Object

The on_source_test method returns an exception object for sources with broken interfaces.

on_source_test example #1
# given: synopsis

my $result = Stencil::Error->on_source_test($space, $space->locate);

# $result->id
# $result->message
# $result->context

on_space_locate

on_space_locate(Str $class, Object $self) : Object

The on_space_locate method returns an exception object for unlocatable spaces.

on_space_locate example #1
# given: synopsis

my $result = Stencil::Error->on_space_locate($space);

# $result->id
# $result->message
# $result->context

AUTHOR

Al Newkirk, awncorp@cpan.org

LICENSE

Copyright (C) 2011-2019, Al Newkirk, et al.

This is free software; you can redistribute it and/or modify it under the terms of the The Apache License, Version 2.0, as elucidated in the "license file".

PROJECT

Wiki

Project

Initiatives

Milestones

Contributing

Issues