Struct TypedValue

#[repr(C)]
pub struct TypedValue<T>(/* private fields */);

A statically typed Value.

It dereferences to Value and can be used everywhere Value references are accepted.

See the module documentation for more details.

Implementations

impl<'a, T: FromValueOptional<'a> + SetValue> TypedValue<T>

pub fn get(&'a self) -> Option<T>

Returns the value.

Types that don’t support a None value always return Some. See get_some.

pub fn get_some(&'a self) -> T

where T: FromValue<'a>,

Returns the value.

This method is only available for types that don’t support a None value.

pub fn set<U: ?Sized + SetValueOptional>(&mut self, value: Option<&U>)

where T: Borrow<U>,

Sets the value.

This method is only available for types that support a None value.

pub fn set_none(&mut self)

where T: SetValueOptional,

Sets the value to None.

This method is only available for types that support a None value.

pub fn set_some<U: ?Sized + SetValue>(&mut self, value: &U)

where T: Borrow<U>,

Sets the value.

impl<'a, T: FromValueOptional<'a> + SetValue + Send> TypedValue<T>

pub fn into_send_value(self) -> SendValue

Methods from Deref<Target = Value>

pub fn downcast_ref<'a, T: FromValueOptional<'a> + SetValue>( &self, ) -> Option<&TypedValue<T>>

Tries to downcast to a &TypedValue.

Returns Some(&TypedValue<T>) if the value carries a type corresponding to T and None otherwise.

pub fn get<'a, T: FromValueOptional<'a>>(&'a self) -> Option<T>

Tries to get a value of type T.

Returns Some if the type is correct and the value is not None.

This function doesn’t distinguish between type mismatches and correctly typed None values. Use downcast or is for that.

pub fn is<'a, T: FromValueOptional<'a> + SetValue>(&self) -> bool

Returns true if the type of the value corresponds to T or is a sub-type of T.

pub fn type_(&self) -> Type

Returns the type of the value.

Trait Implementations

impl<T: Clone> Clone for TypedValue<T>

fn clone(&self) -> TypedValue<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for TypedValue<T>

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

Formats the value using the given formatter.

impl<'a, T: FromValueOptional<'a> + SetValue> From<&'a T> for TypedValue<T>

fn from(value: &'a T) -> Self

Converts to this type from the input type.

impl<'a> From<&'a str> for TypedValue<String>

fn from(value: &'a str) -> Self

Converts to this type from the input type.

impl<'a, T: FromValueOptional<'a> + SetValueOptional> From<Option<&'a T>> for TypedValue<T>

fn from(value: Option<&'a T>) -> Self

Converts to this type from the input type.

impl<'a> From<Option<&'a str>> for TypedValue<String>

fn from(value: Option<&'a str>) -> Self

Converts to this type from the input type.

impl<'a> From<TypedValue<&'a str>> for TypedValue<String>

fn from(value: TypedValue<&str>) -> Self

Converts to this type from the input type.

impl<'a> From<TypedValue<String>> for TypedValue<&'a str>

fn from(value: TypedValue<String>) -> Self

Converts to this type from the input type.

impl<T: Send> From<TypedValue<T>> for SendValue

fn from(value: TypedValue<T>) -> Self

Converts to this type from the input type.

impl<T> From<TypedValue<T>> for Value

fn from(value: TypedValue<T>) -> Self

Converts to this type from the input type.

impl<T> Deref for TypedValue<T>

type Target = Value

The resulting type after dereferencing.

fn deref(&self) -> &Value

Dereferences the value.