Value

Enum Value 

Source
pub enum Value {
    String(String),
    Array(Vec<Value>),
    Object(HashMap<String, Value>),
}

Variants§

§

String(String)

§

Array(Vec<Value>)

§

Object(HashMap<String, Value>)

Implementations§

Source§

impl Value

Source

pub fn from_string(_text: String) -> Result<Self>

Source

pub fn is_string(&self) -> bool

Check if the current value is a string.

§Example
use languages_rs::Value;

#[cfg(feature = "with-json")]
fn main() {
    let value = Value::from_string(String::from("\"Hi\""));
    assert!(value.is_ok());
    assert!(value.unwrap().is_string());
}

#[cfg(feature = "with-toml")]
fn main() {
    let value = Value::from_string(String::from("hi = \"Hi\""));
    assert!(value.is_ok());

    let table = value.unwrap().get_object();
    assert!(table.is_some());

    let table = table.unwrap();
    let text = table.get("hi");
    assert!(text.is_some());
    assert!(text.unwrap().is_string());
}

#[cfg(all(not(feature = "with-json"), not(feature = "with-toml")))]
fn main() {}
Source

pub fn get_string(&self) -> Option<String>

Get the string value.

§Example
use languages_rs::Value;

#[cfg(feature = "with-json")]
fn main() {
    let value = Value::from_string(String::from("\"Hi\""));
    assert!(value.is_ok());
    assert_eq!(value.unwrap().get_string(), Some(String::from("Hi")));
}

#[cfg(feature = "with-toml")]
fn main() {
    let value = Value::from_string(String::from("hi = \"Hi\""));
    assert!(value.is_ok());

    let table = value.unwrap().get_object();
    assert!(table.is_some());

    let table = table.unwrap();
    let text = table.get("hi");
    assert!(text.is_some());
    assert_eq!(text.unwrap().get_string(), Some(String::from("Hi")));
}

#[cfg(all(not(feature = "with-json"), not(feature = "with-toml")))]
fn main() {}
Source

pub fn is_array(&self) -> bool

Check if the current value is an array.

§Example
use languages_rs::Value;

#[cfg(feature = "with-json")]
fn main() {
    let value = Value::from_string(String::from("[\"1\", \"2\"]"));
    assert!(value.is_ok());
    assert!(value.unwrap().is_array());
}

#[cfg(feature = "with-toml")]
fn main() {
    let value = Value::from_string(String::from("numbers = [\"1\", \"2\"]"));
    assert!(value.is_ok());

    let table = value.unwrap().get_object();
    assert!(table.is_some());

    let table = table.unwrap();
    let values = table.get("numbers");
    assert!(values.is_some());
    assert!(values.unwrap().is_array());
}

#[cfg(all(not(feature = "with-json"), not(feature = "with-toml")))]
fn main() {}
Source

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

Get the array value.

§Example
use languages_rs::Value;

#[cfg(feature = "with-json")]
fn main() {
    let value = Value::from_string(String::from("[\"1\", \"2\"]"));
    assert!(value.is_ok());
    assert_eq!(
        value.unwrap().get_array(),
        Some(vec![Value::String(String::from("1")), Value::String(String::from("2"))]),
    );
}

#[cfg(feature = "with-toml")]
fn main() {
    let value = Value::from_string(String::from("numbers = [\"1\", \"2\"]"));
    assert!(value.is_ok());

    let table = value.unwrap().get_object();
    assert!(table.is_some());

    let table = table.unwrap();
    let values = table.get("numbers");
    assert!(values.is_some());
    assert_eq!(
        values.unwrap().get_array(),
        Some(vec![Value::String(String::from("1")), Value::String(String::from("2"))]),
    );
}

#[cfg(all(not(feature = "with-json"), not(feature = "with-toml")))]
fn main() {}
Source

pub fn is_object(&self) -> bool

Check if the current value is an object.

§Example JSON
use languages_rs::Value;

#[cfg(feature = "with-json")]
fn main() {
    let value = Value::from_string(String::from("{\"home\":{\"title\":\"Home page\"}}"));
    assert!(value.is_ok());
    assert!(value.unwrap().is_object());
}

#[cfg(feature = "with-toml")]
fn main() {
    let value = Value::from_string(String::from("[home]\r\ntitle = \"Home page\""));
    assert!(value.is_ok());
    assert!(value.unwrap().is_object());
}

#[cfg(all(not(feature = "with-json"), not(feature = "with-toml")))]
fn main() {}
Source

pub fn get_object(&self) -> Option<HashMap<String, Value>>

Get the object value.

§Example JSON
use std::collections::HashMap;

use languages_rs::Value;

#[cfg(feature = "with-json")]
fn main() {
    let value = Value::from_string(String::from("{ \"title\": \"Home page\" }"));
    assert!(value.is_ok());

    let mut data: HashMap<String, Value> = HashMap::new();
    data.insert(String::from("title"), Value::String(String::from("Home page")));

    assert_eq!(value.unwrap().get_object(), Some(data));
}

#[cfg(feature = "with-toml")]
fn main() {
    let value = Value::from_string(String::from("title = \"Home page\""));
    assert!(value.is_ok());

    let mut data: HashMap<String, Value> = HashMap::new();
    data.insert(String::from("title"), Value::String(String::from("Home page")));

    assert_eq!(value.unwrap().get_object(), Some(data));
}

#[cfg(all(not(feature = "with-json"), not(feature = "with-toml")))]
fn main() {}

Trait Implementations§

Source§

impl Clone for Value

Source§

fn clone(&self) -> Value

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Value

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for Value

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Value

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for Value

Auto Trait Implementations§

§

impl Freeze for Value

§

impl RefUnwindSafe for Value

§

impl Send for Value

§

impl Sync for Value

§

impl Unpin for Value

§

impl UnwindSafe for Value

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.