Type::P...ignature(3)

📦
version 2.010001 · 6 versions
, in alpine 3.24

💅 Type::Params::Signature(3) — bestie edition

ok so this is a page from the User Contributed Perl Documentation, and the module is Type::Params::Signature. sit down, grab a strawberry drink 🍓, and let's get into it.

✨ NAME ✨

Type::Params::Signature — the internal representation of a function signature. like, it's the vibe of your function's arguments, encoded as an object. main character energy fr.

🚦 STATUS 🚦

Real talk: this module is not covered by the Type-Tiny stability policy. so like... it could change on you. no cap. 🙈

🦋 DESCRIPTION 🦋

Okay so mostly this is internal code — like, backstage crew, not the performer — but plot twist, you can use it to get basic introspection for signatures. it's giving "peek behind the curtain." 👑

🎀 Constructors

  • new(%attributes) — the normal one, takes a hash of attributes.
  • new_from_compile($style, %attributes) — takes a $style plus the attributes.
  • new_from_v2api(\%attributes) — takes a hashref of attributes. very old-school, very demure.

💖 Attributes

heads up bestie: all attributes are read-only. you look, you don't touch. 👀

  • package — ClassName. the package we're providing a signature for. it gets used to look up any stringy type names. iykyk.
  • subname — Str. the sub we're providing a signature for.
  • description — Str. a lil description, as a treat.
  • method — ArrayRef[InstanceOf['Type::Params::Parameter']].
  • head — ArrayRef[InstanceOf['Type::Params::Parameter']].
  • tail — ArrayRef[InstanceOf['Type::Params::Parameter']].
  • parameters — ArrayRef[InstanceOf['Type::Params::Parameter']].
  • slurpy — InstanceOf['Type::Params::Parameter'].
  • on_die — CodeRef.
  • strictness — Bool|ScalarRef.
  • next — CodeRef.
  • goto_next — CodeRef. literally just an alias for next. that's it. slay.
  • can_shortcut — Bool. tells you whether the signature has no potential to alter @_, which means it can be returned without being copied if the type checks pass. generally speaking, do not pass this to the constructor — just let Type::Params::Signature figure it out. it's got this. 🫶
  • coderef — InstanceOf['Eval::TypeTiny::CodeAccumulator']. you probably don't want to provide this to the constructor either. the whole point of this module is to build it for you! that's the job. 💅
  • is_named — Bool.
  • allow_dash — Bool.
  • bless — Bool|ClassName.
  • class — ClassName.
  • constructor — Str.
  • class_attributes — HashRef. this is a HashRef suitable for passing to the import method of Class::XSAccessor. a default gets generated based on parameters.
  • named_to_list — ArrayRef. this one can be coerced from a bool based on parameters.
  • list_to_named — Bool.
  • oo_trace — Bool. defaults to true. indicates whether blessed $arg hashrefs created by the signature will include a '~~caller' key.

🧚 Bare attributes

these attributes may be passed to the constructors and may do something, but no methods are provided to access the values later. so like... they're there. ghosting you, respectfully. 💀

  • positional or pos — ArrayRef.
  • named — ArrayRef.
  • multiple or multi — ArrayRef.
  • returns — Bool. shortcut for setting returns_scalar and returns_list simultaneously. two for one, we love efficiency.
  • want_source — Bool.
  • want_details — Bool.
  • want_object — Bool.
  • rationalize_slurpies — Bool. yes that's the real name. no i will not be commenting further.

🔥 Methods

⭐ Predicates

predicate methods return true/false to indicate the presence or absence of attributes. very "are they or aren't they" energy.

  • has_description
  • has_head
  • has_tail
  • has_parameters
  • has_slurpy
  • has_on_die
  • has_strictness
  • has_returns_scalar
  • has_returns_list

👑 Class making methods

these get called automatically during object construction and you should not typically call them yourself. they're public methods in case you wanna subclass Type::Params::Signature — which, honestly, go off. 🌈

  • make_class_pp — builds the class specified in bless by evaluating Perl code.
  • make_class_xs — builds the class specified in bless using Class::XSAccessor.
  • make_class — calls either make_class_pp or make_class_xs. it picks. it's ✨decisive✨.
  • make_class_pp_code — generates the code for make_class_pp.

🎀 Other methods

  • BUILD — called by the constructors. you should not call this. like seriously bestie, hands off 🙅‍♀️.
  • return_wanted — normally returns the signature coderef, unless want_source, want_details, or want_object were provided to the constructor. in that case it returns the source code for the coderef, a hashref of details, or $self respectively. it's versatile! it contains multitudes! 💜

🌍 ENVIRONMENT 🌍

  • PERL_TYPE_PARAMS_XS — affects the building of accessors for $arg objects. if set to true, it will use Class::XSAccessor. if set to false, it will use pure Perl. if this environment variable does not exist, it will use Class::XSAccessor.
also important: if Class::XSAccessor is not installed or is too old, pure Perl will always be used as a fallback. safety net, iconic behavior.

🐛 BUGS 🐛

please report any bugs to <https://github.com/tobyink/p5-type-tiny/issues>. be nice about it, the maintainer is doing great. 🫶

👀 SEE ALSO 👀

Type::Params, Type::Params::Parameter, Type::Params::Alternatives. the whole friend group, honestly.

✍️ AUTHOR ✍️

Toby Inkster <tobyink@cpan.org>. legend behavior.

this software is copyright (c) 2023-2025 by Toby Inkster.

this is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. periodt. 💅

⚠️ DISCLAIMER OF WARRANTIES ⚠️

THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.

like, no promises. no refunds. she said what she said. 😭

and that's the whole page bestie!! this was rendered by perl v5.42.2 and dated 2026-04-07 — mwah, go touch grass, ily 💖✨🦋

📦 where this page comes from