Trait radix_engine::types::Ord

1.0.0 · source ·
pub trait Ord: Eq + PartialOrd {
    // Required method
    fn cmp(&self, other: &Self) -> Ordering;

    // Provided methods
    fn max(self, other: Self) -> Self
       where Self: Sized { ... }
    fn min(self, other: Self) -> Self
       where Self: Sized { ... }
    fn clamp(self, min: Self, max: Self) -> Self
       where Self: Sized + PartialOrd { ... }
}
Expand description

Trait for types that form a total order.

Implementations must be consistent with the PartialOrd implementation, and ensure max, min, and clamp are consistent with cmp:

  • partial_cmp(a, b) == Some(cmp(a, b)).
  • max(a, b) == max_by(a, b, cmp) (ensured by the default implementation).
  • min(a, b) == min_by(a, b, cmp) (ensured by the default implementation).
  • For a.clamp(min, max), see the method docs (ensured by the default implementation).

It’s easy to accidentally make cmp and partial_cmp disagree by deriving some of the traits and manually implementing others.

Violating these requirements is a logic error. The behavior resulting from a logic error is not specified, but users of the trait must ensure that such logic errors do not result in undefined behavior. This means that unsafe code must not rely on the correctness of these methods.

§Corollaries

From the above and the requirements of PartialOrd, it follows that for all a, b and c:

  • exactly one of a < b, a == b or a > b is true; and
  • < is transitive: a < b and b < c implies a < c. The same must hold for both == and >.

Mathematically speaking, the < operator defines a strict weak order. In cases where == conforms to mathematical equality, it also defines a strict total order.

§Derivable

This trait can be used with #[derive].

When derived on structs, it will produce a lexicographic ordering based on the top-to-bottom declaration order of the struct’s members.

When derived on enums, variants are ordered primarily by their discriminants. Secondarily, they are ordered by their fields. By default, the discriminant is smallest for variants at the top, and largest for variants at the bottom. Here’s an example:

#[derive(PartialEq, Eq, PartialOrd, Ord)]
enum E {
    Top,
    Bottom,
}

assert!(E::Top < E::Bottom);

However, manually setting the discriminants can override this default behavior:

#[derive(PartialEq, Eq, PartialOrd, Ord)]
enum E {
    Top = 2,
    Bottom = 1,
}

assert!(E::Bottom < E::Top);

§Lexicographical comparison

Lexicographical comparison is an operation with the following properties:

  • Two sequences are compared element by element.
  • The first mismatching element defines which sequence is lexicographically less or greater than the other.
  • If one sequence is a prefix of another, the shorter sequence is lexicographically less than the other.
  • If two sequences have equivalent elements and are of the same length, then the sequences are lexicographically equal.
  • An empty sequence is lexicographically less than any non-empty sequence.
  • Two empty sequences are lexicographically equal.

§How can I implement Ord?

Ord requires that the type also be PartialOrd and Eq (which requires PartialEq).

Then you must define an implementation for cmp. You may find it useful to use cmp on your type’s fields.

Here’s an example where you want to sort people by height only, disregarding id and name:

use std::cmp::Ordering;

#[derive(Eq)]
struct Person {
    id: u32,
    name: String,
    height: u32,
}

impl Ord for Person {
    fn cmp(&self, other: &Self) -> Ordering {
        self.height.cmp(&other.height)
    }
}

impl PartialOrd for Person {
    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
        Some(self.cmp(other))
    }
}

impl PartialEq for Person {
    fn eq(&self, other: &Self) -> bool {
        self.height == other.height
    }
}

Required Methods§

source

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

This method returns an Ordering between self and other.

By convention, self.cmp(&other) returns the ordering matching the expression self <operator> other if true.

§Examples
use std::cmp::Ordering;

assert_eq!(5.cmp(&10), Ordering::Less);
assert_eq!(10.cmp(&5), Ordering::Greater);
assert_eq!(5.cmp(&5), Ordering::Equal);

Provided Methods§

1.21.0 · source

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

Compares and returns the maximum of two values.

Returns the second argument if the comparison determines them to be equal.

§Examples
assert_eq!(1.max(2), 2);
assert_eq!(2.max(2), 2);
1.21.0 · source

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

Compares and returns the minimum of two values.

Returns the first argument if the comparison determines them to be equal.

§Examples
assert_eq!(1.min(2), 1);
assert_eq!(2.min(2), 2);
1.50.0 · source

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

Returns max if self is greater than max, and min if self is less than min. Otherwise this returns self.

§Panics

Panics if min > max.

§Examples
assert_eq!((-3).clamp(-2, 1), -2);
assert_eq!(0.clamp(-2, 1), 0);
assert_eq!(2.clamp(-2, 1), 1);

Object Safety§

This trait is not object safe.

Implementors§

source§

impl Ord for DatabaseUpdate

source§

impl Ord for AccessControllerCollection

source§

impl Ord for AccessControllerField

source§

impl Ord for AccountCollection

source§

impl Ord for AccountField

source§

impl Ord for ConsensusManagerCollection

source§

impl Ord for ConsensusManagerField

source§

impl Ord for ValidatorCollection

source§

impl Ord for ValidatorField

source§

impl Ord for PackageCollection

source§

impl Ord for PackageField

source§

impl Ord for PoolV1MinorVersion

source§

impl Ord for MultiResourcePoolCollection

source§

impl Ord for MultiResourcePoolField

source§

impl Ord for OneResourcePoolCollection

source§

impl Ord for OneResourcePoolField

source§

impl Ord for TwoResourcePoolCollection

source§

impl Ord for TwoResourcePoolField

source§

impl Ord for FungibleResourceManagerCollection

source§

impl Ord for FungibleResourceManagerField

source§

impl Ord for FungibleVaultCollection

source§

impl Ord for FungibleVaultField

source§

impl Ord for NonFungibleResourceManagerCollection

source§

impl Ord for NonFungibleResourceManagerField

source§

impl Ord for NonFungibleVaultCollection

source§

impl Ord for NonFungibleVaultField

source§

impl Ord for LocalRef

source§

impl Ord for ReferenceOrigin

source§

impl Ord for StableReferenceType

source§

impl Ord for Visibility

source§

impl Ord for SubstateDevice

source§

impl Ord for MetadataCollection

source§

impl Ord for MetadataField

source§

impl Ord for RoleAssignmentCollection

source§

impl Ord for RoleAssignmentField

source§

impl Ord for ComponentRoyaltyCollection

source§

impl Ord for ComponentRoyaltyField

source§

impl Ord for RoyaltyRecipient

source§

impl Ord for radix_engine::system::system_modules::costing::fee_reserve::StorageType

source§

impl Ord for Proposer

source§

impl Ord for Role

source§

impl Ord for DefaultDepositRule

source§

impl Ord for ResourcePreference

source§

impl Ord for PartitionDescription

source§

impl Ord for AccessControllerPartitionOffset

source§

impl Ord for AccessRule

source§

impl Ord for AccessRuleNode

source§

impl Ord for AccountPartitionOffset

source§

impl Ord for AttachedModuleId

source§

impl Ord for AuthZoneField

§

impl Ord for BlueprintHook

source§

impl Ord for BootLoaderField

source§

impl Ord for ComponentField

source§

impl Ord for ComponentRoyaltyPartitionOffset

source§

impl Ord for ConsensusManagerPartitionOffset

source§

impl Ord for EntityType

source§

impl Ord for FungibleBucketField

source§

impl Ord for FungibleProofField

source§

impl Ord for FungibleResourceManagerPartitionOffset

source§

impl Ord for FungibleVaultPartitionOffset

source§

impl Ord for Level

source§

impl Ord for ManifestAddress

source§

impl Ord for MetadataPartitionOffset

source§

impl Ord for MethodAccessibility

source§

impl Ord for ModuleId

source§

impl Ord for MultiResourcePoolPartitionOffset

source§

impl Ord for NonFungibleBucketField

source§

impl Ord for NonFungibleIdType

source§

impl Ord for NonFungibleLocalId

source§

impl Ord for NonFungibleProofField

source§

impl Ord for NonFungibleResourceManagerPartitionOffset

source§

impl Ord for NonFungibleVaultPartitionOffset

source§

impl Ord for OneResourcePoolPartitionOffset

source§

impl Ord for OwnerRoleUpdater

source§

impl Ord for PackagePartitionOffset

source§

impl Ord for ProofRule

source§

impl Ord for ResourceFeature

source§

impl Ord for ResourceOrNonFungible

source§

impl Ord for RoleAssignmentPartitionOffset

source§

impl Ord for RoyaltyField

source§

impl Ord for SubstateKey

source§

impl Ord for TransactionTrackerField

source§

impl Ord for TwoResourcePoolPartitionOffset

source§

impl Ord for TypeInfoField

source§

impl Ord for ValidatorPartitionOffset

source§

impl Ord for WorktopField

source§

impl Ord for AsciiChar

1.7.0 · source§

impl Ord for IpAddr

source§

impl Ord for SocketAddr

source§

impl Ord for ErrorKind

source§

impl Ord for Sign

source§

impl Ord for Ordering

1.34.0 · source§

impl Ord for Infallible

source§

impl Ord for bool

source§

impl Ord for char

source§

impl Ord for i8

source§

impl Ord for i16

source§

impl Ord for i32

source§

impl Ord for i64

source§

impl Ord for i128

source§

impl Ord for isize

source§

impl Ord for !

source§

impl Ord for str

Implements ordering of strings.

Strings are ordered lexicographically by their byte values. This orders Unicode code points based on their positions in the code charts. This is not necessarily the same as “alphabetical” order, which varies by language and locale. Sorting strings according to culturally-accepted standards requires locale-specific data that is outside the scope of the str type.

source§

impl Ord for u8

source§

impl Ord for u16

source§

impl Ord for u32

source§

impl Ord for u64

source§

impl Ord for u128

source§

impl Ord for ()

source§

impl Ord for usize

source§

impl Ord for DbPartitionKey

source§

impl Ord for DbSortKey

source§

impl Ord for AccountAuthorizedDepositorKeyPayload

source§

impl Ord for AccountResourcePreferenceKeyPayload

source§

impl Ord for AccountResourceVaultKeyPayload

source§

impl Ord for AddAuthorizedDepositorEvent

source§

impl Ord for RemoveAuthorizedDepositorEvent

source§

impl Ord for RemoveResourcePreferenceEvent

source§

impl Ord for SetDefaultDepositRuleEvent

source§

impl Ord for SetResourcePreferenceEvent

source§

impl Ord for ConsensusManagerRegisteredValidatorByStakeKeyPayload

source§

impl Ord for Validator

source§

impl Ord for PackageBlueprintVersionAuthConfigKeyPayload

source§

impl Ord for PackageBlueprintVersionDefinitionKeyPayload

source§

impl Ord for PackageBlueprintVersionDependenciesKeyPayload

source§

impl Ord for PackageBlueprintVersionRoyaltyConfigKeyPayload

source§

impl Ord for PackageCodeInstrumentedCodeKeyPayload

source§

impl Ord for PackageCodeOriginalCodeKeyPayload

source§

impl Ord for PackageCodeVmTypeKeyPayload

source§

impl Ord for PackageSchemaKeyPayload

source§

impl Ord for NonFungibleResourceManagerDataKeyPayload

source§

impl Ord for NonFungibleVaultNonFungibleKeyPayload

source§

impl Ord for TransientReference

source§

impl Ord for MetadataEntryKeyPayload

source§

impl Ord for RoleAssignmentAccessRuleKeyPayload

source§

impl Ord for ComponentRoyaltyMethodAmountKeyPayload

source§

impl Ord for EnabledModules

source§

impl Ord for BlueprintVersion

source§

impl Ord for BlueprintVersionKey

source§

impl Ord for CanonicalBlueprintId

source§

impl Ord for CodeHash

1.64.0 · source§

impl Ord for CString

source§

impl Ord for TypeId

1.27.0 · source§

impl Ord for CpuidResult

source§

impl Ord for CStr

source§

impl Ord for Ipv4Addr

source§

impl Ord for Ipv6Addr

source§

impl Ord for SocketAddrV4

source§

impl Ord for SocketAddrV6

1.3.0 · source§

impl Ord for Duration

source§

impl Ord for OsStr

source§

impl Ord for OsString

source§

impl Ord for Components<'_>

source§

impl Ord for Path

source§

impl Ord for PathBuf

source§

impl Ord for PrefixComponent<'_>

1.8.0 · source§

impl Ord for Instant

1.8.0 · source§

impl Ord for SystemTime

source§

impl Ord for BigInt

source§

impl Ord for BigUint

source§

impl Ord for Ident

source§

impl Ord for BuildMetadata

source§

impl Ord for Prerelease

source§

impl Ord for Version

source§

impl Ord for Lifetime

source§

impl Ord for ATerm

source§

impl Ord for B0

source§

impl Ord for B1

source§

impl Ord for Z0

source§

impl Ord for Equal

source§

impl Ord for Greater

source§

impl Ord for Less

source§

impl Ord for UTerm

source§

impl Ord for Braced

source§

impl Ord for Hyphenated

source§

impl Ord for Simple

source§

impl Ord for Urn

source§

impl Ord for Uuid

source§

impl Ord for radix_engine::types::radix_engine_common::prelude::fmt::Error

1.33.0 · source§

impl Ord for PhantomPinned

1.34.0 · source§

impl Ord for NonZero<i8>

1.34.0 · source§

impl Ord for NonZero<i16>

1.34.0 · source§

impl Ord for NonZero<i32>

1.34.0 · source§

impl Ord for NonZero<i64>

1.34.0 · source§

impl Ord for NonZero<i128>

1.34.0 · source§

impl Ord for NonZero<isize>

1.28.0 · source§

impl Ord for NonZero<u8>

1.28.0 · source§

impl Ord for NonZero<u16>

1.28.0 · source§

impl Ord for NonZero<u32>

1.28.0 · source§

impl Ord for NonZero<u64>

1.28.0 · source§

impl Ord for NonZero<u128>

1.28.0 · source§

impl Ord for NonZero<usize>

const: unstable · source§

impl Ord for Alignment

source§

impl Ord for Bls12381G1PublicKey

source§

impl Ord for Bls12381G2Signature

source§

impl Ord for BlueprintId

source§

impl Ord for BytesNonFungibleLocalId

source§

impl Ord for ComponentAddress

source§

impl Ord for Decimal

source§

impl Ord for Ed25519PublicKey

source§

impl Ord for Epoch

source§

impl Ord for EventFlags

source§

impl Ord for FieldValue

source§

impl Ord for GlobalAddress

source§

impl Ord for Hash

source§

impl Ord for I192

source§

impl Ord for I256

source§

impl Ord for I320

source§

impl Ord for I384

source§

impl Ord for I448

source§

impl Ord for I512

source§

impl Ord for I768

source§

impl Ord for IntegerNonFungibleLocalId

source§

impl Ord for InternalAddress

source§

impl Ord for LockFlags

source§

impl Ord for ManifestProof

source§

impl Ord for MethodKey

source§

impl Ord for ModuleRoleKey

source§

impl Ord for NodeId

source§

impl Ord for NonFungibleGlobalId

source§

impl Ord for OwnerRoleEntry

source§

impl Ord for PackageAddress

source§

impl Ord for PartitionNumber

source§

impl Ord for PartitionOffset

source§

impl Ord for PreciseDecimal

source§

impl Ord for RUIDNonFungibleLocalId

§

impl Ord for RefTypes

source§

impl Ord for Reference

source§

impl Ord for ResourceAddress

source§

impl Ord for RoleKey

source§

impl Ord for RoleList

source§

impl Ord for SchemaHash

source§

impl Ord for Secp256k1PublicKey

source§

impl Ord for String

source§

impl Ord for StringNonFungibleLocalId

source§

impl Ord for U192

source§

impl Ord for U256

source§

impl Ord for U320

source§

impl Ord for U384

source§

impl Ord for U448

source§

impl Ord for U512

source§

impl Ord for U768

source§

impl Ord for VaultFreezeFlags

§

impl Ord for All

§

impl Ord for BigEndian

§

impl Ord for ClassBytesRange

§

impl Ord for ClassUnicodeRange

§

impl Ord for ComponentSectionId

§

impl Ord for CurveType

§

impl Ord for CustomSectionKind

§

impl Ord for Error

§

impl Ord for Error

§

impl Ord for FlashTransactionHash

§

impl Ord for FuncType

§

impl Ord for HeapType

§

impl Ord for IntentHash

§

impl Ord for InvalidParityValue

§

impl Ord for KeyPair

§

impl Ord for KeyPair

§

impl Ord for Literal

§

impl Ord for LittleEndian

§

impl Ord for Message

§

impl Ord for NonMaxUsize

§

impl Ord for NotarizedTransactionHash

§

impl Ord for Null

§

impl Ord for Pages

§

impl Ord for Parity

§

impl Ord for PatternID

§

impl Ord for Position

§

impl Ord for PublicKey

§

impl Ord for PublicKey

§

impl Ord for PublicKeyFingerprint

§

impl Ord for RawFlashTransaction

§

impl Ord for RawIntent

§

impl Ord for RawNotarizedTransaction

§

impl Ord for RawSignedIntent

§

impl Ord for RawSystemTransaction

§

impl Ord for RecoverableSignature

§

impl Ord for RefType

§

impl Ord for ResourceId

§

impl Ord for Scalar

§

impl Ord for SecretKey

§

impl Ord for SectionId

§

impl Ord for SharedSecret

§

impl Ord for SignOnly

§

impl Ord for Signature

§

impl Ord for Signature

§

impl Ord for SignedIntentHash

§

impl Ord for SmallIndex

§

impl Ord for Span

§

impl Ord for StateID

§

impl Ord for StorageType

§

impl Ord for SystemTransactionHash

§

impl Ord for Unit

§

impl Ord for UntypedValue

§

impl Ord for Utf8Range

§

impl Ord for Utf8Sequence

§

impl Ord for ValType

§

impl Ord for ValueType

§

impl Ord for Variant

§

impl Ord for VerifyOnly

§

impl Ord for XOnlyPublicKey

§

impl Ord for XOnlyPublicKey

§

impl Ord for u5

source§

impl<'a> Ord for Component<'a>

source§

impl<'a> Ord for Prefix<'a>

1.10.0 · source§

impl<'a> Ord for Location<'a>

§

impl<'a> Ord for SectionCode<'a>

§

impl<'buf> Ord for AllPreallocated<'buf>

§

impl<'buf> Ord for SignOnlyPreallocated<'buf>

§

impl<'buf> Ord for VerifyOnlyPreallocated<'buf>

source§

impl<A> Ord for &A
where A: Ord + ?Sized,

source§

impl<A> Ord for &mut A
where A: Ord + ?Sized,

§

impl<A> Ord for SmallVec<A>
where A: Array, <A as Array>::Item: Ord,

source§

impl<B> Ord for Cow<'_, B>
where B: Ord + ToOwned + ?Sized,

source§

impl<Dyn> Ord for DynMetadata<Dyn>
where Dyn: ?Sized,

1.4.0 · source§

impl<F> Ord for F
where F: FnPtr,

§

impl<H, T> Ord for HeaderSlice<H, T>
where H: Ord, T: Ord + ?Sized,

§

impl<H, T> Ord for HeaderSlice<HeaderWithLength<H>, T>
where H: Ord, T: Ord + ?Sized,

§

impl<H, T> Ord for ThinArc<H, T>
where H: Ord, T: Ord,

source§

impl<K, V> Ord for radix_engine::types::radix_engine_common::prelude::indexmap::map::Slice<K, V>
where K: Ord, V: Ord,

§

impl<K, V> Ord for IndexMap<K, V>
where K: Ord, V: Ord,

source§

impl<K, V, A> Ord for BTreeMap<K, V, A>
where K: Ord, V: Ord, A: Allocator + Clone,

1.41.0 · source§

impl<Ptr> Ord for Pin<Ptr>
where Ptr: Deref, <Ptr as Deref>::Target: Ord,

source§

impl<T> Ord for Option<T>
where T: Ord,

1.36.0 · source§

impl<T> Ord for Poll<T>
where T: Ord,

source§

impl<T> Ord for *const T
where T: ?Sized,

source§

impl<T> Ord for *mut T
where T: ?Sized,

source§

impl<T> Ord for [T]
where T: Ord,

Implements comparison of vectors lexicographically.

source§

impl<T> Ord for (T₁, T₂, …, Tₙ)
where T: Ord + ?Sized,

This trait is implemented for tuples up to twelve items long.

source§

impl<T> Ord for radix_engine::types::radix_engine_common::prelude::indexmap::set::Slice<T>
where T: Ord,

1.19.0 · source§

impl<T> Ord for Reverse<T>
where T: Ord,

1.20.0 · source§

impl<T> Ord for ManuallyDrop<T>
where T: Ord + ?Sized,

1.74.0 · source§

impl<T> Ord for Saturating<T>
where T: Ord,

source§

impl<T> Ord for Wrapping<T>
where T: Ord,

1.25.0 · source§

impl<T> Ord for NonNull<T>
where T: ?Sized,

source§

impl<T> Ord for BurnRoles<T>
where T: Ord,

1.10.0 · source§

impl<T> Ord for Cell<T>
where T: Ord + Copy,

source§

impl<T> Ord for DepositRoles<T>
where T: Ord,

source§

impl<T> Ord for FreezeRoles<T>
where T: Ord,

source§

impl<T> Ord for MintRoles<T>
where T: Ord,

source§

impl<T> Ord for NonFungibleDataUpdateRoles<T>
where T: Ord,

source§

impl<T> Ord for PhantomData<T>
where T: ?Sized,

source§

impl<T> Ord for RecallRoles<T>
where T: Ord,

1.10.0 · source§

impl<T> Ord for RefCell<T>
where T: Ord + ?Sized,

source§

impl<T> Ord for WithdrawRoles<T>
where T: Ord,

§

impl<T> Ord for Arc<T>
where T: Ord + ?Sized,

§

impl<T> Ord for IndexSet<T>
where T: Ord,

§

impl<T> Ord for Shared<'_, T>
where T: Pointable + ?Sized,

source§

impl<T, A> Ord for Vec<T, A>
where T: Ord, A: Allocator,

Implements ordering of vectors, lexicographically.

source§

impl<T, A> Ord for radix_engine::types::radix_engine_common::prelude::rust::sync::Arc<T, A>
where T: Ord + ?Sized, A: Allocator,

source§

impl<T, A> Ord for BTreeSet<T, A>
where T: Ord, A: Allocator + Clone,

source§

impl<T, A> Ord for Box<T, A>
where T: Ord + ?Sized, A: Allocator,

source§

impl<T, A> Ord for LinkedList<T, A>
where T: Ord, A: Allocator,

source§

impl<T, A> Ord for Rc<T, A>
where T: Ord + ?Sized, A: Allocator,

source§

impl<T, A> Ord for VecDeque<T, A>
where T: Ord, A: Allocator,

source§

impl<T, E> Ord for Result<T, E>
where T: Ord, E: Ord,

§

impl<T, N> Ord for GenericArray<T, N>
where T: Ord, N: ArrayLength<T>,

source§

impl<T, const N: usize> Ord for [T; N]
where T: Ord,

Implements comparison of arrays lexicographically.

source§

impl<T, const N: usize> Ord for Simd<T, N>

§

impl<T, const N: usize> Ord for TagNonNull<T, N>

§

impl<T, const N: usize> Ord for TagPtr<T, N>

source§

impl<U> Ord for NInt<U>
where U: Ord + Unsigned + NonZero,

source§

impl<U> Ord for PInt<U>
where U: Ord + Unsigned + NonZero,

source§

impl<U, B> Ord for UInt<U, B>
where U: Ord, B: Ord,

source§

impl<V, A> Ord for TArr<V, A>
where V: Ord, A: Ord,

source§

impl<Y, R> Ord for CoroutineState<Y, R>
where Y: Ord, R: Ord,

§

impl<const N: usize> Ord for BInt<N>

§

impl<const N: usize> Ord for BIntD8<N>

§

impl<const N: usize> Ord for BIntD16<N>

§

impl<const N: usize> Ord for BIntD32<N>

§

impl<const N: usize> Ord for BUint<N>

§

impl<const N: usize> Ord for BUintD8<N>

§

impl<const N: usize> Ord for BUintD16<N>

§

impl<const N: usize> Ord for BUintD32<N>