Base64Encode(ReadOnlySpanByte, Base64FormattingOptions) Method

Converts a read-only Byte span to a corresponding Base64-encoded string. Optional you can determine, whether line breaks are to be inserted into the return value.

Definition

Namespace: FolkerKinzel.Strings
Assembly: FolkerKinzel.Strings (in FolkerKinzel.Strings.dll) Version: 9.4.3+0b4e3cc14d7870504a77e224d298b921bfc6f2ee

C#

public static string Encode(
	ReadOnlySpan<byte> bytes,
	Base64FormattingOptions options = Base64FormattingOptions.None
)

VB

Public Shared Function Encode ( 
	bytes As ReadOnlySpan(Of Byte),
	Optional options As Base64FormattingOptions = Base64FormattingOptions.None
) As String

C++

public:
static String^ Encode(
	ReadOnlySpan<unsigned char> bytes, 
	Base64FormattingOptions options = Base64FormattingOptions::None
)

F#

static member Encode : 
        bytes : ReadOnlySpan<byte> * 
        ?options : Base64FormattingOptions 
(* Defaults:
        let _options = defaultArg options Base64FormattingOptions.None
*)
-> string

Parameters

bytes ReadOnlySpanByte: A read-only Byte span that contains the data to encode.
options Base64FormattingOptions (Optional): One of the enumeration values, which specify whether or not line breaks are to be inserted into the return value. The default is None.

Return Value

String
The Base64 string reprensentation of the elements in bytes.

Remarks

Note

In the .NET-Framework 4.5 and .NET Standard 2.0 versions of the nuget package, the method has to allocate a new Array. For this reason it is recommended, to use the overloads Encode(Byte, Int32, Int32, Base64FormattingOptions) or Encode(Byte, Base64FormattingOptions) when supporting old framework versions.

Exceptions

ArgumentException	options is not a defined Base64FormattingOptions value.
OutOfMemoryException	The output length was greater than Int32.MaxValue.