BogaNet.Encoder.Base2 Class Reference

Base2 (aka Binary) encoder class. More...

Static Public Member Functions
static byte[]	FromBase2String (string base2string)
	Converts a Base2-string to a byte-array.
static string	ToBase2String (params byte[] bytes)
	Converts a byte-array to a Base2-string.
static string	ToBase2String< T > (T number)
	Converts the value of a Number to a Base2-string.
static string	ToBase2String (string str, Encoding? encoding=null)
	Converts the value of a string to a Base2-string.
static string	Base2FromFile (string file)
	Converts a file to a Base2-string.
static async Task< string >	Base2FromFileAsync (string file)
	Converts a file to a Base2-string asynchronously.
static bool	FileFromBase2 (string file, string base2string)
	Converts a Base2-string to a file.
static async Task< bool >	FileFromBase2Async (string file, string base2string)
	Converts a Base2-string to a file asynchronously.

Detailed Description

Base2 (aka Binary) encoder class.

Member Function Documentation

Base2FromFile()

static string BogaNet.Encoder.Base2.Base2FromFile ( string file )

static

Converts a file to a Base2-string.

Parameters

file	File to convert

Returns

File content as converted Base2-string

Exceptions

Exception

Base2FromFileAsync()

static async Task< string > BogaNet.Encoder.Base2.Base2FromFileAsync ( string file )

static

Converts a file to a Base2-string asynchronously.

Parameters

file	File to convert

Returns

File content as converted Base2-string

Exceptions

Exception

FileFromBase2()

static bool BogaNet.Encoder.Base2.FileFromBase2 ( string file, string base2string )

static

Converts a Base2-string to a file.

Parameters

file	File to write the content of the Base2-string
base2string	Data as Base2-string

Returns

True if the operation was successful

Exceptions

Exception

FileFromBase2Async()

static async Task< bool > BogaNet.Encoder.Base2.FileFromBase2Async ( string file, string base2string )

static

Converts a Base2-string to a file asynchronously.

Parameters

file	File to write the content of the Base2-string
base2string	Data as Base2-string

Returns

True if the operation was successful

Exceptions

Exception

FromBase2String()

static byte[] BogaNet.Encoder.Base2.FromBase2String ( string base2string )

static

Converts a Base2-string to a byte-array.

Parameters

base2string

Data as Base2-string

Returns

Data as byte-array

Exceptions

ArgumentNullException

ToBase2String() [1/2]

static string BogaNet.Encoder.Base2.ToBase2String ( params byte[] bytes )

static

Converts a byte-array to a Base2-string.

Parameters

bytes

Data as byte-array

Returns

Data as encoded Base2-string

Exceptions

ArgumentNullException

ToBase2String() [2/2]

static string BogaNet.Encoder.Base2.ToBase2String ( string str, Encoding? encoding = null )

static

Converts the value of a string to a Base2-string.

Parameters

str	Input string
encoding	Encoding of the string (optional, default: UTF8)

Returns

String value as converted Base2-string

Exceptions

ArgumentNullException

ToBase2String< T >()

static string BogaNet.Encoder.Base2.ToBase2String< T > ( T number )

static

Converts the value of a Number to a Base2-string.

Parameters

number

Given value

Returns

Number as converted Base2-string

Exceptions

ArgumentNullException

Type Constraints

T

:

INumber<T>

---

The documentation for this class was generated from the following file:

• /Users/stefanlaubenberger/Projects/CSharp/BogaNet/BogaNet.Encoder/Encoder/Base2.cs