Struct glib::value::Value

pub struct Value { /* private fields */ }

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. An opaque structure used to hold different types of values.

The data within the structure has protected scope: it is accessible only to functions within a GTypeValueTable structure, or implementations of the g_value_*() API. That is, code portions which implement new fundamental types.

Value users cannot make any assumptions about how data is stored within the 2 element data union, and the g_type member should only be accessed through the G_VALUE_TYPE() macro.

Implementations

impl Value

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

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

Borrows the underlying C value.

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

Borrows the underlying C value mutably.

impl Value

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.

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.

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

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

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.

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.

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.

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_.

pub fn type_(&self) -> Type

Returns the type of the value.

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

Returns whether Values of type src can be transformed to type dst. Check whether transform() is able to transform values of type src_type into values of type dest_type. Note that for the types to be transformable, they must be compatible or a transformation function must be registered.

src_type

Source type.

dest_type

Target type.

Returns

true if the transformation is possible, false otherwise.

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

Tries to transform the value into a value of the target type Tries to cast the contents of self into a type appropriate to store in dest_value, e.g. to transform a G_TYPE_INT value into a G_TYPE_FLOAT value. Performing transformations between value types might incur precision lossage. Especially transformations into strings might reveal seemingly arbitrary results and shouldn’t be relied upon for production code (such as rcfile value or object property serialization).

dest_value

Target value.

Returns

Whether a transformation rule was found and could be applied. Upon failing transformations, dest_value is left untouched.

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

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

pub fn into_raw(self) -> GValue

Consumes Value and returns the corresponding GValue.

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

Trait Implementations

impl Clone for Value

fn clone(&self) -> Self

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

Formats the value using the given formatter.

impl Drop for Value

fn drop(&mut self)

Executes the destructor for this type.

impl<'a, T: ?Sized + ToValue> From<&'a T> for Value

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

Converts to this type from the input type.

impl From<*mut c_void> for Value

fn from(v: Pointer) -> Self

Converts to this type from the input type.

impl From<BindingFlags> for Value

fn from(v: BindingFlags) -> Self

Converts to this type from the input type.

impl From<Box<str>> for Value

fn from(s: Box<str>) -> Self

Converts to this type from the input type.

impl From<BoxedValue> for Value

fn from(v: BoxedValue) -> Self

Converts to this type from the input type.

impl From<ByteArray> for Value

fn from(s: ByteArray) -> Self

Converts to this type from the input type.

impl From<Bytes> for Value

fn from(s: Bytes) -> Self

Converts to this type from the input type.

impl From<Checksum> for Value

fn from(o: Checksum) -> Self

Converts to this type from the input type.

impl From<Closure> for Value

fn from(s: Closure) -> Self

Converts to this type from the input type.

impl From<ControlFlow> for Value

fn from(v: ControlFlow) -> Self

Converts to this type from the input type.

impl From<DateTime> for Value

fn from(s: DateTime) -> Self

Converts to this type from the input type.

impl From<Error> for Value

fn from(o: Error) -> Self

Converts to this type from the input type.

impl From<GString> for Value

fn from(s: GString) -> Self

Converts to this type from the input type.

impl From<ILong> for Value

fn from(v: ILong) -> Self

Converts to this type from the input type.

impl From<IOCondition> for Value

fn from(v: IOCondition) -> Self

Converts to this type from the input type.

impl From<KeyFile> for Value

fn from(s: KeyFile) -> Self

Converts to this type from the input type.

impl From<MainContext> for Value

fn from(s: MainContext) -> Self

Converts to this type from the input type.

impl From<MainLoop> for Value

fn from(s: MainLoop) -> Self

Converts to this type from the input type.

impl From<MarkupParseContext> for Value

fn from(s: MarkupParseContext) -> Self

Converts to this type from the input type.

impl From<NonNull<c_void>> for Value

fn from(v: NonNull<Pointee>) -> Self

Converts to this type from the input type.

impl From<NonZeroI32> for Value

fn from(v: NonZeroI32) -> Self

Converts to this type from the input type.

impl From<NonZeroI64> for Value

fn from(v: NonZeroI64) -> Self

Converts to this type from the input type.

impl From<NonZeroI8> for Value

fn from(v: NonZeroI8) -> Self

Converts to this type from the input type.

impl From<NonZeroU32> for Value

fn from(v: NonZeroU32) -> Self

Converts to this type from the input type.

impl From<NonZeroU64> for Value

fn from(v: NonZeroU64) -> Self

Converts to this type from the input type.

impl From<NonZeroU8> for Value

fn from(v: NonZeroU8) -> Self

Converts to this type from the input type.

impl<T: Into<Value> + ToValueOptional> From<Option<T>> for Value

fn from(t: Option<T>) -> Self

Converts to this type from the input type.

impl From<PathBuf> for Value

fn from(s: PathBuf) -> Self

Converts to this type from the input type.

impl From<Propagation> for Value

fn from(v: Propagation) -> Self

Converts to this type from the input type.

impl From<SendValue> for Value

fn from(value: SendValue) -> Self

Converts to this type from the input type.

impl From<Source> for Value

fn from(s: Source) -> Self

Converts to this type from the input type.

impl From<StrV> for Value

fn from(s: StrV) -> Self

Converts to this type from the input type.

impl From<String> for Value

fn from(s: String) -> Self

Converts to this type from the input type.

impl From<TimeZone> for Value

fn from(s: TimeZone) -> Self

Converts to this type from the input type.

impl From<ULong> for Value

fn from(v: ULong) -> Self

Converts to this type from the input type.

impl From<Uri> for Value

Available on crate feature v2_66 only.

fn from(s: Uri) -> Self

Converts to this type from the input type.

impl From<ValueArray> for Value

fn from(o: ValueArray) -> Self

Converts to this type from the input type.

impl From<VariantDict> for Value

fn from(s: VariantDict) -> Self

Converts to this type from the input type.

impl From<Vec<GString>> for Value

fn from(v: Vec<GString>) -> Self

Converts to this type from the input type.

impl From<Vec<String>> for Value

fn from(s: Vec<String>) -> Self

Converts to this type from the input type.

impl From<bool> for Value

fn from(v: bool) -> Self

Converts to this type from the input type.

impl From<char> for Value

fn from(v: char) -> Self

Converts to this type from the input type.

impl From<f32> for Value

fn from(v: f32) -> Self

Converts to this type from the input type.

impl From<f64> for Value

fn from(v: f64) -> Self

Converts to this type from the input type.

impl From<i32> for Value

fn from(v: i32) -> Self

Converts to this type from the input type.

impl From<i64> for Value

fn from(v: i64) -> Self

Converts to this type from the input type.

impl From<i8> for Value

fn from(v: i8) -> Self

Converts to this type from the input type.

impl From<u32> for Value

fn from(v: u32) -> Self

Converts to this type from the input type.

impl From<u64> for Value

fn from(v: u64) -> Self

Converts to this type from the input type.

impl From<u8> for Value

fn from(v: u8) -> Self

Converts to this type from the input type.

impl<'a> FromValue<'a> for &'a Value

type Checker = NopChecker

Value type checker.

unsafe fn from_value(value: &'a Value) -> Self

Get the contained value from a Value.

impl<'a> FromValue<'a> for Value

type Checker = NopChecker

Value type checker.

unsafe fn from_value(value: &'a Value) -> Self

Get the contained value from a Value.

impl<'a> ToValue for &'a Value

fn to_value(&self) -> Value

Convert a value to a Value.

fn value_type(&self) -> Type

Returns the type identifer of self.

impl ToValue for Value

fn to_value(&self) -> Value

Convert a value to a Value.

fn value_type(&self) -> Type

Returns the type identifer of self.