Struct simics::api::base::attr_value::AttrValue

#[repr(C)]
pub struct AttrValue(attr_value_t);

Owned attribute value

Tuple Fields

0: attr_value_t

Implementations

impl AttrValue

pub fn nil() -> Self

Construct a nil AttrValue

pub fn invalid() -> Self

Construct an intentionally invalid AttrValue

pub fn signed(s: i64) -> Self

Construct a signed AttrValue

pub fn unsigned(u: u64) -> Self

Construct an unsigned AttrValue

pub fn boolean(b: bool) -> Self

Construct a boolean AttrValue

pub fn string(s: &str) -> Result<Self>

Construct a string AttrValue

pub fn string_unchecked(s: &str) -> Self

Construct a string AttrValue without checking for null bytes in the input string. This method will panic if s contains a null byte, but is used to simplify some APIs to avoid requiring a Result type.

pub fn floating(f: f64) -> Self

Construct a floating AttrValue

pub fn object(o: *mut ConfObject) -> Self

Construct an object AttrValue

pub fn data<T>(d: T) -> Self

where T: Into<Box<[u8]>>,

Construct a data AttrValue

pub fn list(length: usize) -> Result<Self>

Construct an empty AttrValue list of a certain length. This should typically not be used, a Vec<T> where T: TryInto<AttrValue> can be converted to an AttrValue with try_into.

pub fn dict(size: usize) -> Result<Self>

Construct an empty AttrValue dict of a certain size. This should typically not be used, a BTreeMap<T, U> where T: TryInto<AttrValue>, U: TryInto<AttrValue> can be converted to an AttrValue with try_into.

impl AttrValue

pub fn as_ptr(&self) -> *const attr_value_t

Get a constant pointer to the inner attr value

pub fn as_mut_ptr(&mut self) -> *mut attr_value_t

Get a mutable pointer to the inner attr value

pub fn kind(&self) -> AttrKind

Get the kind of the attr value

pub fn size(&self) -> u32

Get the size of the attr value. This is only non-zero in cases where the value is a collection (list, dict) or data type

pub fn is_invalid(&self) -> bool

Get whether the value is invalid type

pub fn is_nil(&self) -> bool

Get whether the value is nil type

pub fn is_integer(&self) -> bool

Get whether the value is integer type

pub fn is_unsigned(&self) -> bool

Get whether the value is unsigned integer type

pub fn is_signed(&self) -> bool

Get whether the value is unsigned integer type

pub fn is_boolean(&self) -> bool

Get whether the value is boolean type

pub fn is_string(&self) -> bool

Get whether the value is string type

pub fn is_floating(&self) -> bool

Get whether the value is floating type

pub fn is_object(&self) -> bool

Get whether the value is object type

pub fn is_data(&self) -> bool

Get whether the value is data type

pub fn is_list(&self) -> bool

Get whether the value is list type

pub fn is_dict(&self) -> bool

Get whether the value is dict type

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

Get the value as an integer, if it is one, or None otherwise.

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

Get the value as an unsigned integer, if it is one, or None otherwise.

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

Get the value as a signed integer, if it is one, or None otherwise.

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

Get the value as a boolean, if it is one, or None otherwise.

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

Get the value as a string, if it is one, or None otherwise.

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

Get the value as a float, if it is one, or None otherwise.

pub fn as_object(&self) -> Option<*mut ConfObject>

Get the value as a ConfObject, if it is one, or None otherwise.

pub fn as_data<T>(&self) -> Option<T>

where T: Clone,

Get the value as data, if it is one, or None otherwise. Data is copied, the AttrValue maintains ownership.

pub fn as_list_checked<T>(&self) -> Result<Option<Vec<T>>>

where T: TryFrom<AttrValue> + Clone, Error: From<<T as TryFrom<AttrValue>>::Error>,

Get the value as a list, if it is one, or None otherwise. Data is copied, the AttrValue maintains ownership. Use as_list if you

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

where T: TryFrom<AttrValue> + Clone, Error: From<<T as TryFrom<AttrValue>>::Error>,

Get the value as a list, if it is one, or None otherwise. Data is copied, the AttrValue maintains ownership. Use as_list if you

pub fn as_heterogeneous_list(&self) -> Option<Vec<AttrValueType>>

Get the value as a list, if it is one, or None otherwise. Data is copied, the AttrValue maintains ownership.

pub fn as_dict_checked<T, U>(&self) -> Result<Option<BTreeMap<T, U>>>

where T: TryFrom<AttrValue> + Ord, U: TryFrom<AttrValue>, Error: From<<T as TryFrom<AttrValue>>::Error> + From<<U as TryFrom<AttrValue>>::Error>,

Get the value as a dict, if it is one, or None otherwise. Data is copied, the AttrValue maintains ownership.

pub fn as_dict<T, U>(&self) -> Option<BTreeMap<T, U>>

where T: TryFrom<AttrValue> + Ord, U: TryFrom<AttrValue>, Error: From<<T as TryFrom<AttrValue>>::Error> + From<<U as TryFrom<AttrValue>>::Error>,

Get the value as a dict, if it is one, or None otherwise. Data is copied, the AttrValue maintains ownership.

pub fn as_heterogeneous_dict( &self, ) -> Result<Option<BTreeMap<AttrValueType, AttrValueType>>>

Get the value as a dict, if it is one, or None otherwise. Data is copied, the AttrValue maintains ownership.

Trait Implementations

impl Clone for AttrValue

fn clone(&self) -> AttrValue

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AttrValue

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

Formats the value using the given formatter.

impl From<&OrderedFloat<f32>> for AttrValue

fn from(value: &OrderedFloat<f32>) -> Self

Converts to this type from the input type.

impl From<&OrderedFloat<f64>> for AttrValue

fn from(value: &OrderedFloat<f64>) -> Self

Converts to this type from the input type.

impl From<&f32> for AttrValue

fn from(value: &f32) -> AttrValue

Converts to this type from the input type.

impl From<&i16> for AttrValue

fn from(value: &i16) -> AttrValue

Converts to this type from the input type.

impl From<&i32> for AttrValue

fn from(value: &i32) -> AttrValue

Converts to this type from the input type.

impl From<&i8> for AttrValue

fn from(value: &i8) -> AttrValue

Converts to this type from the input type.

impl From<&isize> for AttrValue

fn from(value: &isize) -> AttrValue

Converts to this type from the input type.

impl From<&str> for AttrValue

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<&u16> for AttrValue

fn from(value: &u16) -> AttrValue

Converts to this type from the input type.

impl From<&u32> for AttrValue

fn from(value: &u32) -> AttrValue

Converts to this type from the input type.

impl From<&u8> for AttrValue

fn from(value: &u8) -> AttrValue

Converts to this type from the input type.

impl From<&usize> for AttrValue

fn from(value: &usize) -> AttrValue

Converts to this type from the input type.

impl From<*mut conf_object> for AttrValue

fn from(value: *mut ConfObject) -> Self

Converts to this type from the input type.

impl From<AttrValue> for AttrValueType

fn from(value: AttrValue) -> Self

Converts to this type from the input type.

impl From<AttrValue> for attr_value_t

fn from(value: AttrValue) -> Self

Converts to this type from the input type.

impl From<AttrValueType> for AttrValue

fn from(value: AttrValueType) -> Self

Converts to this type from the input type.

impl From<OrderedFloat<f32>> for AttrValue

fn from(value: OrderedFloat<f32>) -> Self

Converts to this type from the input type.

impl From<OrderedFloat<f64>> for AttrValue

fn from(value: OrderedFloat<f64>) -> Self

Converts to this type from the input type.

impl From<String> for AttrValue

fn from(value: String) -> Self

Converts to this type from the input type.

impl From<attr_value> for AttrValue

fn from(value: attr_value_t) -> Self

Converts to this type from the input type.

impl From<bool> for AttrValue

fn from(value: bool) -> Self

Converts to this type from the input type.

impl From<f32> for AttrValue

fn from(value: f32) -> AttrValue

Converts to this type from the input type.

impl From<f64> for AttrValue

fn from(value: f64) -> Self

Converts to this type from the input type.

impl From<i16> for AttrValue

fn from(value: i16) -> AttrValue

Converts to this type from the input type.

impl From<i32> for AttrValue

fn from(value: i32) -> AttrValue

Converts to this type from the input type.

impl From<i64> for AttrValue

fn from(value: i64) -> Self

Converts to this type from the input type.

impl From<i8> for AttrValue

fn from(value: i8) -> AttrValue

Converts to this type from the input type.

impl From<isize> for AttrValue

fn from(value: isize) -> AttrValue

Converts to this type from the input type.

impl From<u16> for AttrValue

fn from(value: u16) -> AttrValue

Converts to this type from the input type.

impl From<u32> for AttrValue

fn from(value: u32) -> AttrValue

Converts to this type from the input type.

impl From<u64> for AttrValue

fn from(value: u64) -> Self

Converts to this type from the input type.

impl From<u8> for AttrValue

fn from(value: u8) -> AttrValue

Converts to this type from the input type.

impl From<usize> for AttrValue

fn from(value: usize) -> AttrValue

Converts to this type from the input type.

impl<T, U> TryFrom<&[(T, U)]> for AttrValue

where T: TryInto<AttrValue> + Clone, U: TryInto<AttrValue> + Clone, Error: From<<T as TryInto<AttrValue>>::Error> + From<<U as TryInto<AttrValue>>::Error>,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &[(T, U)]) -> Result<Self>

Performs the conversion.

impl<T> TryFrom<&[T]> for AttrValue

where T: TryInto<AttrValue> + Clone, Error: From<<T as TryInto<AttrValue>>::Error>,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &[T]) -> Result<Self>

Performs the conversion.

impl<T, U> TryFrom<AttrValue> for BTreeMap<T, U>

where T: TryFrom<AttrValue> + Ord, U: TryFrom<AttrValue>, Error: From<<T as TryFrom<AttrValue>>::Error> + From<<U as TryFrom<AttrValue>>::Error>,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: AttrValue) -> Result<Self>

Performs the conversion.

impl<T> TryFrom<AttrValue> for BTreeSet<T>

where T: TryFrom<AttrValue> + Ord + Clone, Error: From<<T as TryFrom<AttrValue>>::Error>,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: AttrValue) -> Result<Self>

Performs the conversion.

impl<T, U> TryFrom<AttrValue> for HashMap<T, U>

where T: TryFrom<AttrValue> + Eq + Hash + Ord, U: TryFrom<AttrValue>, Error: From<<T as TryFrom<AttrValue>>::Error> + From<<U as TryFrom<AttrValue>>::Error>,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: AttrValue) -> Result<Self>

Performs the conversion.

impl<T> TryFrom<AttrValue> for HashSet<T>

where T: TryFrom<AttrValue> + Eq + Hash + Clone, Error: From<<T as TryFrom<AttrValue>>::Error>,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: AttrValue) -> Result<Self>

Performs the conversion.

impl<T, U> TryFrom<AttrValue> for Option<BTreeMap<T, U>>

where T: TryFrom<AttrValue> + Ord, U: TryFrom<AttrValue>, Error: From<<T as TryFrom<AttrValue>>::Error> + From<<U as TryFrom<AttrValue>>::Error>,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: AttrValue) -> Result<Self>

Performs the conversion.

impl<T> TryFrom<AttrValue> for Option<BTreeSet<T>>

where T: TryFrom<AttrValue> + Ord + Clone, Error: From<<T as TryFrom<AttrValue>>::Error>,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: AttrValue) -> Result<Self>

Performs the conversion.

impl<T, U> TryFrom<AttrValue> for Option<HashMap<T, U>>

where T: TryFrom<AttrValue> + Eq + Hash + Ord, U: TryFrom<AttrValue>, Error: From<<T as TryFrom<AttrValue>>::Error> + From<<U as TryFrom<AttrValue>>::Error>,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: AttrValue) -> Result<Self>

Performs the conversion.

impl<T> TryFrom<AttrValue> for Option<HashSet<T>>

where T: TryFrom<AttrValue> + Eq + Hash + Clone, Error: From<<T as TryFrom<AttrValue>>::Error>,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: AttrValue) -> Result<Self>

Performs the conversion.

impl TryFrom<AttrValue> for Option<String>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: AttrValue) -> Result<Self>

Performs the conversion.

impl<T> TryFrom<AttrValue> for Option<Vec<T>>

where T: TryFrom<AttrValue> + Clone, Error: From<<T as TryFrom<AttrValue>>::Error>,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: AttrValue) -> Result<Self>

Performs the conversion.

impl TryFrom<AttrValue> for Option<bool>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: AttrValue) -> Result<Self>

Performs the conversion.

impl TryFrom<AttrValue> for Option<f32>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: AttrValue) -> Result<Self>

Performs the conversion.

impl TryFrom<AttrValue> for Option<f64>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: AttrValue) -> Result<Self>

Performs the conversion.

impl TryFrom<AttrValue> for Option<i16>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: AttrValue) -> Result<Self>

Performs the conversion.

impl TryFrom<AttrValue> for Option<i32>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: AttrValue) -> Result<Self>

Performs the conversion.

impl TryFrom<AttrValue> for Option<i64>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: AttrValue) -> Result<Self>

Performs the conversion.

impl TryFrom<AttrValue> for Option<i8>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: AttrValue) -> Result<Self>

Performs the conversion.

impl TryFrom<AttrValue> for Option<isize>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: AttrValue) -> Result<Self>

Performs the conversion.

impl TryFrom<AttrValue> for Option<u16>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: AttrValue) -> Result<Self>

Performs the conversion.

impl TryFrom<AttrValue> for Option<u32>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: AttrValue) -> Result<Self>

Performs the conversion.

impl TryFrom<AttrValue> for Option<u64>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: AttrValue) -> Result<Self>

Performs the conversion.

impl TryFrom<AttrValue> for Option<u8>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: AttrValue) -> Result<Self>

Performs the conversion.

impl TryFrom<AttrValue> for Option<usize>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: AttrValue) -> Result<Self>

Performs the conversion.

impl TryFrom<AttrValue> for PathBuf

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: AttrValue) -> Result<Self>

Performs the conversion.

impl TryFrom<AttrValue> for String

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: AttrValue) -> Result<Self>

Performs the conversion.

impl<T> TryFrom<AttrValue> for Vec<T>

where T: TryFrom<AttrValue> + Clone, Error: From<<T as TryFrom<AttrValue>>::Error>,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: AttrValue) -> Result<Self>

Performs the conversion.

impl TryFrom<AttrValue> for bool

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: AttrValue) -> Result<Self>

Performs the conversion.

impl TryFrom<AttrValue> for f32

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: AttrValue) -> Result<Self>

Performs the conversion.

impl TryFrom<AttrValue> for f64

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: AttrValue) -> Result<Self>

Performs the conversion.

impl TryFrom<AttrValue> for i16

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: AttrValue) -> Result<Self>

Performs the conversion.

impl TryFrom<AttrValue> for i32

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: AttrValue) -> Result<Self>

Performs the conversion.

impl TryFrom<AttrValue> for i64

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: AttrValue) -> Result<Self>

Performs the conversion.

impl TryFrom<AttrValue> for i8

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: AttrValue) -> Result<Self>

Performs the conversion.

impl TryFrom<AttrValue> for isize

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: AttrValue) -> Result<Self>

Performs the conversion.

impl TryFrom<AttrValue> for u16

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: AttrValue) -> Result<Self>

Performs the conversion.

impl TryFrom<AttrValue> for u32

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: AttrValue) -> Result<Self>

Performs the conversion.

impl TryFrom<AttrValue> for u64

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: AttrValue) -> Result<Self>

Performs the conversion.

impl TryFrom<AttrValue> for u8

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: AttrValue) -> Result<Self>

Performs the conversion.

impl TryFrom<AttrValue> for usize

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: AttrValue) -> Result<Self>

Performs the conversion.

impl<T, U> TryFrom<BTreeMap<T, U>> for AttrValue

where T: TryInto<AttrValue>, U: TryInto<AttrValue>, Error: From<<T as TryInto<AttrValue>>::Error> + From<<U as TryInto<AttrValue>>::Error>,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: BTreeMap<T, U>) -> Result<Self>

Performs the conversion.

impl<T, U> TryFrom<BTreeSet<(T, U)>> for AttrValue

where T: TryInto<AttrValue>, U: TryInto<AttrValue>, Error: From<<T as TryInto<AttrValue>>::Error> + From<<U as TryInto<AttrValue>>::Error>,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: BTreeSet<(T, U)>) -> Result<Self>

Performs the conversion.

impl<T> TryFrom<BTreeSet<T>> for AttrValue

where T: TryInto<AttrValue>, Error: From<<T as TryInto<AttrValue>>::Error>,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: BTreeSet<T>) -> Result<Self>

Performs the conversion.

impl<T, U> TryFrom<HashMap<T, U>> for AttrValue

where T: TryInto<AttrValue>, U: TryInto<AttrValue>, Error: From<<T as TryInto<AttrValue>>::Error> + From<<U as TryInto<AttrValue>>::Error>,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: HashMap<T, U>) -> Result<Self>

Performs the conversion.

impl<T, U> TryFrom<HashSet<(T, U)>> for AttrValue

where T: TryInto<AttrValue>, U: TryInto<AttrValue>, Error: From<<T as TryInto<AttrValue>>::Error> + From<<U as TryInto<AttrValue>>::Error>,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: HashSet<(T, U)>) -> Result<Self>

Performs the conversion.

impl<T> TryFrom<HashSet<T>> for AttrValue

where T: TryInto<AttrValue>, Error: From<<T as TryInto<AttrValue>>::Error>,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: HashSet<T>) -> Result<Self>

Performs the conversion.

impl<T> TryFrom<Option<T>> for AttrValue

where T: TryInto<AttrValue>, Error: From<<T as TryInto<AttrValue>>::Error>,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Option<T>) -> Result<Self>

Performs the conversion.

impl TryFrom<PathBuf> for AttrValue

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: PathBuf) -> Result<Self>

Performs the conversion.

impl<T, U> TryFrom<Vec<(T, U)>> for AttrValue

where T: TryInto<AttrValue>, U: TryInto<AttrValue>, Error: From<<T as TryInto<AttrValue>>::Error> + From<<U as TryInto<AttrValue>>::Error>,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Vec<(T, U)>) -> Result<Self>

Performs the conversion.

impl<T> TryFrom<Vec<T>> for AttrValue

where T: TryInto<AttrValue>, Error: From<<T as TryInto<AttrValue>>::Error>,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Vec<T>) -> Result<Self>

Performs the conversion.

impl Copy for AttrValue

impl Send for AttrValue

impl Sync for AttrValue