NAME

peri-eg-binary-files - Accept and send binary data

VERSION

This document describes version 0.081 of peri-eg-binary-files (from Perl distribution Perinci-Examples-Bin-Classic), released on 2021-01-30.

SYNOPSIS

Usage:

 % peri-eg-binary-files [--config-path=path+] [--config-profile=profile]
     [--data-base64=s] [--data=s] [--format-options=s] [--format=name]
     [--json] [--(no)naked-res] [--no-config] [--no-env]

DESCRIPTION

This function sets its argument's schema type as buf which indicates the argument accepts binary data. Likewise it also sets its result's schema type as buf which says that function will return binary data.

The function just returns its argument.

Note that since the metadata also contains null ("\0") in the default property of the argument specification, the metadata is also not JSON-safe.

To pass binary data over JSON/Riap, you can use Riap version 1.2 and encode the argument with ":base64" suffix, e.g.:

 $res = Perinci::Access->new->request(
     call => "http://example.com/api/Perinci/Examples/binary",
     {v=>1.2, args=>{"data:base64"=>"/wA="}}); # send "\xff\0"

Without v=>1.2, encoded argument won't be decoded by the server.

To pass binary data on the command-line, you can use --ARG-base64 if the command-line library provides it.

To receive binary result over JSON/Riap, you can use Riap version 1.2 which will automatically encode binary data with base64 so it is safe when transformed as JSON. The client library will also decode the encoded result back to the original, so the whole process is transparent to you:

 $res = Perinci::Access->new->request(
     call => "http://example.com/api/Perinci/Examples/binary",
     {v=>1.2}); # => [200,"OK","\0\0\0",{}]

OPTIONS

* marks required options.

Main options

--data-base64=s

See --data.

--data=s

Default value:

 "\0\0\0"

Configuration options

--config-path=s

Set path to configuration file.

Can be specified multiple times.

--config-profile=s

Set configuration profile to use.

--no-config

Do not use any configuration file.

Environment options

--no-env

Do not read environment for default options.

Output options

--format-options=s

Pass options to formatter.

--format=s

Choose output format, e.g. json, text.

Default value:

 undef

--json

Equivalent to --format=json-pretty.

--naked-res

When outputing as JSON, strip result envelope.

Default value:

 0

By default, when outputing as JSON, the full enveloped result is returned, e.g.:

    [200,"OK",[1,2,3],{"func.extra"=>4}]

The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use `--naked-res` so you just get:

    [1,2,3]

Other options

--help, -h, -?

Display help message and exit.

--version, -v

Display program's version and exit.

COMPLETION

This script has shell tab completion capability with support for several shells.

bash

To activate bash completion for this script, put:

 complete -C peri-eg-binary-files peri-eg-binary-files

in your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is recommended, however, that you install modules using cpanm-shcompgen which can activate shell completion for scripts immediately.

tcsh

To activate tcsh completion for this script, put:

 complete peri-eg-binary-files 'p/*/`peri-eg-binary-files`/'

in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is also recommended to install shcompgen (see above).

other shells

For fish and zsh, install shcompgen as described above.

CONFIGURATION FILE

This script can read configuration files. Configuration files are in the format of IOD, which is basically INI with some extra features.

By default, these names are searched for configuration filenames (can be changed using --config-path): /home/s1/.config/peri-eg-binary-files.conf, /home/s1/peri-eg-binary-files.conf, or /etc/peri-eg-binary-files.conf.

All found files will be read and merged.

To disable searching for configuration files, pass --no-config.

You can put multiple profiles in a single file by using section names like [profile=SOMENAME] or [SOMESECTION profile=SOMENAME]. Those sections will only be read if you specify the matching --config-profile SOMENAME.

You can also put configuration for multiple programs inside a single file, and use filter program=NAME in section names, e.g. [program=NAME ...] or [SOMESECTION program=NAME]. The section will then only be used when the reading program matches.

Finally, you can filter a section by environment variable using the filter env=CONDITION in section names. For example if you only want a section to be read if a certain environment variable is true: [env=SOMEVAR ...] or [SOMESECTION env=SOMEVAR ...]. If you only want a section to be read when the value of an environment variable has value equals something: [env=HOSTNAME=blink ...] or [SOMESECTION env=HOSTNAME=blink ...]. If you only want a section to be read when the value of an environment variable does not equal something: [env=HOSTNAME!=blink ...] or [SOMESECTION env=HOSTNAME!=blink ...]. If you only want a section to be read when an environment variable contains something: [env=HOSTNAME*=server ...] or [SOMESECTION env=HOSTNAME*=server ...]. Note that currently due to simplistic parsing, there must not be any whitespace in the value being compared because it marks the beginning of a new section filter or section name.

List of available configuration parameters:

 data (see --data)
 format (see --format)
 format_options (see --format-options)
 naked_res (see --naked-res)

ENVIRONMENT

PERI_EG_BINARY_FILES_OPT => str

Specify additional command-line options.

FILES

/home/s1/.config/peri-eg-binary-files.conf

/home/s1/peri-eg-binary-files.conf

/etc/peri-eg-binary-files.conf

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Perinci-Examples-Bin-Classic.

SOURCE

Source repository is at https://github.com/perlancar/perl-Perinci-Examples-Bin.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Perinci-Examples-Bin-Classic

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.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2021, 2020, 2015, 2014, 2013, 2012 by perlancar@cpan.org.

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

cpanm Perinci::Examples::Bin::Classic

perl -MCPAN -e shell
install Perinci::Examples::Bin::Classic