Struct SegmentId 

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

Stable identity of a segment. Cheap to copy; survives rebuilds, locale changes, and segments being inserted around it.

Implementations

impl SegmentId

pub fn fresh() -> Self

Allocate a new, never-before-seen id. Backed by a monotonic global counter — overflow is theoretically possible after 2^64 calls, at which point the universe has had bigger problems.

Segment::new calls this for you, so a control that never persists its selection needs no explicit ids.

Allocations start at 2^48, so they can never collide with a small constant an app declared through from_u64.

pub const fn from_raw(value: NonZeroU64) -> Self

Wrap an externally-allocated key. Use this when the segment’s identity comes from an app-side store (a view-mode enum discriminant, a plugin key hash, …) — calling SegmentId::fresh would allocate a new id every restart, breaking a persisted selection.

pub const fn from_u64(value: u64) -> Self

const convenience over from_raw, so an app can declare its segments as constants:

const SYNOPSIS: SegmentId = SegmentId::from_u64(1);
const CHAPTER: SegmentId = SegmentId::from_u64(2);

Panics

If value is zero. Because this is a const fn, a literal zero is caught at compile time rather than at run time.

pub const fn raw(self) -> NonZeroU64

The underlying non-zero u64. Serialize this to persist a selection across sessions; restore via from_raw or from_u64.

pub const fn get(self) -> u64

The underlying value as a plain u64.

Trait Implementations

impl Clone for SegmentId

fn clone(&self) -> SegmentId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SegmentId

impl Debug for SegmentId

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

Formats the value using the given formatter.

impl Display for SegmentId

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

Formats the value using the given formatter.

impl Eq for SegmentId

impl Hash for SegmentId

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 SegmentId

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

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

fn partial_cmp(&self, other: &SegmentId) -> 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 StructuralPartialEq for SegmentId