ceph/src/common/mime.h
Colin Patrick McCabe 1bfe9b869e mime.h: better comments
Signed-off-by: Colin McCabe <colin.mccabe@dreamhost.com>
2011-07-11 15:11:24 -07:00

57 lines
1.7 KiB
C

// -*- mode:C++; tab-width:8; c-basic-offset:2; indent-tabs-mode:t -*-
// vim: ts=8 sw=2 smarttab
/*
* Ceph - scalable distributed file system
*
* Copyright (C) 2011 New Dream Network
*
* This is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software
* Foundation. See file COPYING.
*
*/
#ifndef CEPH_COMMON_MIME_H
#define CEPH_COMMON_MIME_H
#ifdef __cplusplus
extern "C" {
#endif
/* Encode a buffer as quoted-printable.
*
* The input is a null-terminated string.
* The output is a null-terminated string representing the input encoded as
* a MIME quoted-printable.
*
* Returns the length of the buffer we would need to do the encoding.
* If we don't have enough buffer space, the output will be truncated.
*
* You may call mime_encode_as_qp(input, NULL, 0) to find the size of the
* buffer you will need.
*/
signed int mime_encode_as_qp(const char *input, char *output, int outlen);
/* Decode a quoted-printable buffer.
*
* The input is a null-terminated string encoded as a MIME quoted-printable.
* The output is a null-terminated string representing the input decoded.
*
* Returns a negative error code if the input is not a valid quoted-printable
* buffer.
* Returns the length of the buffer we would need to do the encoding.
* If we don't have enough buffer space, the output will be truncated.
*
* You may call mime_decode_as_qp(input, NULL, 0) to find the size of the
* buffer you will need. The output will never be longer than the input for
* this function.
*/
signed int mime_decode_from_qp(const char *input, char *output, int outlen);
#ifdef __cplusplus
}
#endif
#endif