API for clojure.data.codec.base64 - data.codec 0.1.2-SNAPSHOT (in development)

by Alex Taggart

Full namespace name: clojure.data.codec.base64

Overview

Functions for working with base64 encodings.

Public Variables and Functions



dec-length

function
Usage: (dec-length in-length pad-length)
Calculates what would be the length after decoding of an input array of length
in-length with the specified padding length.

    
    
    Source
  


decode

function
Usage: (decode input)
       (decode input offset length)
Returns a base64 decoded byte array.

Note: length must be a multiple of 4.

    
    
    Source
  


decode!

function
Usage: (decode! input offset length output)
Reads from the input byte array for the specified length starting at the offset
index, and base64 decodes into the output array starting at index 0. Returns the
length written to output.

Note: length must be a multiple of 4.

    
    
    Source
  


decoding-transfer

function
Usage: (decoding-transfer input-stream output-stream & opts)
Base64 decodes from input-stream to output-stream. Returns nil or throws IOException.

Options are key/value pairs and may be one of
  :buffer-size  read buffer size to use, must be a multiple of 4; default is 8192.

    
    
    Source
  


enc-length

function
Usage: (enc-length n)
Calculates what would be the length after encoding of an input array of length n.

    
    
    Source
  


encode

function
Usage: (encode input)
       (encode input offset length)
Returns a base64 encoded byte array.

    
    
    Source
  


encode!

function
Usage: (encode! input offset length output)
Reads from the input byte array for the specified length starting at the offset
index, and base64 encodes into the output array starting at index 0. Returns the
length written to output.

Note: if using partial input, length must be a multiple of 3 to avoid padding.

    
    
    Source
  


encoding-transfer

function
Usage: (encoding-transfer input-stream output-stream & opts)
Base64 encodes from input-stream to output-stream. Returns nil or throws IOException.

Options are key/value pairs and may be one of
  :buffer-size  read buffer size to use, must be a multiple of 3; default is 6144.

    
    
    Source
  


pad-length

function
Usage: (pad-length input offset length)
Returns the length of padding on the end of the input array.

    
    
    Source
  
Logo & site design by Tom Hickey.
Clojure auto-documentation system by Tom Faulhaber.