C# Class SteamKit2.KeyValue

Represents a recursive string key to arbitrary value container.

Show file Open project: Top-Cat/SteamBot Class Usage Examples

Public Properties

Property	Type	Description
Invalid	KeyValue

Public Methods

Method	Description
AsBoolean ( bool defaultValue = default(bool) ) : bool	Attempts to convert and return the value of this instance as a boolean. If the conversion is invalid, the default value is returned.
AsFloat ( float defaultValue = default(float) ) : float	Attempts to convert and return the value of this instance as a float. If the conversion is invalid, the default value is returned.
AsInteger ( int defaultValue = default(int) ) : int	Attempts to convert and return the value of this instance as an integer. If the conversion is invalid, the default value is returned.
AsLong ( long defaultValue = default(long) ) : long	Attempts to convert and return the value of this instance as a long. If the conversion is invalid, the default value is returned.
AsString ( ) : string	Returns the value of this instance as a string.
KeyValue ( string name = null, string value = null ) : System	Initializes a new instance of the KeyValue class.
LoadAsBinary ( string path ) : KeyValue	Attempts to load the given filename as a binary KeyValue. This method will swallow any exceptions that occur when reading, use ReadAsBinary if you wish to handle exceptions.
LoadAsText ( string path ) : KeyValue	Attempts to load the given filename as a text KeyValue. This method will swallow any exceptions that occur when reading, use ReadAsText if you wish to handle exceptions.
LoadFromString ( string input ) : KeyValue	Attempts to create an instance of KeyValue from the given input text. This method will swallow any exceptions that occur when reading, use ReadAsText if you wish to handle exceptions.
ReadAsBinary ( Stream input ) : bool	Populate this instance from the given Stream as a binary KeyValue.
ReadAsText ( Stream input ) : bool	Populate this instance from the given Stream as a text KeyValue.
ReadFileAsText ( string filename ) : bool	Opens and reads the given filename as text.
SaveToFile ( string path, bool asBinary ) : void	Saves this instance to file.
ToString ( ) : string	Returns a System.String that represents this instance.
this ( string key ) : KeyValue	Gets the child SteamKit2.KeyValue with the specified key. If no child with this key exists, Invalid is returned.

Private Methods

Method	Description
LoadFromFile ( string path, bool asBinary ) : KeyValue
RecursiveLoadFromBuffer ( KVTextReader kvr ) : void
RecursiveSaveToFile ( FileStream f ) : void
RecursiveSaveToFile ( FileStream f, int indentLevel ) : void
WriteIndents ( FileStream f, int indentLevel ) : void
WriteString ( FileStream f, string str, bool quote = false ) : void

Method Details

AsBoolean() public method

Attempts to convert and return the value of this instance as a boolean. If the conversion is invalid, the default value is returned.

public AsBoolean ( bool defaultValue = default(bool) ) : bool
defaultValue	bool	The default value to return if the conversion is invalid.
return	bool

AsFloat() public method

Attempts to convert and return the value of this instance as a float. If the conversion is invalid, the default value is returned.

public AsFloat ( float defaultValue = default(float) ) : float
defaultValue	float	The default value to return if the conversion is invalid.
return	float

AsInteger() public method

Attempts to convert and return the value of this instance as an integer. If the conversion is invalid, the default value is returned.

public AsInteger ( int defaultValue = default(int) ) : int
defaultValue	int	The default value to return if the conversion is invalid.
return	int

AsLong() public method

Attempts to convert and return the value of this instance as a long. If the conversion is invalid, the default value is returned.

public AsLong ( long defaultValue = default(long) ) : long
defaultValue	long	The default value to return if the conversion is invalid.
return	long

AsString() public method

Returns the value of this instance as a string.

public AsString ( ) : string
return	string

KeyValue() public method

Initializes a new instance of the KeyValue class.

public KeyValue ( string name = null, string value = null ) : System
name	string	The optional name of the root key.
value	string	The optional value assigned to the root key.
return	System

LoadAsBinary() public static method

Attempts to load the given filename as a binary KeyValue.

This method will swallow any exceptions that occur when reading, use ReadAsBinary if you wish to handle exceptions.

public static LoadAsBinary ( string path ) : KeyValue
path	string	The path to the file to load.
return	KeyValue

LoadAsText() public static method

Attempts to load the given filename as a text KeyValue.

This method will swallow any exceptions that occur when reading, use ReadAsText if you wish to handle exceptions.

public static LoadAsText ( string path ) : KeyValue
path	string	The path to the file to load.
return	KeyValue

LoadFromString() public static method

Attempts to create an instance of KeyValue from the given input text.

This method will swallow any exceptions that occur when reading, use ReadAsText if you wish to handle exceptions.

public static LoadFromString ( string input ) : KeyValue
input	string	The input text to load.
return	KeyValue

ReadAsBinary() public method

Populate this instance from the given Stream as a binary KeyValue.

public ReadAsBinary ( Stream input ) : bool
input	Stream	The input to read from.
return	bool

ReadAsText() public method

Populate this instance from the given Stream as a text KeyValue.

public ReadAsText ( Stream input ) : bool
input	Stream	The input to read from.
return	bool

ReadFileAsText() public method

Opens and reads the given filename as text.

public ReadFileAsText ( string filename ) : bool
filename	string	The file to open and read.
return	bool

SaveToFile() public method

Saves this instance to file.

public SaveToFile ( string path, bool asBinary ) : void
path	string	The file path to save to.
asBinary	bool	If set to true, saves this instance as binary.
return	void

ToString() public method

Returns a System.String that represents this instance.

public ToString ( ) : string
return	string

this() public method

Gets the child SteamKit2.KeyValue with the specified key. If no child with this key exists, Invalid is returned.

public this ( string key ) : KeyValue
key	string
return	KeyValue

Property Details

Invalid public static property

Represents an invalid KeyValue given when a searched for child does not exist.

public static KeyValue,SteamKit2 Invalid
return	KeyValue