Struct Value 

pub struct Value(/* private fields */);

The CBOR data structure.

Implementations

impl Value

pub fn unsigned(int: u64) -> Value

Creates a CBOR unsigned value.

pub fn integer(int: i64) -> Value

Create an appropriate CBOR integer value (uint/nint). For simplicity, this only takes i64. Construct directly for the last bit.

pub fn byte_string(bytes: Vec<u8>) -> Value

Creates a CBOR byte string value.

pub fn text_string(text: String) -> Value

Creates a CBOR text string value.

pub fn array(a: Vec<Value>) -> Value

Create a CBOR array value.

Examples found in repository

examples/cbor.rs (line 38)

fn main() {
    // Build a CBOR object with various different types included. Note that this
    // object is not built in canonical order.
    let manual_object = Value::map(vec![
        (
            Value::from(1),
            Value::array(vec![Value::from(2), Value::from(3)]),
        ),
        (Value::from("tstr".to_owned()), Value::from(vec![1, 2, 3])),
        (Value::from(-2), Value::null_value()),
        (Value::from(3), Value::bool_value(true)),
    ]);

    // Build the same object using the crate's convenience macros.
    let macro_object = cbor_map! {
        1 => cbor_array![2, 3],
        "tstr" => cbor_bytes!(vec![1, 2, 3]),
        -2 => cbor_null!(),
        3 => cbor_true!(),
    };

    assert_eq!(manual_object, macro_object);
    println!("Object {:?}", manual_object);

    // Serialize to bytes.
    let mut manual_data = vec![];
    sk_cbor::writer::write(manual_object, &mut manual_data).unwrap();
    let hex_manual_data = hexify(&manual_data);
    let mut macro_data = vec![];
    sk_cbor::writer::write(macro_object, &mut macro_data).unwrap();
    let hex_macro_data = hexify(&macro_data);

    assert_eq!(hex_manual_data, hex_macro_data);

    // Serialized version is in canonical order.
    println!("Serializes to {}", hex_manual_data);
    assert_eq!(
        hex_manual_data,
        concat!(
            "a4",         // 4-map
            "01",         // int(1) =>
            "820203",     // 2-array [2, 3],
            "03",         // int(3) =>
            "f5",         // true,
            "21",         // nint(-2) =>
            "f6",         // null,
            "6474737472", // 4-tstr "tstr" =>
            "43010203"    // 3-bstr
        )
    );

    // Convert back to an object.  This is different than the original object,
    // because the map is now in canonical order.
    let recovered_object = sk_cbor::reader::read(&manual_data).unwrap();
    println!("Deserializes to {:?}", recovered_object);
}

pub fn map(m: Vec<(Value, Value)>) -> Value

Create a CBOR map value.

Keys do not have to be sorted.

Panics

You may not call this function with identical keys in its argument.

Examples found in repository

examples/cbor.rs (lines 35-43)

fn main() {
    // Build a CBOR object with various different types included. Note that this
    // object is not built in canonical order.
    let manual_object = Value::map(vec![
        (
            Value::from(1),
            Value::array(vec![Value::from(2), Value::from(3)]),
        ),
        (Value::from("tstr".to_owned()), Value::from(vec![1, 2, 3])),
        (Value::from(-2), Value::null_value()),
        (Value::from(3), Value::bool_value(true)),
    ]);

    // Build the same object using the crate's convenience macros.
    let macro_object = cbor_map! {
        1 => cbor_array![2, 3],
        "tstr" => cbor_bytes!(vec![1, 2, 3]),
        -2 => cbor_null!(),
        3 => cbor_true!(),
    };

    assert_eq!(manual_object, macro_object);
    println!("Object {:?}", manual_object);

    // Serialize to bytes.
    let mut manual_data = vec![];
    sk_cbor::writer::write(manual_object, &mut manual_data).unwrap();
    let hex_manual_data = hexify(&manual_data);
    let mut macro_data = vec![];
    sk_cbor::writer::write(macro_object, &mut macro_data).unwrap();
    let hex_macro_data = hexify(&macro_data);

    assert_eq!(hex_manual_data, hex_macro_data);

    // Serialized version is in canonical order.
    println!("Serializes to {}", hex_manual_data);
    assert_eq!(
        hex_manual_data,
        concat!(
            "a4",         // 4-map
            "01",         // int(1) =>
            "820203",     // 2-array [2, 3],
            "03",         // int(3) =>
            "f5",         // true,
            "21",         // nint(-2) =>
            "f6",         // null,
            "6474737472", // 4-tstr "tstr" =>
            "43010203"    // 3-bstr
        )
    );

    // Convert back to an object.  This is different than the original object,
    // because the map is now in canonical order.
    let recovered_object = sk_cbor::reader::read(&manual_data).unwrap();
    println!("Deserializes to {:?}", recovered_object);
}

pub fn tag(int: u64, value: Value) -> Value

Create a CBOR tagged value.

pub fn bool_value(b: bool) -> Value

Create a CBOR boolean simple value.

Examples found in repository

examples/cbor.rs (line 42)

fn main() {
    // Build a CBOR object with various different types included. Note that this
    // object is not built in canonical order.
    let manual_object = Value::map(vec![
        (
            Value::from(1),
            Value::array(vec![Value::from(2), Value::from(3)]),
        ),
        (Value::from("tstr".to_owned()), Value::from(vec![1, 2, 3])),
        (Value::from(-2), Value::null_value()),
        (Value::from(3), Value::bool_value(true)),
    ]);

    // Build the same object using the crate's convenience macros.
    let macro_object = cbor_map! {
        1 => cbor_array![2, 3],
        "tstr" => cbor_bytes!(vec![1, 2, 3]),
        -2 => cbor_null!(),
        3 => cbor_true!(),
    };

    assert_eq!(manual_object, macro_object);
    println!("Object {:?}", manual_object);

    // Serialize to bytes.
    let mut manual_data = vec![];
    sk_cbor::writer::write(manual_object, &mut manual_data).unwrap();
    let hex_manual_data = hexify(&manual_data);
    let mut macro_data = vec![];
    sk_cbor::writer::write(macro_object, &mut macro_data).unwrap();
    let hex_macro_data = hexify(&macro_data);

    assert_eq!(hex_manual_data, hex_macro_data);

    // Serialized version is in canonical order.
    println!("Serializes to {}", hex_manual_data);
    assert_eq!(
        hex_manual_data,
        concat!(
            "a4",         // 4-map
            "01",         // int(1) =>
            "820203",     // 2-array [2, 3],
            "03",         // int(3) =>
            "f5",         // true,
            "21",         // nint(-2) =>
            "f6",         // null,
            "6474737472", // 4-tstr "tstr" =>
            "43010203"    // 3-bstr
        )
    );

    // Convert back to an object.  This is different than the original object,
    // because the map is now in canonical order.
    let recovered_object = sk_cbor::reader::read(&manual_data).unwrap();
    println!("Deserializes to {:?}", recovered_object);
}

pub fn null_value() -> Value

Creates a null value.

Examples found in repository

examples/cbor.rs (line 41)

fn main() {
    // Build a CBOR object with various different types included. Note that this
    // object is not built in canonical order.
    let manual_object = Value::map(vec![
        (
            Value::from(1),
            Value::array(vec![Value::from(2), Value::from(3)]),
        ),
        (Value::from("tstr".to_owned()), Value::from(vec![1, 2, 3])),
        (Value::from(-2), Value::null_value()),
        (Value::from(3), Value::bool_value(true)),
    ]);

    // Build the same object using the crate's convenience macros.
    let macro_object = cbor_map! {
        1 => cbor_array![2, 3],
        "tstr" => cbor_bytes!(vec![1, 2, 3]),
        -2 => cbor_null!(),
        3 => cbor_true!(),
    };

    assert_eq!(manual_object, macro_object);
    println!("Object {:?}", manual_object);

    // Serialize to bytes.
    let mut manual_data = vec![];
    sk_cbor::writer::write(manual_object, &mut manual_data).unwrap();
    let hex_manual_data = hexify(&manual_data);
    let mut macro_data = vec![];
    sk_cbor::writer::write(macro_object, &mut macro_data).unwrap();
    let hex_macro_data = hexify(&macro_data);

    assert_eq!(hex_manual_data, hex_macro_data);

    // Serialized version is in canonical order.
    println!("Serializes to {}", hex_manual_data);
    assert_eq!(
        hex_manual_data,
        concat!(
            "a4",         // 4-map
            "01",         // int(1) =>
            "820203",     // 2-array [2, 3],
            "03",         // int(3) =>
            "f5",         // true,
            "21",         // nint(-2) =>
            "f6",         // null,
            "6474737472", // 4-tstr "tstr" =>
            "43010203"    // 3-bstr
        )
    );

    // Convert back to an object.  This is different than the original object,
    // because the map is now in canonical order.
    let recovered_object = sk_cbor::reader::read(&manual_data).unwrap();
    println!("Deserializes to {:?}", recovered_object);
}

pub fn undefined() -> Value

Creates an undefined value.

pub fn extract_unsigned(self) -> Option<u64>

pub fn extract_integer(self) -> Option<i64>

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

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

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

pub fn extract_map(self) -> Option<Vec<(Value, Value)>>

pub fn extract_tag(self) -> Option<(u64, Value)>

pub fn extract_bool(self) -> Option<bool>

pub fn extract_null(self) -> Option<()>

pub fn extract_undefined(self) -> Option<()>

Trait Implementations

impl Clone for Value

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 Value

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

Formats the value using the given formatter.

impl Eq for Value

impl From<&[u8; 0]> for Value

fn from(bytes: &[u8; 0]) -> Self

Converts to this type from the input type.

impl From<&[u8]> for Value

fn from(bytes: &[u8]) -> Self

Converts to this type from the input type.

impl From<&str> for Value

fn from(text: &str) -> Self

Converts to this type from the input type.

impl From<String> for Value

fn from(text: String) -> Self

Converts to this type from the input type.

impl From<Vec<(Value, Value)>> for Value

fn from(map: Vec<(Value, Value)>) -> Self

Converts to this type from the input type.

impl From<Vec<Value>> for Value

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

Converts to this type from the input type.

impl From<Vec<u8>> for Value

fn from(bytes: Vec<u8>) -> Self

Converts to this type from the input type.

impl From<bool> for Value

fn from(b: bool) -> Self

Converts to this type from the input type.

impl From<i8> for Value

fn from(i: i8) -> Self

Converts to this type from the input type.

impl From<i16> for Value

fn from(i: i16) -> Self

Converts to this type from the input type.

impl From<i32> for Value

fn from(i: i32) -> Self

Converts to this type from the input type.

impl From<i64> for Value

fn from(i: i64) -> Self

Converts to this type from the input type.

impl From<u8> for Value

fn from(u: u8) -> Self

Converts to this type from the input type.

impl From<u16> for Value

fn from(u: u16) -> Self

Converts to this type from the input type.

impl From<u32> for Value

fn from(u: u32) -> Self

Converts to this type from the input type.

impl From<u64> for Value

fn from(u: u64) -> Self

Converts to this type from the input type.

impl Ord for Value

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Value

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Value

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Value