Enum Ordering

#[non_exhaustive]
pub enum Ordering {
    Smaller,
    Equal,
    Larger,
}

Describes the way two values can be compared.

These values can be used with a callback::GLib::CompareFunc. However, a GCompareFunc is allowed to return any integer values. For converting such a value to a [Ordering][crate::Ordering] value, use Gtk::Ordering::from_cmpfunc()`.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Smaller

the first value is smaller than the second

Equal

the two values are equal

Larger

the first value is larger than the second

Trait Implementations

impl Clone for Ordering

fn clone(&self) -> Ordering

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Ordering

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

Formats the value using the given formatter.

impl From<Ordering> for Ordering

fn from(o: Ordering) -> Self

Converts to this type from the input type.

impl From<Ordering> for Ordering

fn from(o: Ordering) -> Self

Converts to this type from the input type.

impl From<Ordering> for Value

fn from(v: Ordering) -> Self

Converts to this type from the input type.

impl<'a> FromValue<'a> for Ordering

type Checker = GenericValueTypeChecker<Ordering>

Value type checker.

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

Get the contained value from a Value.

impl HasParamSpec for Ordering

type ParamSpec = ParamSpecEnum

type SetValue = Ordering

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str, _: Ordering) -> ParamSpecEnumBuilder<'_, Ordering>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Ordering

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Ordering

fn cmp(&self, other: &Ordering) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Ordering

fn eq(&self, other: &Ordering) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Ordering

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl StaticType for Ordering

fn static_type() -> Type

Returns the type identifier of Self.

impl ToValue for Ordering

fn to_value(&self) -> Value

Convert a value to a Value.

fn value_type(&self) -> Type

Returns the type identifier of self.

impl ValueType for Ordering

type Type = Ordering

Type to get the Type from.

impl Copy for Ordering

impl Eq for Ordering

impl StructuralPartialEq for Ordering