Sah::Schema::hexbuf - Binary data encoded in hexdigits, e.g. "fafafa" or "ca fe 00"


This document describes version 0.008 of Sah::Schema::hexbuf (from Perl distribution Sah-Schemas-Binary), released on 2022-10-20.


Sample data and validation results against this schema

 ""  # valid

 "f"  # INVALID (Odd number of digits)

 "fafafa"  # valid

 "FAFAFA"  # valid (Uppercase digits are allowed, not coerced to lowercase)

 "fa fa  fa"  # valid (Whitespaces allowed, will be removed), becomes "fafafa"

 "fafafg"  # INVALID

Using with Data::Sah

To check data against this schema (requires Data::Sah):

 use Data::Sah qw(gen_validator);
 my $validator = gen_validator("hexbuf*");
 say $validator->($data) ? "valid" : "INVALID!";

The above schema returns a boolean result (true if data is valid, false if otherwise). To return an error message string instead (empty string if data is valid, a non-empty error message otherwise):

 my $validator = gen_validator("hexbuf", {return_type=>'str_errmsg'});
 my $errmsg = $validator->($data);
 # a sample valid data
 $data = "FAFAFA";
 my $errmsg = $validator->($data); # => ""
 # a sample invalid data
 $data = "fafafg";
 my $errmsg = $validator->($data); # => "Must match regex pattern qr(\\A([0-9A-fa-f][0-9A-fa-f])*\\z)"

Often a schema has coercion rule or default value, so after validation the validated value is different. To return the validated (set-as-default, coerced, prefiltered) value:

 my $validator = gen_validator("hexbuf", {return_type=>'str_errmsg+val'});
 my $res = $validator->($data); # [$errmsg, $validated_val]
 # a sample valid data
 $data = "FAFAFA";
 my $res = $validator->($data); # => ["","FAFAFA"]
 # a sample invalid data
 $data = "fafafg";
 my $res = $validator->($data); # => ["Must match regex pattern qr(\\A([0-9A-fa-f][0-9A-fa-f])*\\z)","fafafg"]

Data::Sah can also create validator that returns a hash of detailed error message. Data::Sah can even create validator that targets other language, like JavaScript, from the same schema. Other things Data::Sah can do: show source code for validator, generate a validator code with debug comments and/or log statements, generate human text from schema. See its documentation for more details.

Using with Params::Sah

To validate function parameters against this schema (requires Params::Sah):

 use Params::Sah qw(gen_validator);

 sub myfunc {
     my @args = @_;
     state $validator = gen_validator("hexbuf*");

Using with Perinci::CmdLine::Lite

To specify schema in Rinci function metadata and use the metadata with Perinci::CmdLine (Perinci::CmdLine::Lite) to create a CLI:

 # in lib/
 our %SPEC;
 $SPEC{myfunc} = {
     v => 1.1,
     summary => 'Routine to do blah ...',
     args => {
         arg1 => {
             summary => 'The blah blah argument',
             schema => ['hexbuf*'],
 sub myfunc {
     my %args = @_;

 # in
 use Perinci::CmdLine::Any;

 # in command-line
 % ./ --help
 myapp - Routine to do blah ...

 % ./ --version

 % ./ --arg1 ...

Using with Type::Tiny

To create a type constraint and type library from a schema:

 package My::Types {
     use Type::Library -base;
     use Type::FromSah qw( sah2type );

         sah2type('$sch_name*', name=>'Hexbuf')

 use My::Types qw(Hexbuf);


Whitespaces are allowed and will be removed.

Note: that this schema does not decode the hex encoding for you.

Note: if you add clauses like leng, min_len, max_len


Please visit the project's homepage at


Source repository is at


Types::XSD - Equivalent Type::Tiny constraints: HexBinary (doesn't allow whitespace; length, minLength, maxLength params checks the /decoded/ length)


perlancar <>


To contribute, you can send patches by email/via RT, or send pull requests on GitHub.

Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:

 % prove -l

If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.


This software is copyright (c) 2022, 2020, 2018 by perlancar <>.

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


Please report any bugs or feature requests on the bugtracker website

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.