File: base32_encode.Rd

package info (click to toggle)
r-cran-base64url 1.4-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, sid, trixie
  • size: 168 kB
  • sloc: ansic: 403; sh: 13; makefile: 2
file content (37 lines) | stat: -rw-r--r-- 1,123 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/base32.R
\name{base32_encode}
\alias{base32_encode}
\alias{base32_decode}
\title{Encode to base32 or Decode from base32}
\usage{
base32_encode(x, use.padding = FALSE)

base32_decode(x, use.padding = FALSE)
}
\arguments{
\item{x}{[\code{character(1)}]\cr
Character vector to encode or decode.}

\item{use.padding}{[\code{logical(1)}]\cr
If \code{TRUE}, \code{base32_encode} returns a string whose length is a multiple of 8,
padded with trailing \dQuote{=} if required.
\code{base32_decode} expects such a string unless this is set to \code{FALSE} (default).
The internal algorithm currently works with padding, thus it is faster to set this to \code{TRUE}.}
}
\value{
[\code{character}] of the same length as input \code{x}.
}
\description{
Simple RFC4648 base32 encoder/decoder. Pads with \dQuote{=}.
}
\examples{
x = "plain text"
encoded = base32_encode(x)
decoded = base32_decode(encoded)
print(encoded)
print(decoded)
}
\references{
Implementation based on base32 encoder/decoder in the GNU lib: \url{https://www.gnu.org/software/gnulib/}.
}