]> gitweb.factorcode.org Git - factor.git/blob - basis/base64/base64-docs.factor
Merge branch 'master' of git://factorcode.org/git/factor
[factor.git] / basis / base64 / base64-docs.factor
1 USING: help.markup help.syntax kernel math ;
2 IN: base64
3
4 HELP: >base64
5 { $values { "seq" "a sequence" } { "base64" "a string of base64 characters" } }
6 { $description "Converts a sequence to its base64 representation by taking six bits at a time as an index into a lookup table containing alphanumerics, '+', and '/'.  The result is padded with '=' if the input was not a multiple of six bits." }
7 { $examples
8     { $unchecked-example "\"The monorail is a free service.\" >base64 ." "VGhlIG1vbm9yYWlsIGlzIGEgZnJlZSBzZXJ2aWNlLg==" }
9 }
10 { $see-also base64> } ;
11
12 HELP: base64>
13 { $values { "base64" "a string of base64 characters" } { "str" "a string" } }
14 { $description "Converts a string in base64 encoding back into its binary representation." }
15 { $examples
16     { $unchecked-example "\"VGhlIG1vbm9yYWlsIGlzIGEgZnJlZSBzZXJ2aWNlLg==\" base64> ." "\"The monorail is a free service.\"" }
17 }
18 { $notes "This word will throw if the input string contains characters other than those allowed in base64 encodings." }
19 { $see-also >base64 } ;
20