/// <summary>
/// Tries to parse the CharacterID from a string.
/// </summary>
/// <param name="parser">The Parser to use.</param>
/// <param name="value">The string to parse.</param>
/// <param name="outValue">If this method returns true, contains the parsed CharacterID.</param>
/// <returns>True if the parsing was successfully; otherwise false.</returns>
public static bool TryParse(this Parser parser, string value, out CharacterID outValue)
{
int tmp;
var ret = parser.TryParse(value, out tmp);
outValue = new CharacterID(tmp);
return(ret);
}
/// <summary>
/// Writes a CharacterID to a IValueWriter.
/// </summary>
/// <param name="valueWriter">IValueWriter to write to.</param>
/// <param name="name">Unique name of the CharacterID that will be used to distinguish it
/// from other values when reading.</param>
/// <param name="value">CharacterID to write.</param>
public static void Write(this IValueWriter valueWriter, string name, CharacterID value)
{
value.Write(valueWriter, name);
}
/// <summary>
/// Writes a CharacterID to a BitStream.
/// </summary>
/// <param name="bitStream">BitStream to write to.</param>
/// <param name="value">CharacterID to write.</param>
public static void Write(this BitStream bitStream, CharacterID value)
{
value.Write(bitStream);
}
/// <summary>
/// Reads the CharacterID from an IValueReader.
/// </summary>
/// <param name="valueReader">IValueReader to read the CharacterID from.</param>
/// <param name="name">The unique name of the value to read.</param>
/// <returns>The CharacterID read from the IValueReader.</returns>
public static CharacterID ReadCharacterID(this IValueReader valueReader, string name)
{
return(CharacterID.Read(valueReader, name));
}
/// <summary>
/// Reads the CharacterID from a BitStream.
/// </summary>
/// <param name="bitStream">BitStream to read the CharacterID from.</param>
/// <returns>The CharacterID read from the BitStream.</returns>
public static CharacterID ReadCharacterID(this BitStream bitStream)
{
return(CharacterID.Read(bitStream));
}
/// <summary>
/// Reads the CharacterID from an <see cref="IDataRecord"/>.
/// </summary>
/// <param name="r"><see cref="IDataRecord"/> to read the CharacterID from.</param>
/// <param name="name">The name of the field to read the value from.</param>
/// <returns>The CharacterID read from the <see cref="IDataRecord"/>.</returns>
public static CharacterID GetCharacterID(this IDataRecord r, string name)
{
return(CharacterID.Read(r, name));
}
/// <summary>
/// Reads the CharacterID from an <see cref="IDataRecord"/>.
/// </summary>
/// <param name="r"><see cref="IDataRecord"/> to read the CharacterID from.</param>
/// <param name="i">The field index to read.</param>
/// <returns>The CharacterID read from the <see cref="IDataRecord"/>.</returns>
public static CharacterID GetCharacterID(this IDataRecord r, int i)
{
return(CharacterID.Read(r, i));
}
/// <summary>
/// Tries to get the value in the <paramref name="dict"/> entry at the given <paramref name="key"/> as type CharacterID.
/// </summary>
/// <typeparam name="T">The key Type.</typeparam>
/// <param name="dict">The IDictionary.</param>
/// <param name="key">The key for the value to get.</param>
/// <param name="defaultValue">The value to use if the value at the <paramref name="key"/> could not be parsed.</param>
/// <returns>The value at the given <paramref name="key"/> parsed as an int, or the
/// <paramref name="defaultValue"/> if the <paramref name="key"/> did not exist in the <paramref name="dict"/>
/// or the value at the given <paramref name="key"/> could not be parsed.</returns>
public static CharacterID AsCharacterID <T>(this IDictionary <T, string> dict, T key, CharacterID defaultValue)
{
string value;
if (!dict.TryGetValue(key, out value))
{
return(defaultValue);
}
CharacterID parsed;
if (!Parser.Invariant.TryParse(value, out parsed))
{
return(defaultValue);
}
return(parsed);
}