3 * ====================================================================
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
12 * http://www.apache.org/licenses/LICENSE-2.0
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
20 * ====================================================================
24 * @brief Base64 encoding and decoding functions
30 #include <apr_pools.h>
32 #include "svn_types.h"
33 #include "svn_io.h" /* for svn_stream_t */
34 #include "svn_string.h"
38 #endif /* __cplusplus */
43 * @defgroup base64 Base64 encoding/decoding functions
48 /** Return a writable generic stream which will encode binary data in
49 * base64 format and write the encoded data to @a output. If @a break_lines
50 * is true, newlines will be inserted periodically; otherwise the output
51 * stream will only consist of base64 encoding characters. Be sure to close
52 * the stream when done writing in order to squeeze out the last bit of
53 * encoded data. The stream is allocated in @a pool.
58 svn_base64_encode2(svn_stream_t *output,
59 svn_boolean_t break_lines,
63 * Same as svn_base64_encode2, but with @a break_lines always TRUE.
65 * @deprecated Provided for backward compatibility with the 1.9 API.
69 svn_base64_encode(svn_stream_t *output,
72 /** Return a writable generic stream which will decode base64-encoded
73 * data and write the decoded data to @a output. The stream is allocated
77 svn_base64_decode(svn_stream_t *output,
81 /** Encode an @c svn_stringbuf_t into base64.
83 * A simple interface for encoding base64 data assuming we have all of
84 * it present at once. If @a break_lines is true, newlines will be
85 * inserted periodically; otherwise the string will only consist of
86 * base64 encoding characters. The returned string will be allocated
92 svn_base64_encode_string2(const svn_string_t *str,
93 svn_boolean_t break_lines,
97 * Same as svn_base64_encode_string2, but with @a break_lines always
100 * @deprecated Provided for backward compatibility with the 1.5 API.
104 svn_base64_encode_string(const svn_string_t *str,
107 /** Decode an @c svn_stringbuf_t from base64.
109 * A simple interface for decoding base64 data assuming we have all of
110 * it present at once. The returned string will be allocated from @c
115 svn_base64_decode_string(const svn_string_t *str,
119 /** Return a base64-encoded checksum for finalized @a digest.
121 * @a digest contains @c APR_MD5_DIGESTSIZE bytes of finalized data.
122 * Allocate the returned checksum in @a pool.
124 * @deprecated Provided for backward compatibility with the 1.5 API.
128 svn_base64_from_md5(unsigned char digest[],
132 /** @} end group: Base64 encoding/decoding functions */
136 #endif /* __cplusplus */
138 #endif /* SVN_BASE64_H */