Struct RuleId 

pub struct RuleId(/* private fields */);

Internal rule ID used as an index into LicenseIndex::rules_by_rid.

Every rule in the license index is assigned a RuleId sequentially during index construction. The ID is used for fast Vec lookups and as a key in HashMap/HashSet structures on LicenseIndex.

Sentinel value

RuleId::NONE (usize::MAX) represents an absent or invalid rule ID. It is used where production code previously relied on rid: 0 as a sentinel, which was unsafe because 0 is a valid index pointing to a real rule. Use is_valid() to check whether a RuleId refers to a real rule.

Implementations

impl RuleId

pub const NONE: Self

Sentinel value representing an absent or invalid rule ID.

usize::MAX can never be a valid Vec index, so this is guaranteed not to alias any real rule.

pub const fn new(raw: usize) -> Self

Creates a RuleId from a raw usize index.

Panics

Panics if raw is usize::MAX (the sentinel value). Use RuleId::NONE to construct the sentinel.

pub const fn raw(self) -> usize

Returns the raw usize index.

Prefer using RuleId directly for indexing and lookups rather than extracting the raw value.

pub const fn is_valid(self) -> bool

Returns true if this RuleId refers to a real rule (not the sentinel).

pub const fn is_none(self) -> bool

Returns true if this is the RuleId::NONE sentinel.

Trait Implementations

impl Archive for RuleId

where usize: Archive,

const COPY_OPTIMIZATION: CopyOptimization<Self>

An optimization flag that allows the bytes of this type to be copied directly to a writer instead of calling serialize.

type Archived = ArchivedRuleId

The archived representation of this type.

type Resolver = RuleIdResolver

The resolver for this type. It must contain all the additional information from serializing needed to make the archived type from the normal type.

fn resolve(&self, resolver: Self::Resolver, out: Place<Self::Archived>)

Creates the archived version of this value at the given position and writes it to the given output.

impl Clone for RuleId

fn clone(&self) -> RuleId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RuleId

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

Formats the value using the given formatter.

impl<__D: Fallible + ?Sized> Deserialize<RuleId, __D> for Archived<RuleId>

where usize: Archive, <usize as Archive>::Archived: Deserialize<usize, __D>,

fn deserialize( &self, deserializer: &mut __D, ) -> Result<RuleId, <__D as Fallible>::Error>

Deserializes using the given deserializer

impl Display for RuleId

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

Formats the value using the given formatter.

impl From<RuleId> for usize

fn from(value: RuleId) -> Self

Converts to this type from the input type.

impl Hash for RuleId

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 RuleId

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

fn eq(&self, other: &RuleId) -> 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 RuleId

fn partial_cmp(&self, other: &RuleId) -> 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<__S: Fallible + ?Sized> Serialize<__S> for RuleId

where usize: Serialize<__S>,

fn serialize( &self, serializer: &mut __S, ) -> Result<<Self as Archive>::Resolver, <__S as Fallible>::Error>

Writes the dependencies for the object and returns a resolver that can create the archived type.

impl Copy for RuleId

impl Eq for RuleId

impl StructuralPartialEq for RuleId