Struct Value

Source

pub struct Value { /* private fields */ }

Expand description

A generic value capable of carrying various types.

Once created the type of the value can’t be changed.

Some types (e.g. String and objects) support None values while others (e.g. numeric types) don’t.

Value does not implement the Send trait, but SendValue can be used instead.

See the module documentation for more details.

GLib type: Inline allocated boxed type with stack copy semantics.

Implementations§

Source §

impl Value

Source

pub fn as_ptr(&self) -> *mut GValue

Source

pub unsafe fn from_glib_ptr_borrow<'a>(ptr: *const GValue) -> &'a Self

Borrows the underlying C value.

Source

pub unsafe fn from_glib_ptr_borrow_mut<'a>(ptr: *mut GValue) -> &'a mut Self

Borrows the underlying C value mutably.

Source §

impl Value

Source

pub fn from_type(type_: Type) -> Self

Creates a new Value that is initialized with type_.

§Panics

If type_ can’t be stored in a Value this function panics.

Source

pub unsafe fn from_type_unchecked(type_: Type) -> Self

Creates a new Value that is initialized with type_.

§SAFETY

This must be called with a valid type_ that can be stored in Values.

Source

pub fn for_value_type<T: ValueType>() -> Self

Creates a new Value that is initialized for a given ValueType.

Source

pub fn from_static_str(s: &'static GStr) -> Self

Creates a new String-typed Value from a 'static string.

Source

pub fn from_interned_str(s: &'static GStr) -> Self

Available on crate feature v2_66 only.

Creates a new String-typed Value from a 'static string that is also assumed to be interned.

Source

pub fn get<'a, T>( &'a self, ) -> Result<T, <<T as FromValue<'_>>::Checker as ValueTypeChecker>::Error>
where T: FromValue<'a>,

Tries to get a value of type T.

Returns Ok if the type is correct.

Source

pub fn get_owned<T>( &self, ) -> Result<T, <<T as FromValue<'_>>::Checker as ValueTypeChecker>::Error>
where T: for<'b> FromValue<'b> + 'static,

Tries to get a value of an owned type T.

Source

pub fn is<T: StaticType>(&self) -> bool

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

Source

pub fn is_type(&self, type_: Type) -> bool

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

Source

pub fn type_(&self) -> Type

Returns the type of the value.

Source

pub fn type_transformable(src: Type, dst: Type) -> bool

Returns whether Values of type src can be transformed to type dst.

Source

pub fn transform<T: ValueType>(&self) -> Result<Value, BoolError>

Tries to transform the value into a value of the target type

Source

pub fn transform_with_type(&self, type_: Type) -> Result<Value, BoolError>

Tries to transform the value into a value of the target type

Source

pub fn into_raw(self) -> GValue

Consumes Value and returns the corresponding GValue.

Source

pub fn try_into_send_value<T: Send + StaticType>( self, ) -> Result<SendValue, Self>

Converts a Value into a SendValue. This fails if self does not store a value of type T. It is required for T to be Send to call this function.

Source

pub unsafe fn into_send_value(self) -> SendValue

Converts a Value into a SendValue.

§Safety

The type of the value contained in self must be Send.

Trait Implementations§

Source §

impl Clone for Value

Source §

fn clone(&self) -> Self

Copies the inline boxed type by value with the type-specific copy function.

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<(), Error>

Formats the value using the given formatter. Read more

Source §

impl Drop for Value

Source §

fn drop(&mut self)

Executes the destructor for this type. Read more

Source §

impl Extend<Value> for ValueArray

Source §

fn extend<T: IntoIterator<Item = Value>>(&mut self, iter: T)

Extends a collection with the contents of an iterator. Read more

Source §

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

Source §

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements. Read more

Source §