Enum plist::Value

pub enum Value {
    Array(Vec<Value>),
    Dictionary(Dictionary),
    Boolean(bool),
    Data(Vec<u8>),
    Date(Date),
    Real(f64),
    Integer(Integer),
    String(String),
    Uid(Uid),
    // some variants omitted
}

Represents any plist value.

Variants

Array(Vec<Value>)

Dictionary(Dictionary)

Boolean(bool)

Data(Vec<u8>)

Date(Date)

Real(f64)

Integer(Integer)

String(String)

Uid(Uid)

Implementations

impl Value

pub fn from_file<P: AsRef<Path>>(path: P) -> Result<Value, Error>

Reads a Value from a plist file of any encoding.

pub fn from_reader<R: Read + Seek>(reader: R) -> Result<Value, Error>

Reads a Value from a seekable byte stream containing a plist of any encoding.

pub fn from_reader_xml<R: Read>(reader: R) -> Result<Value, Error>

Reads a Value from a seekable byte stream containing an XML encoded plist.

pub fn to_file_binary<P: AsRef<Path>>(&self, path: P) -> Result<(), Error>

Serializes a Value to a file as a binary encoded plist.

pub fn to_file_xml<P: AsRef<Path>>(&self, path: P) -> Result<(), Error>

Serializes a Value to a file as an XML encoded plist.

pub fn to_writer_binary<W: Write>(&self, writer: W) -> Result<(), Error>

Serializes a Value to a byte stream as a binary encoded plist.

pub fn to_writer_xml<W: Write>(&self, writer: W) -> Result<(), Error>

Serializes a Value to a byte stream as an XML encoded plist.

pub fn to_writer_xml_with_options<W: Write>(
    &self,
    writer: W,
    options: &XmlWriteOptions
) -> Result<(), Error>

Serializes a Value to a stream, using custom XmlWriteOptions.

If you need to serialize to a file, you must acquire an appropriate Write handle yourself.

Examples

use std::io::{BufWriter, Write};
use std::fs::File;
use plist::{Dictionary, Value, XmlWriteOptions};

let value: Value = Dictionary::new().into();
// .. add some keys & values
let mut file = File::create("com.example.myPlist.plist").unwrap();
let options = XmlWriteOptions::default().indent_string("  ");
value.to_writer_xml_with_options(BufWriter::new(&mut file), &options).unwrap();
file.sync_all().unwrap();

pub fn into_array(self) -> Option<Vec<Value>>

If the Value is a Array, returns the underlying Vec.

Returns None otherwise.

This method consumes the Value. To get a reference instead, use as_array.

pub fn as_array(&self) -> Option<&Vec<Value>>

If the Value is an Array, returns the associated Vec.

Returns None otherwise.

pub fn as_array_mut(&mut self) -> Option<&mut Vec<Value>>

If the Value is an Array, returns the associated mutable Vec.

Returns None otherwise.

pub fn into_dictionary(self) -> Option<Dictionary>

If the Value is a Dictionary, returns the associated BTreeMap.

Returns None otherwise.

This method consumes the Value. To get a reference instead, use as_dictionary.

pub fn as_dictionary(&self) -> Option<&Dictionary>

If the Value is a Dictionary, returns the associated BTreeMap.

Returns None otherwise.

pub fn as_dictionary_mut(&mut self) -> Option<&mut Dictionary>

If the Value is a Dictionary, returns the associated mutable BTreeMap.

Returns None otherwise.

pub fn as_boolean(&self) -> Option<bool>

If the Value is a Boolean, returns the associated bool.

Returns None otherwise.

pub fn into_data(self) -> Option<Vec<u8>>

If the Value is a Data, returns the underlying Vec.

Returns None otherwise.

This method consumes the Value. If this is not desired, please use as_data method.

pub fn as_data(&self) -> Option<&[u8]>

If the Value is a Data, returns the associated Vec.

Returns None otherwise.

pub fn as_date(&self) -> Option<Date>

If the Value is a Date, returns the associated Date.

Returns None otherwise.

pub fn as_real(&self) -> Option<f64>

If the Value is a Real, returns the associated f64.

Returns None otherwise.

pub fn as_signed_integer(&self) -> Option<i64>

If the Value is a signed Integer, returns the associated i64.

Returns None otherwise.

pub fn as_unsigned_integer(&self) -> Option<u64>

If the Value is an unsigned Integer, returns the associated u64.

Returns None otherwise.

pub fn into_string(self) -> Option<String>

If the Value is a String, returns the underlying String.

Returns None otherwise.

This method consumes the Value. If this is not desired, please use as_string method.

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

If the Value is a String, returns the associated str.

Returns None otherwise.

Trait Implementations

impl Clone for Value

fn clone(&self) -> Value

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Value

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

Formats the value using the given formatter.

impl<'a> From<&'a Date> for Value

fn from(from: &'a Date) -> Value

Performs the conversion.

impl<'a> From<&'a bool> for Value

fn from(from: &'a bool) -> Value

Performs the conversion.

impl<'a> From<&'a f32> for Value

fn from(from: &'a f32) -> Value

Performs the conversion.

impl<'a> From<&'a f64> for Value

fn from(from: &'a f64) -> Value

Performs the conversion.

impl<'a> From<&'a i16> for Value

fn from(from: &'a i16) -> Value

Performs the conversion.

impl<'a> From<&'a i32> for Value

fn from(from: &'a i32) -> Value

Performs the conversion.

impl<'a> From<&'a i64> for Value

fn from(from: &'a i64) -> Value

Performs the conversion.

impl<'a> From<&'a i8> for Value

fn from(from: &'a i8) -> Value

Performs the conversion.

impl<'a> From<&'a str> for Value

fn from(from: &'a str) -> Value

Performs the conversion.

impl<'a> From<&'a u16> for Value

fn from(from: &'a u16) -> Value

Performs the conversion.

impl<'a> From<&'a u32> for Value

fn from(from: &'a u32) -> Value

Performs the conversion.

impl<'a> From<&'a u64> for Value

fn from(from: &'a u64) -> Value

Performs the conversion.

impl<'a> From<&'a u8> for Value

fn from(from: &'a u8) -> Value

Performs the conversion.

impl From<Date> for Value

fn from(from: Date) -> Value

Performs the conversion.

impl From<Dictionary> for Value

fn from(from: Dictionary) -> Value

Performs the conversion.

impl From<String> for Value

fn from(from: String) -> Value

Performs the conversion.

impl From<Vec<Value, Global>> for Value

fn from(from: Vec<Value>) -> Value

Performs the conversion.

impl From<bool> for Value

fn from(from: bool) -> Value

Performs the conversion.

impl From<f32> for Value

fn from(from: f32) -> Value

Performs the conversion.

impl From<f64> for Value

fn from(from: f64) -> Value

Performs the conversion.

impl From<i16> for Value

fn from(from: i16) -> Value

Performs the conversion.

impl From<i32> for Value

fn from(from: i32) -> Value

Performs the conversion.

impl From<i64> for Value

fn from(from: i64) -> Value

Performs the conversion.

impl From<i8> for Value

fn from(from: i8) -> Value

Performs the conversion.

impl From<u16> for Value

fn from(from: u16) -> Value

Performs the conversion.

impl From<u32> for Value

fn from(from: u32) -> Value

Performs the conversion.

impl From<u64> for Value

fn from(from: u64) -> Value

Performs the conversion.

impl From<u8> for Value

fn from(from: u8) -> Value

Performs the conversion.

impl PartialEq<Value> for Value

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for Value