microsoft-visualbasic-runtime/Net/HTTP/Stream/GZStream.vb

122 lines
4.3 KiB
VB.net
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

#Region "Microsoft.VisualBasic::ec105b39efee699fc535c65d9f0f9b44, Microsoft.VisualBasic.Core\Net\HTTP\Stream\GZStream.vb"
' Author:
'
' asuka (amethyst.asuka@gcmodeller.org)
' xie (genetics@smrucc.org)
' xieguigang (xie.guigang@live.com)
'
' Copyright (c) 2018 GPL3 Licensed
'
'
' GNU GENERAL PUBLIC LICENSE (GPL3)
'
'
' This program is free software: you can redistribute it and/or modify
' it under the terms of the GNU General Public License as published by
' the Free Software Foundation, either version 3 of the License, or
' (at your option) any later version.
'
' This program is distributed in the hope that it will be useful,
' but WITHOUT ANY WARRANTY; without even the implied warranty of
' MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
' GNU General Public License for more details.
'
' You should have received a copy of the GNU General Public License
' along with this program. If not, see <http://www.gnu.org/licenses/>.
' /********************************************************************************/
' Summaries:
' Module GZipStream
'
' Function: AddGzipMagic, GZipAsBase64, GZipStream, UnGzipBase64, UnGzipStream
'
'
' /********************************************************************************/
#End Region
Imports System.IO
Imports System.IO.Compression
Imports System.Runtime.CompilerServices
Imports Microsoft.VisualBasic.Linq
Namespace Net.Http
''' <summary>
''' 请注意这个模块是处理http请求或者响应之中的gzip压缩的数据
''' 对于zip压缩的数据需要使用<see cref="ZipStreamExtensions"/>模块之中的帮助函数来完成
''' </summary>
Public Module GZipStream
''' <summary>
''' 如果得到的一个gzip压缩的数据块头部没有magic number的话则使用这个方法手动的添加标记后再做解压缩
''' </summary>
''' <param name="data"></param>
''' <returns></returns>
<Extension>
Public Function AddGzipMagic(data As IEnumerable(Of Byte)) As IEnumerable(Of Byte)
Return New Byte() {&H1F, &H8B}.JoinIterates(data)
End Function
''' <summary>
''' Unzip the stream data in the <paramref name="base64"/> string.
''' </summary>
''' <param name="base64$"></param>
''' <returns></returns>
'''
<MethodImpl(MethodImplOptions.AggressiveInlining)>
<Extension>
Public Function UnGzipBase64(base64$) As MemoryStream
Return Convert.FromBase64String(base64).UnGzipStream
End Function
''' <summary>
''' 将输入的流数据进行gzip解压缩
''' </summary>
''' <remarks>
''' 使用这个函数得到的结果需要注意进行<see cref="IDisposable.Dispose()"/>,否则很容易造成内存泄漏
''' </remarks>
''' <param name="stream"></param>
''' <returns></returns>
<Extension>
Public Function UnGzipStream(stream As IEnumerable(Of Byte)) As MemoryStream
Using gz As New Compression.GZipStream(New MemoryStream(stream.ToArray), CompressionMode.Decompress)
Dim ms As New MemoryStream
Call gz.CopyTo(ms)
Return ms
End Using
End Function
''' <summary>
''' 对所输入的流进行gzip压缩
''' </summary>
''' <param name="stream"></param>
''' <returns></returns>
<Extension>
Public Function GZipStream(stream As Stream) As MemoryStream
Dim ms As New MemoryStream
Using gz As New Compression.GZipStream(ms, CompressionMode.Compress)
Call stream.CopyTo(gz)
Return ms
End Using
End Function
''' <summary>
''' 将目标流对象之中的数据进行zip压缩然后转换为base64字符串
''' </summary>
''' <param name="stream"></param>
''' <returns></returns>
<Extension> Public Function GZipAsBase64(stream As Stream) As String
Dim bytes As Byte() = stream.GZipStream.ToArray
Dim s$ = Convert.ToBase64String(bytes)
Return s
End Function
End Module
End Namespace