Struct KeyValue 

pub struct KeyValue { /* private fields */ }

A tree of string keys to values or child nodes.

Implementations

impl KeyValue

pub fn new() -> KeyValue

Creates an empty node.

pub fn with_name(name: impl Into<String>) -> KeyValue

Creates a node with a name.

pub fn with_name_and_value( name: impl Into<String>, value: impl Into<String>, ) -> KeyValue

Creates a node with a name and a value.

pub fn invalid() -> &'static KeyValue

The node returned when a looked-up child doesn’t exist.

pub fn name(&self) -> Option<&str>

The name of this node.

pub fn set_name(&mut self, name: Option<String>)

Sets the name of this node.

pub fn value(&self) -> Option<&str>

The value of this node.

pub fn set_value(&mut self, value: Option<String>)

Sets the value of this node.

pub fn children(&self) -> &[KeyValue]

The children of this node.

pub fn children_mut(&mut self) -> &mut Vec<KeyValue>

The children of this node, for modification.

pub fn get(&self, key: &str) -> &KeyValue

The child with the given key (ordinal, case-insensitive), or KeyValue::invalid if there’s none.

pub fn set(&mut self, key: &str, value: KeyValue)

Sets the child with the given key: removes any existing child with that key, renames value to key and appends it.

pub fn as_string(&self) -> Option<&str>

The value as a string.

pub fn as_unsigned_byte(&self, default_value: u8) -> u8

The value as a u8, or default_value if it isn’t one.

pub fn as_unsigned_short(&self, default_value: u16) -> u16

The value as a u16, or default_value if it isn’t one.

pub fn as_integer(&self, default_value: i32) -> i32

The value as an i32, or default_value if it isn’t one.

pub fn as_unsigned_integer(&self, default_value: u32) -> u32

The value as a u32, or default_value if it isn’t one.

pub fn as_long(&self, default_value: i64) -> i64

The value as an i64, or default_value if it isn’t one.

pub fn as_unsigned_long(&self, default_value: u64) -> u64

The value as a u64, or default_value if it isn’t one.

pub fn as_float(&self, default_value: f32) -> f32

The value as an f32, or default_value if it isn’t one.

pub fn as_boolean(&self, default_value: bool) -> bool

The value as a boolean, or default_value if it isn’t one.

pub fn as_enum<T: FromKeyValue>(&self, default_value: T) -> T

The value as an enum, or default_value if it isn’t one.

impl KeyValue

pub async fn load_as_text(path: impl AsRef<Path>) -> Option<KeyValue>

Loads a text KeyValue from a file. None on any error.

pub async fn try_load_as_binary(path: impl AsRef<Path>) -> Option<KeyValue>

Loads a binary KeyValue from a file. None on any error.

pub fn load_from_string(input: &str) -> Option<KeyValue>

Parses a text KeyValue from a string. None on any error.

pub fn read_as_text(&mut self, input: &mut dyn Read) -> Result<(), SteamError>

Reads this node from a text KeyValue stream.

A byte order mark is detected and stripped, so UTF-8 (EF BB BF), UTF-16 LE (FF FE) and UTF-16 BE (FE FF) documents all work. Without one, the bytes are read as UTF-8.

pub async fn read_file_as_text( &mut self, filename: impl AsRef<Path>, ) -> Result<(), SteamError>

Reads this node from a text KeyValue file. The encoding is detected like in KeyValue::read_as_text.

pub async fn save_to_file( &self, path: impl AsRef<Path>, as_binary: bool, ) -> Result<(), SteamError>

Saves this node to a file.

pub fn save_to_stream( &self, stream: &mut dyn Write, as_binary: bool, ) -> Result<(), SteamError>

Saves this node to a stream.

pub fn try_read_as_binary(&mut self, input: &mut dyn Read) -> bool

Reads this node from a binary KeyValue stream. Returns false on failure.

Trait Implementations

impl Clone for KeyValue

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for KeyValue

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for KeyValue

fn default() -> Self

Returns the “default value” for a type.

impl Display for KeyValue

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for KeyValue

impl PartialEq for KeyValue

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for KeyValue