~rdoering/ubuntu/karmic/erlang/fix-535090

« back to all changes in this revision

Viewing changes to lib/stdlib/doc/src/base64.xml

• browse files at revision 17
• compare with another revision
• download diff
• download tarball
• view history from revision 17

Show diffs side-by-side

added

removed

lib/stdlib/doc/src/base64.xml

 

1

<?xml version="1.0" encoding="latin1" ?>

 

2

<!DOCTYPE erlref SYSTEM "erlref.dtd">

 

3

 

 

4

<erlref>

 

5

  <header>

 

6

    <copyright>

 

7

      <year>2007</year>

 

8

      <year>2007</year>

 

9

      <holder>Ericsson AB, All Rights Reserved</holder>

 

10

    </copyright>

 

11

    <legalnotice>

 

12

  The contents of this file are subject to the Erlang Public License,

 

13

  Version 1.1, (the "License"); you may not use this file except in

 

14

  compliance with the License. You should have received a copy of the

 

15

  Erlang Public License along with this software. If not, it can be

 

16

  retrieved online at http://www.erlang.org/.

 

17

 

 

18

  Software distributed under the License is distributed on an "AS IS"

 

19

  basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See

 

20

  the License for the specific language governing rights and limitations

 

21

  under the License.

 

22

 

 

23

  The Initial Developer of the Original Code is Ericsson AB.

 

24

    </legalnotice>

 

25

 

 

26

    <title>base64</title>

 

27

    <prepared>Ingela Anderton Andin</prepared>

 

28

    <docno></docno>

 

29

    <date>2007-02-22</date>

 

30

    <rev></rev>

 

31

    <file>base64.sgml</file>

 

32

  </header>

 

33

  <module>base64</module>

 

34

  <modulesummary>Implements base 64 encode and decode, see RFC2045.</modulesummary>

 

35

  <description>

 

36

    <p>Implements base 64 encode and decode, see RFC2045. </p>

 

37

  </description>

 

38

  <funcs>

 

39

    <func>

 

40

      <name>encode(Data) -> Base64 </name>

 

41

      <name>encode_to_string(Data) -> Base64String</name>

 

42

      <fsummary>Encodes data into base64. </fsummary>

 

43

      <type>

 

44

        <v>Data = string() | binary()</v>

 

45

        <v>Base64 = binary()</v>

 

46

        <v>Base64String = string()</v>

 

47

      </type>

 

48

      <desc>

 

49

        <p>Encodes a plain ASCII string into base64. The result will

 

50

          be 33% larger than the data.</p>

 

51

      </desc>

 

52

    </func>

 

53

    <func>

 

54

      <name>decode(Base64) -> Data</name>

 

55

      <name>decode_to_string(Base64) -> DataString</name>

 

56

      <name>mime_decode(Base64) -> Data</name>

 

57

      <name>mime_decode_to_string(Base64) -> DataString</name>

 

58

      <fsummary>Decodes a base64 encoded string to data. </fsummary>

 

59

      <type>

 

60

        <v>Base64 = string() | binary()</v>

 

61

        <v>Data = binary()</v>

 

62

        <v>DataString = string()</v>

 

63

      </type>

 

64

      <desc>

 

65

        <p>Decodes a base64 encoded string to plain ASCII. The string

 

66

          should only consist of characters in the base64 set, see RFC4648.

 

67

          <c>mime_decode/1</c> and <c>mime_decode_to_string/1</c>

 

68

          strips away illegal characters, while <c>decode/1</c> and

 

69

          <c>decode_to_string/1</c> fails if an illegal charactrer is found.</p>

 

70

      </desc>

 

71

    </func>

 

72

  </funcs>

 

73

</erlref>

 

74

 

• Older »

Loggerhead is a web-based interface for Breezy
Version: 2.0.1