1 #Region "Microsoft.VisualBasic::c7deacbacbe45ff501aee967090fc664, Microsoft.VisualBasic.Core\Text\IO\EncodingHelper.vb"
2
3     ' Author:
4     
5     '       asuka (amethyst.asuka@gcmodeller.org)
6     '       xie (genetics@smrucc.org)
7     '       xieguigang (xie.guigang@live.com)
8     
9     ' Copyright (c) 2018 GPL3 Licensed
10     
11     
12     ' GNU GENERAL PUBLIC LICENSE (GPL3)
13     
14     
15     ' This program is free software: you can redistribute it and/or modify
16     ' it under the terms of the GNU General Public License as published by
17     ' the Free Software Foundation, either version 3 of the License, or
18     ' (at your option) any later version.
19     
20     ' This program is distributed in the hope that it will be useful,
21     ' but WITHOUT ANY WARRANTY; without even the implied warranty of
22     ' MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
23     ' GNU General Public License for more details.
24     
25     ' You should have received a copy of the GNU General Public License
26     ' along with this program. If not, see <http://www.gnu.org/licenses/>.
27
28
29
30     ' /********************************************************************************/
31
32     ' Summaries:
33
34     '     Class EncodingHelper
35     
36     '         Properties: TextEncoding
37     
38     '         Constructor: (+1 OverloadsSub New
39     '         FunctionGetBytes, (+2 OverloadsToString
40     
41     
42     ' /********************************************************************************/
43
44 #End Region
45
46 Imports System.Text
47
48 Namespace Text
49
50     ''' <summary>
51     ''' Helper for <see cref="Encodings"/>
52     ''' </summary>
53     Public Class EncodingHelper
54
55         ''' <summary>
56         ''' <see cref="Encoding"/> instance
57         ''' </summary>
58         ''' <returns></returns>
59         Public ReadOnly Property TextEncoding As Encoding
60
61         ''' <summary>
62         ''' Helper for <see cref="Encodings"/>
63         ''' </summary>
64         ''' <param name="encoding"></param>
65         Sub New(encoding As Encodings)
66             TextEncoding = encoding.CodePage
67         End Sub
68
69         '
70         ' Summary:
71         '     When overridden in a derived class, encodes all the characters in the specified
72         '     string into a sequence of bytes.
73         '
74         ' Parameters:
75         '   s:
76         '     The string containing the characters to encode.
77         '
78         Returns:
79         '     A byte array containing the results of encoding the specified set of characters.
80         '
81         ' Exceptions:
82         '   T:System.ArgumentNullException:
83         '     s is null.
84         '
85         '   T:System.Text.EncoderFallbackException:
86         '     A fallback occurred (see Character Encoding in the .NET Framework for complete
87         '     explanation)-and-System.Text.Encoding.EncoderFallback is set to System.Text.EncoderExceptionFallback.
88
89         ''' <summary>
90         ''' When overridden in a derived class, encodes all the characters in the specified
91         ''' string into a sequence of bytes.
92         ''' </summary>
93         ''' <param name="s">The string containing the characters to encode.</param>
94         ''' <returns>A byte array containing the results of encoding the specified set of characters.</returns>
95         Public Function GetBytes(s As StringAs Byte()
96             Return TextEncoding.GetBytes(s)
97         End Function
98
99         '
100         ' Summary:
101         '     When overridden in a derived class, decodes all the bytes in the specified byte
102         '     array into a string.
103         '
104         ' Parameters:
105         '   bytes:
106         '     The byte array containing the sequence of bytes to decode.
107         '
108         Returns:
109         '     A string that contains the results of decoding the specified sequence of bytes.
110         '
111         ' Exceptions:
112         '   T:System.ArgumentException:
113         '     The byte array contains invalid Unicode code points.
114         '
115         '   T:System.ArgumentNullException:
116         '     bytes is null.
117         '
118         '   T:System.Text.DecoderFallbackException:
119         '     A fallback occurred (see Character Encoding in the .NET Framework for complete
120         '     explanation)-and-System.Text.Encoding.DecoderFallback is set to System.Text.DecoderExceptionFallback.
121
122         ''' <summary>
123         ''' When overridden in a derived class, decodes all the bytes in the specified byte
124         ''' array into a string.
125         ''' </summary>
126         ''' <param name="byts">The byte array containing the sequence of bytes to decode.</param>
127         ''' <returns>A string that contains the results of decoding the specified sequence of bytes.</returns>
128         Public Overloads Function ToString(byts As Byte()) As String
129             Return TextEncoding.GetString(byts)
130         End Function
131
132         ''' <summary>
133         ''' <see cref="Encoding"/> instance
134         ''' </summary>
135         ''' <returns></returns>
136         Public Overrides Function ToString() As String
137             Return TextEncoding.ToString
138         End Function
139     End Class
140 End Namespace