Enum sentry_contrib_native::Value

pub enum Value {
    Null,
    Bool(bool),
    Int(i32),
    Double(f64),
    String(String),
    List(Vec<Value>),
    Map(BTreeMap<String, Value>),
}

Represents a Sentry protocol value.

Examples

assert!(Value::new(()).is_null());
assert!(Value::new(true).is_bool());
assert!(Value::new(10).is_int());
assert!(Value::new(10.).is_double());
assert!(Value::new("test").is_string());
assert!(Value::new(vec!["test 1", "test 2"]).is_list());
assert!(Value::new(vec![("test key 1", "test 1"), ("test key 2", "test 2")]).is_map());

Variants

Null

Null value.

Bool(bool)

Boolean.

Int(i32)

Integer.

Double(f64)

Double.

String(String)

String.

List(Vec<Value>)

List.

Map(BTreeMap<String, Value>)

Map.

Implementations

impl Value

pub fn new<V: Into<Self>>(value: V) -> Self

Creates a new Sentry value.

Examples

let value = Value::new("test");

pub const fn is_null(&self) -> bool

Returns true if self is Value::Null.

Examples

assert!(Value::new(()).is_null());

pub const fn as_null(&self) -> Option<()>

Returns Some if self is Value::Null.

Examples

assert_eq!(Some(()), Value::new(()).as_null());

pub fn into_null(self) -> Result<(), Error>

Returns Ok if self is Value::Null.

Errors

Fails with Error::TryConvert if self isn’t a Value::Null;

Examples

assert_eq!(Ok(()), Value::new(()).into_null());
assert_eq!(
    Err(Error::TryConvert(Value::new(false))),
    Value::new(false).into_null()
);

pub const fn is_bool(&self) -> bool

Returns true if self is Value::Bool.

Examples

assert!(Value::new(true).is_bool());

pub const fn as_bool(&self) -> Option<bool>

Returns Some with the inner value if self is Value::Bool.

Examples

assert_eq!(Some(true), Value::new(true).as_bool());

pub fn as_mut_bool(&mut self) -> Option<&mut bool>

Returns Some with the inner value if self is Value::Bool.

Examples

let mut value = Value::new(true);
value.as_mut_bool().map(|value| *value = false);

assert_eq!(Some(false), value.as_bool());

pub fn into_bool(self) -> Result<bool, Error>

Returns Ok with the inner value if self is Value::Bool.

Errors

Fails with Error::TryConvert if self isn’t a Value::Bool;

Examples

assert_eq!(Ok(true), Value::new(true).into_bool());
assert_eq!(
    Err(Error::TryConvert(Value::new(()))),
    Value::new(()).into_bool()
);

pub const fn is_int(&self) -> bool

Returns true if self is Value::Int.

Examples

assert!(Value::new(10).is_int());

pub const fn as_int(&self) -> Option<i32>

Returns Some with the inner value if self is Value::Int.

Examples

assert_eq!(Some(10), Value::new(10).as_int());

pub fn as_mut_int(&mut self) -> Option<&mut i32>

Returns Some with the inner value if self is Value::Int.

Examples

let mut value = Value::new(10);
value.as_mut_int().map(|value| *value = 5);

assert_eq!(Some(5), value.as_int());

pub fn into_int(self) -> Result<i32, Error>

Returns Ok with the inner value if self is Value::Int.

Errors

Fails with Error::TryConvert if self isn’t a Value::Int;

Examples

assert_eq!(Ok(10), Value::new(10).into_int());
assert_eq!(
    Err(Error::TryConvert(Value::new(false))),
    Value::new(false).into_int()
);

pub const fn is_double(&self) -> bool

Returns true if self is Value::Double.

Examples

assert!(Value::new(10.).is_double());

pub const fn as_double(&self) -> Option<f64>

Returns Some with the inner value if self is Value::Double.

Examples

assert_eq!(Some(10.), Value::new(10.).as_double());

pub fn as_mut_double(&mut self) -> Option<&mut f64>

Returns Some with the inner value if self is Value::Double.

Examples

let mut value = Value::new(10.);
value.as_mut_double().map(|value| *value = 5.);

assert_eq!(Some(5.), value.as_double());

pub fn into_double(self) -> Result<f64, Error>

Returns Ok with the inner value if self is Value::Double.

Errors

Fails with Error::TryConvert if self isn’t a Value::Double;

Examples

assert_eq!(Ok(10.), Value::new(10.).into_double());
assert_eq!(
    Err(Error::TryConvert(Value::new(false))),
    Value::new(false).into_double()
);

pub const fn is_string(&self) -> bool

Returns true if self is Value::String.

Examples

assert!(Value::new("test").is_string());

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

Returns Some with the inner value if self is Value::String.

Examples

assert_eq!(Some("test"), Value::new("test").as_str());

pub fn as_mut_str(&mut self) -> Option<&mut str>

Returns Some with the inner value if self is Value::String.

Examples

let mut value = Value::new("test");
value
    .as_mut_str()
    .map(|value| value.get_mut(0..1).unwrap().make_ascii_uppercase());

assert_eq!(Some("Test"), value.as_str());

pub fn into_string(self) -> Result<String, Error>

Returns Ok with the inner value if self is Value::String.

Errors

Fails with Error::TryConvert if self isn’t a Value::String;

Examples

assert_eq!(Ok(String::from("test")), Value::new("test").into_string());
assert_eq!(
    Err(Error::TryConvert(Value::new(false))),
    Value::new(false).into_string()
);

pub const fn is_list(&self) -> bool

Returns true if self is Value::List.

Examples

assert!(Value::new(vec!["test 1", "test 2"]).is_list());

pub const fn as_list(&self) -> Option<&Vec<Self>>

Returns Some with the inner value if self is Value::List.

Examples

assert_eq!(
    Some(&vec!["test 1".into(), "test 2".into()]),
    Value::new(vec!["test 1", "test 2"]).as_list()
);

pub fn as_mut_list(&mut self) -> Option<&mut Vec<Self>>

Returns Some with the inner value if self is Value::List.

Examples

let mut value = Value::new(vec!["test 1", "test 2"]);
value.as_mut_list().map(|value| value[0] = "test 3".into());

assert_eq!(Some("test 3"), value.into_list()?[0].as_str());

pub fn into_list(self) -> Result<Vec<Self>, Error>

Returns Ok with the inner value if self is Value::List.

Errors

Fails with Error::TryConvert if self isn’t a Value::List;

Examples

assert_eq!(
    Ok(vec!["test 1".into(), "test 2".into()]),
    Value::new(vec!["test 1", "test 2"]).into_list()
);
assert_eq!(
    Err(Error::TryConvert(Value::new(false))),
    Value::new(false).into_list()
);

pub const fn is_map(&self) -> bool

Returns true if self is Value::Map.

Examples

assert!(Value::new(vec![("test key 1", "test 1"), ("test key 2", "test 2")]).is_map());

pub const fn as_map(&self) -> Option<&BTreeMap<String, Self>>

Returns Some with the inner value if self is Value::Map.

Examples

assert_eq!(
    Some(&BTreeMap::from_iter(vec![
        ("test key 1".into(), "test 1".into()),
        ("test key 2".into(), "test 2".into())
    ])),
    Value::new(vec![("test key 1", "test 1"), ("test key 2", "test 2")]).as_map()
);

pub fn as_mut_map(&mut self) -> Option<&mut BTreeMap<String, Self>>

Returns Some with the inner value if self is Value::Map.

Examples

let mut value = Value::new(vec![("test key 1", false), ("test key 2", false)]);
value
    .as_mut_map()
    .and_then(|value| value.get_mut("test key 1"))
    .and_then(|value| value.as_mut_bool())
    .map(|value| *value = true);

assert_eq!(Some(true), value.into_map()?["test key 1"].as_bool());

pub fn into_map(self) -> Result<BTreeMap<String, Self>, Error>

Returns Ok with the inner value if self is Value::Map.

Errors

Fails with Error::TryConvert if self isn’t a Value::Map;

Examples

assert_eq!(
    Ok(BTreeMap::from_iter(vec![
        ("test key 1".into(), "test 1".into()),
        ("test key 2".into(), "test 2".into())
    ])),
    Value::new(vec![("test key 1", "test 1"), ("test key 2", "test 2")]).into_map()
);
assert_eq!(
    Err(Error::TryConvert(Value::new(false))),
    Value::new(false).into_map()
);

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 Default for Value

fn default() -> Self

Returns the “default value” for a type.

impl<V: Into<Self> + Copy> From<&'_ V> for Value

fn from(value: &V) -> Self

Converts to this type from the input type.

impl From<&'_ str> for Value

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<()> for Value

fn from(_: ()) -> Self

Converts to this type from the input type.

impl<K: Into<String>, V: Into<Self>> From<BTreeMap<K, V>> for Value

fn from(value: BTreeMap<K, V>) -> Self

Converts to this type from the input type.

impl From<String> for Value

fn from(value: String) -> Self

Converts to this type from the input type.

impl<K: Into<String>, V: Into<Self>> From<Vec<(K, V), Global>> for Value

fn from(value: Vec<(K, V)>) -> Self

Converts to this type from the input type.

impl<V: Into<Self>> From<Vec<V, Global>> for Value

fn from(value: Vec<V>) -> Self

Converts to this type from the input type.

impl From<bool> for Value

fn from(value: bool) -> Self

Converts to this type from the input type.

impl From<f32> for Value

fn from(value: f32) -> Self

Converts to this type from the input type.

impl From<f64> for Value

fn from(value: f64) -> Self

Converts to this type from the input type.

impl From<i16> for Value

fn from(value: i16) -> Self

Converts to this type from the input type.

impl From<i32> for Value

fn from(value: i32) -> Self

Converts to this type from the input type.

impl From<i8> for Value

fn from(value: i8) -> Self

Converts to this type from the input type.

impl From<u16> for Value

fn from(value: u16) -> Self

Converts to this type from the input type.

impl From<u8> for Value

fn from(value: u8) -> Self

Converts to this type from the input type.

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 PartialOrd<Value> for Value

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl TryFrom<Value> for ()

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Error>

Performs the conversion.

impl TryFrom<Value> for bool

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Error>

Performs the conversion.

impl TryFrom<Value> for i32

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Error>

Performs the conversion.

impl TryFrom<Value> for f64

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Error>

Performs the conversion.

impl TryFrom<Value> for String

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Error>

Performs the conversion.

impl TryFrom<Value> for Vec<Value>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Error>

Performs the conversion.

impl TryFrom<Value> for BTreeMap<String, Value>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Error>

Performs the conversion.

impl StructuralPartialEq for Value