Enum abi_stable::std_types::RCmpOrdering

#[repr(u8)]
pub enum RCmpOrdering {
    Less = 0,
    Equal = 1,
    Greater = 2,
}

Ffi-safe equivalent of std::cmp::Ordering.

Example

This defines an extern function, which compares a slice to another.

use abi_stable::{
    sabi_extern_fn,
    std_types::{RCmpOrdering, RSlice},
};
use std::cmp::Ord;

#[sabi_extern_fn]
pub fn compare_slices<T>(l: RSlice<'_, T>, r: RSlice<'_, T>) -> RCmpOrdering
where
    T: Ord,
{
    l.cmp(&r).into()
}

Variants

Less = 0

Equal = 1

Greater = 2

Implementations

impl RCmpOrdering

pub const fn to_ordering(self) -> Ordering

Converts this RCmpOrdering into a std::cmp::Ordering;

Example

use abi_stable::std_types::RCmpOrdering;
use std::cmp::Ordering;

assert_eq!(RCmpOrdering::Less.to_ordering(), Ordering::Less);
assert_eq!(RCmpOrdering::Equal.to_ordering(), Ordering::Equal);
assert_eq!(RCmpOrdering::Greater.to_ordering(), Ordering::Greater);

pub const fn from_ordering(ordering: Ordering) -> RCmpOrdering

Converts a std::cmp::Ordering to RCmpOrdering;

Example

use abi_stable::std_types::RCmpOrdering;
use std::cmp::Ordering;

assert_eq!(RCmpOrdering::from_ordering(Ordering::Less), RCmpOrdering::Less);
assert_eq!(RCmpOrdering::from_ordering(Ordering::Equal), RCmpOrdering::Equal);
assert_eq!(RCmpOrdering::from_ordering(Ordering::Greater), RCmpOrdering::Greater);

Trait Implementations

impl Clone for RCmpOrdering

fn clone(&self) -> RCmpOrdering

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RCmpOrdering

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RCmpOrdering

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Ordering> for RCmpOrdering

fn from(this: Ordering) -> RCmpOrdering

Converts to this type from the input type.

impl From<RCmpOrdering> for Ordering

fn from(this: RCmpOrdering) -> Ordering

Converts to this type from the input type.

impl GetStaticEquivalent_ for RCmpOrdering

type StaticEquivalent = _static_RCmpOrdering

The 'static equivalent of Self

impl Hash for RCmpOrdering

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 IntoReprRust for RCmpOrdering

type ReprRust = Ordering

The #[repr(Rust)] equivalent.

fn into_rust(self) -> Self::ReprRust

Performs the conversion

impl Ord for RCmpOrdering

fn cmp(&self, other: &RCmpOrdering) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for RCmpOrdering

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for RCmpOrdering

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for RCmpOrdering

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StableAbi for RCmpOrdering

type IsNonZeroType = False

Whether this type has a single invalid bit-pattern.

const LAYOUT: &'static TypeLayout = _

The layout of the type provided by implementors.

const ABI_CONSTS: AbiConsts = _

const-equivalents of the associated types.

impl Copy for RCmpOrdering

impl Eq for RCmpOrdering

impl StructuralEq for RCmpOrdering

impl StructuralPartialEq for RCmpOrdering