BugKnights

Games • Software • Frameworks

Chiwamber Core

Chiwamber Core

Type Framework
File Size 0.02 MB
Version 1.0.0

Requirements

.Net Framework 4.5.2

DOWNLOAD

Welcome to the Chivalrous Software Chamber, Chiwamber for short. Chiwamber is our collection of often needed functions for .NET application development. The Chiwamber.Core component contains general functions such as file reading and writing. You can read more about the contents of our framework in the "Documentation" tab, where all classes and functions are described.

Version 1.0.0 is the first public release, released on 25th May 2017. Because of this, there are no changes to previous versions.

Chiwamber.Core.Security

PasswordGenerator

Generates secure passwords.

Method String GeneratePassword(Boolean includeSpecialCharacters) Generates a secure password with 10 characters.
Method String GeneratePassword(Boolean includeSpecialCharacters, Int32 passwordLength) Generates a secure password.

PasswordValidator

Validates passwords.

Method PasswordSecurityLevel Validate(String password) Validates if the given password is secure.

PasswordSecurityLevel

Represents the security level of a password.

Chiwamber.Core.Html

StringExtensions

Provides string extension methods to build a HTML string.

Chiwamber.Core.DataAccess

ObjectFileService

This class can handle the storage of multiple different objects into a single file. To store an object it must be serializable. Stored objects can be identified by a simple key of type String.

Method Task<Boolean> SaveAsync(String key, Object value) Async version of the save method.
Method Task<T> ReadAsync(String key) Async version of the read method.
Method Boolean Save(String key, Object value) Saves the given object to a file on the local file system.
Method T Read(String key) Reads an object that was saved with the given key.

SettingsFileService

Can write/read multiple settings to/from a single text file.

Method Task<Boolean> SaveAsync(String key, String value) Async version of the save method.
Method Task<String> ReadAsync(String key) Async version of the read method.
Method String Read(String key) Reads a setting that was saved with the given key.
Method Boolean Save(String key, String value) Saves a setting.

Chiwamber.Core.DataAccess.FileWriters

BinaryObjectWriter

Can write an object to a file.

Method Boolean Save(String path, Object value) Stores an object into a binary formatted file.

CsvWriter

Writes a to a file.

Method Void Save(String path, CsvFileContent csv) Stores data into a csv file.

SettingsWriter

Writes settings into a readable text file.

Method Void Save(String path, List<KeyValuePair<String,String>> settings) Stores a list of settings into a plain text file.

XmlWriter

Can write an object to a xml file.

Method Boolean Save(String path, Object value) Stores an object into a binary formatted file.

Chiwamber.Core.DataAccess.FileReaders

BinaryObjectReader

Can read files from the computer which contains a saved object in a binary format.

Method T Read(String path) Reads a binary file with a stored object inside.

CsvReader

Can read CSV files.

Method List<List<String>> Read(String path) Reads a CSV file that does not have a header row.
Method CsvFileContent ReadWithHeader(String path) Reads a CSV file. Interprets the first row as header.

CsvFileContent

Represents a CSV file.

Property Header Contains the CSV header row.
Property Rows Contains the CSV content rows.

SettingsReader

Can read files from the computer which contains settings saved as plain text.

Method List<KeyValuePair<String,String>> Read(String path) Reads a text file with stored settings inside.

XmlReader

Can read files from the computer which contains a saved object in a xml format.

Method T Read(String path) Reads a xml file with a stored object inside.